Developer
GitHub
Read and manage GitHub issues and pull requests from Atlas.
What this connector does
- Link GitHub issues and pull requests to Atlas tasks.
- Show repository, branch, and review details alongside your Atlas projects.
- Listen for pull-request and issue events to update Atlas task state.
- Post Atlas updates back to GitHub as comments or status checks.
Before you begin
- You are an owner or administrator of your Atlas workspace.
- You can sign in to your GitHub account and approve access for Atlas.
- Atlas looks after the GitHub app on its side, so there is nothing for you to create or copy.
How to connect
Open GitHub in Integrations
In Atlas, open Integrations and select GitHub.
Press Connect
Atlas sends you to GitHub to sign in. Sign in with the account you want to connect.
Approve access
Review the permissions that GitHub lists and approve them. Atlas returns you to the connector page, which then shows the connection.
Check the connection
Select Test connection on the connector page. A passing result means Atlas can read from GitHub.
Permissions Atlas asks for
read:userreporead:orguser:emailSetup checklist
- Confirm you are an owner or administrator of your Atlas workspace.
- Open Integrations and select the connector.
- Press Connect and sign in to GitHub.
- Review the permissions that GitHub lists and approve them.
- Select Test connection and read the result.
Troubleshooting
bad_verification_code
The sign-in approval expired before Atlas could finish connecting. Retry the connection.
Resource not accessible by integration
The OAuth App was not given access to this repository. An organization admin needs to use the Approve step for it.
Connect says GitHub is not available yet
Atlas has not enabled GitHub for this deployment, so there is nothing for you to configure. Check again later.
The sign-in was cancelled
If you close the GitHub screen or choose Cancel, Atlas does not connect. Press Connect again and approve the access.
Atlas asks you to reconnect
GitHub can end a connection when access is revoked or a password changes. Press Reconnect on the connector page and approve the access again.
Event notifications
Atlas sets up event notifications for each repository, protected by a signing secret that it generates.
Events Atlas listens for
- push
- pull_request
- issues
- issue_comment
- check_run
Provider docs: https://docs.github.com/webhooks
Disconnect and data deletion
- Click Disconnect on the Atlas GitHub connector page to revoke the access Atlas was given.
- Open https://github.com/settings/applications and revoke the Atlas Connector authorization.
- Atlas removes the event notifications it set up for each repository automatically when you disconnect.
When you are ready, open the live connector page and press Connect to finish connecting GitHub.
Open the GitHub connector page