github
harmonize permissions required for circleci migrator
Code of Conduct
- [X] I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/migrating-to-github-actions/automated-migrations/migrating-from-circleci-with-github-actions-importer#configuring-credentials
What part(s) of the article would you like to see updated?
Create a GitHub personal access token (classic). For more information, see "Managing your personal access tokens."
Your token must have the
workflowscope.After creating the token, copy it and save it in a safe location for later use.
https://docs.github.com/en/actions/migrating-to-github-actions/automated-migrations/migrating-from-circleci-with-github-actions-importer#using-environment-variables
GitHub Actions Importer uses the following environment variables to connect to your CircleCI instance:
GITHUB_ACCESS_TOKEN: The personal access token (classic) used to create pull requests with a converted workflow (requires
repoandworkflowscopes).
Additional information
It's possible these sections aren't talking about the same thing, but that feels unlikely, and as I've tripped on an error that seems related, it feels like a bug.
@jsoref Thanks for opening an issue! I'll get this triaged for review ✨
Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert :eyes:
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
@jsoref Thank you for your patience while our SME team reviewed! They wanted to relay the following -
We need both perms, thank you for helping clean up our docs!
We need both perms for the following reasons:
- Workflow Permission: Required to create and update GitHub Actions workflows using GitHub Actions Integration (GAI).
- Repo Permission: Necessary to open a pull request against the repository that includes the new workflow created with GAI.
I've added the help wanted label so that you, or anyone else, can raise a PR to update the doc to state both permissions are needed 💛