Skip to content

Commit 9b5b124

Browse files
ryanbarryjamengual
authored andcommitted
docs: add specific permissions required for GitHub PATs (runatlantis#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>
1 parent 4f3c550 commit 9b5b124

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

runatlantis.io/docs/access-credentials.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ generate an access token. Read on for the instructions for your specific Git hos
3131

3232
* Create a [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-fine-grained-personal-access-token)
3333
* Create the token with **repo** scope
34+
* The following repository permissions are the minimum required:
35+
* Commit statuses: read and write (to update the PR with indicators of plan/apply/policy job states)
36+
* Contents: read only (to fetch the files changed and clone the repository)
37+
* Metadata: read only (this will be automatically selected as mandatory when Contents is set to read-only)
38+
* Pull requests: read and write (to comment and react on the PR)
3439
* Record the access token
3540
::: warning
3641
Your Atlantis user must also have "Write permissions" (for repos in an organization) or be a "Collaborator" (for repos in a user account) to be able to set commit statuses:

0 commit comments

Comments
 (0)