Skip to content

docs: add specific permissions required for GitHub PATs#5677

Merged
jamengual merged 2 commits intorunatlantis:mainfrom
ryanbarry:patch-1
Jul 30, 2025
Merged

docs: add specific permissions required for GitHub PATs#5677
jamengual merged 2 commits intorunatlantis:mainfrom
ryanbarry:patch-1

Conversation

@ryanbarry
Copy link
Contributor

what

This PR adds detail for creating tightly-scoped Personal Access Tokens when integrating with GitHub.

why

In order to save others the toil of trial and error.

tests

I noted which requests failed in the logs and worked through each with the official PAT permissions doc as a reference, until all requests succeeded (from opening a PR, getting the statuses, the plan comment, commenting back atlantis help to closing the PR and seeing the final "locks deleted" comment)

references

https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28

this PR adds detail for creating tightly-scoped Personal Access Tokens when integrating with GitHub. I worked these out by trial and error, noting which requests failed in the logs and working through each with this doc as a reference: https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28

Signed-off-by: Ryan Barry <ryan@nuclearice.com>
@github-actions github-actions bot added the docs Documentation label Jul 15, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jul 30, 2025
@jamengual
Copy link
Contributor

Thanks @ryanbarry for the contribution

@jamengual jamengual enabled auto-merge (squash) July 30, 2025 22:03
@jamengual jamengual merged commit aca08b9 into runatlantis:main Jul 30, 2025
35 checks passed
mowirth pushed a commit to mowirth/atlantis that referenced this pull request Jul 31, 2025
…5677)

Signed-off-by: Ryan Barry <ryan@nuclearice.com>
Co-authored-by: PePe Amengual <2208324+jamengual@users.noreply.github.com>
Signed-off-by: Moritz Wirth <mw@flanga.io>
mowirth pushed a commit to mowirth/atlantis that referenced this pull request Jul 31, 2025
…5677)

Signed-off-by: Ryan Barry <ryan@nuclearice.com>
Co-authored-by: PePe Amengual <2208324+jamengual@users.noreply.github.com>
Signed-off-by: Moritz Wirth <mw@flanga.io>
ramonvermeulen pushed a commit to bschaatsbergen/atlantis that referenced this pull request Oct 13, 2025
…5677)

Signed-off-by: Ryan Barry <ryan@nuclearice.com>
Co-authored-by: PePe Amengual <2208324+jamengual@users.noreply.github.com>
Signed-off-by: Ramon Vermeulen <ramonvermeulen98@gmail.com>
dimisjim pushed a commit to dimisjim/atlantis that referenced this pull request Oct 29, 2025
…5677)

Signed-off-by: Ryan Barry <ryan@nuclearice.com>
Co-authored-by: PePe Amengual <2208324+jamengual@users.noreply.github.com>
Signed-off-by: dimisjim <dimitris.moraitidis@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants