-
Notifications
You must be signed in to change notification settings - Fork 60.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add details about required scopes for Self-Hosted Runner #15977
Conversation
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
|
@martindevnow |
Thank you! I have updated the PR comments to reflect this change being proposed. |
@martindevnow |
content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md
Outdated
Show resolved
Hide resolved
…-hosted-runners.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for this addition, @martindevnow!
Yep, you are right, we should have the org requirement here too. I made a slight change to link to the scopes explanation instead of an API operation.
We're currently in the middle of a deployment freeze at the moment, but I will mark this as ready to merge when the freeze is lifted.
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
When building our self-hosted runners, we encountered the requirement of the
admin:org
scope rather late in our development process. If we had seen this sooner, it would have raised concerns from our security team at a time that would have given us opportunity to discuss implications and work arounds.What's being changed:
The high level documentation that outlines which scopes are required is presented up front without needing to dig through the REST API documentation to understand what scopes need to be applied to the Personal Access Token that registers the self-hosted runners.
Check off the following:
Writer impact (This section is for GitHub staff members only):