Skip to content
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

Merged
merged 4 commits into from
Mar 30, 2022

Conversation

martindevnow
Copy link
Contributor

@martindevnow martindevnow commented Mar 2, 2022

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:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@welcome
Copy link

welcome bot commented Mar 2, 2022

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 2, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Mar 2, 2022

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 that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You 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.

Source Preview Production What Changed
content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md Modified Original

@ramyaparimi
Copy link
Contributor

@martindevnow
Thanks for opening a PR 👍 Please fill out "why" and "what's being changed" in the pull request template in the top comment in this pull request, so I can get this up for review!

@martindevnow
Copy link
Contributor Author

@martindevnow Thanks for opening a PR 👍 Please fill out "why" and "what's being changed" in the pull request template in the top comment in this pull request, so I can get this up for review!

Thank you! I have updated the PR comments to reflect this change being proposed.

@ramyaparimi
Copy link
Contributor

@martindevnow
Thanks so much for filling out the PR template! I'll get this triaged for review ⚡

@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review actions This issue or pull request should be reviewed by the docs actions team and removed triage Do not begin working on this issue until triaged by the team labels Mar 3, 2022
@ramyaparimi ramyaparimi added the needs SME This proposal needs review from a subject matter expert label Mar 25, 2022
Copy link
Contributor

@lucascosti lucascosti left a 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.

@lucascosti lucascosti added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Mar 28, 2022
@ramyaparimi ramyaparimi enabled auto-merge March 30, 2022 14:57
@ramyaparimi ramyaparimi merged commit fdfbc38 into github:main Mar 30, 2022
@github-actions
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team ready to merge This pull request is ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants