Documentation

GitHub

Link GitHub to the app or a personal access token, and find out what each option allows.

GitHub connects via the Coroid GitHub app or a personal access token. Set it up at Settings → Connections → Source control.

App or token

The app is preferable. It provides access per repository rather than per user, continues working even after the person who set it up leaves, and receives webhook events without needing to poll.

Use a token if installing the app requires admin approval from an organisation that you cannot obtain.

GitHub appPersonal access token
Access scopePer repositoryEverything the user can view
Keeps working even after the installer leavesYesNo
Webhook eventsYesPolling
AttributionThe appThe token owner

Installing the app

Select GitHub at Settings → Connections → Source control and follow the installation process. GitHub will ask which repositories to grant access to; you can adjust this later via GitHub's own settings.

If a repository does not appear when creating a project, it’s almost certain the app wasn’t granted access to that specific repository – this is by far the most common cause of the issue.

Using a token

Create a classic token with the repo scope, or a fine-grained token with read and write permissions for contents and pull requests, then enter it in the source control settings.

Tokens are encrypted when stored, never returned by API, and never included in settings exports.

GitHub Issues

The same connection can be used to import issues as work. See Importing work.

What Coroid does in your repository

  • reads code to understand and modify it
  • creates a branch for each task
  • pushes that branch and opens a pull request against your base branch

It never commits to your default branch and never merges. Your branch protection, required checks and review rules remain unchanged.