Merge pull request #101 from runatlantis/readme-update

Document Atlantis user requirements.
This commit is contained in:
Luke Kysow
2018-03-30 13:38:05 -07:00
committed by GitHub
2 changed files with 4 additions and 0 deletions

View File

@@ -356,6 +356,10 @@ If you're using GitLab, navigate to your project's home page in GitLab
### Create a GitHub Token
We recommend creating a new user in GitHub named **atlantis** that performs all API actions, however you can use any user.
**NOTE: The Atlantis user must 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:**
![Atlantis status](./docs/status.png)
Once you've created the user (or have decided to use an existing user) you need to create a personal access token.
- follow [https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token)
- copy the access token

BIN
docs/status.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB