github/docs

"Quickstart for Actions Runner Controller" recommends using a legacy user PAT for setting up ARC, which is poor practice

Open

#37,288 opened on Apr 3, 2025

View on GitHub
 (14 comments) (1 reaction) (0 assignees)TypeScript (19,479 stars) (67,056 forks)batch import
SME reviewedcontentgithub_actionshelp wanted

Description

Code of Conduct

What article on docs.github.com is affected?

https://github.com/github/docs/blob/main/content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md

What part(s) of the article would you like to see updated?

Reading the helm values for the gha-runner-scale-set chart, the helm chart supports authenticating via github app, which is a more secure and production grade method of configuring ARC than using a user's personal access token.

The docs should be updated to nudge people towards the more proper way of doing things.

Additional information

I know github is trying to phase out classic PATs so it was unexpected to see official docs instructing to use a PAT, especially when other methods are supported.

Contributor guide

Tech stack
github actionskubernetes
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Knowledge of GitHub ActionsUnderstanding of GitHub App vs PATBasic Markdown editing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the linked article file (content/actions/hosting your own runners/managing self hosted runners with actions runner controller/deploying runner scale sets with actions runner controller.md) and the 13 comments to identify sections recommending PAT usage. Propose changes to prefer GitHub App authentication, referencing the helm chart values that support it. Ensure alignment with GitHub's deprecation policy for classic PATs.