Update ARC quickstart authentication guidance#44450
Open
suzunn wants to merge 3 commits into
Open
Conversation
Contributor
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
github-actions
Bot
added
the
triage
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the ARC “Get started” documentation to better guide users toward the appropriate authentication method (GitHub App vs PAT) and clarifies that the walkthrough uses a PAT for brevity.
Changes:
- Replaces PAT-only guidance with method selection guidance (GitHub App recommended for repo/org; PAT required for enterprise).
- Adds a note explaining the example uses a PAT to keep setup short and recommends GitHub App for production when possible.
| For additional Helm configuration options, see [`values.yaml`](https://github.com/actions/actions-runner-controller/blob/master/charts/gha-runner-scale-set-controller/values.yaml) in the ARC documentation. | ||
|
|
||
| 1. To enable ARC to authenticate to {% data variables.product.company_short %}, generate a {% data variables.product.pat_v1 %}. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api#deploying-using-personal-access-token-classic-authentication). | ||
| 1. To enable ARC to authenticate to {% data variables.product.company_short %}, choose an authentication method for your runner scale set. If you are registering runners at the repository or organization level, we recommend authenticating with a {% data variables.product.prodname_github_app %}. Enterprise-level runners require {% data variables.product.pat_v1 %} authentication. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api). |
| * Update the `INSTALLATION_NAME` value carefully. You will use the installation name as the value of `runs-on` in your workflows. For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idruns-on). | ||
| * Update the `NAMESPACE` value to the location you want the runner pods to be created. | ||
| * Set `GITHUB_CONFIG_URL` to the URL of your repository, organization, or enterprise. This is the entity that the runners will belong to. | ||
| * This example uses a {% data variables.product.pat_generic %} to keep the initial setup short. For repository or organization runner scale sets, use a {% data variables.product.prodname_github_app %} in production environments when possible. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Updates the ARC quickstart to recommend GitHub App authentication for runner scale sets registered at the repository or organization level, while keeping the short setup example based on a classic PAT.
Also clarifies that runner scale sets registered at the enterprise level require classic PAT authentication, and aligns the
GITHUB_PATsetup bullets with that token type.Why
This addresses #37288 by nudging readers toward the more production-ready GitHub App authentication path where it is supported, while avoiding ambiguity for enterprise-level runner scale sets.
Testing
npm run lint-content -- --paths content/actions/tutorials/use-actions-runner-controller/get-started.mdnpm run lint-content -- --precommit --paths C:/_Dev/Code/open-sources/docs/content/actions/tutorials/use-actions-runner-controller/get-started.mdCloses #37288
AI-assisted-by: Codex