docs icon indicating copy to clipboard operation
docs copied to clipboard

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

Open paul-civitas opened this issue 8 months ago • 8 comments

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.

paul-civitas avatar Apr 03 '25 21:04 paul-civitas

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Apr 03 '25 21:04 welcome[bot]

Thanks so much for opening an issue! I'll get this triaged for review.

Sharra-writes avatar Apr 03 '25 22:04 Sharra-writes

/assign

brambhattabhishek avatar Apr 04 '25 20:04 brambhattabhishek

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Apr 08 '25 20:04 github-actions[bot]

@paul-civitas Looking into this, it appears there is room to make this documentation better. If you or anyone else want to open a PR to improve it, we would appreciate the help. 💛

Sharra-writes avatar Apr 09 '25 20:04 Sharra-writes

No @

sylwek78 avatar Apr 28 '25 23:04 sylwek78

roygo

Increderoy avatar May 05 '25 18:05 Increderoy

No @sylwek78

Increderoy avatar May 07 '25 15:05 Increderoy

.

emrkonya avatar Aug 04 '25 18:08 emrkonya

Hi @Sharra-writes i want to contribute in this issue if it opens please let me know !! thanks

ayushmank avatar Nov 21 '25 08:11 ayushmank

@ayushmank If you want to update the wording, please feel free to open a PR. I'll run it by the ARC team and possibly our writers, depending on how substantial the changes are.

Sharra-writes avatar Nov 22 '25 05:11 Sharra-writes