github/docs

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

Open

#37 288 ouverte le 3 avr. 2025

Voir sur GitHub
 (12 commentaires) (1 réaction) (0 assignés)TypeScript (67 056 forks)batch import
SME reviewedcontentgithub_actionshelp wanted

Métriques du dépôt

Stars
 (19 479 stars)
Métriques de merge PR
 (Merge moyen 3j 19h) (90 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez le fichier d'article lié (content/actions/hosting your own runners/managing self hosted runners with actions runner controller/deploying runner scale sets with actions runner controller.md) et les 13 commentaires pour identifier les sections recommandant l'utilisation de PAT. Proposez des modifications pour privilégier l'authentification GitHub App, en référençant les valeurs du chart Helm qui la prennent en charge. Assurez vous de l'alignement avec la politique de dépréciation de GitHub concernant les PAT classiques.
Stack technique
github actionskubernetes
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Knowledge of GitHub ActionsUnderstanding of GitHub App vs PATBasic Markdown editing
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85