Documentation

GitHub

Connect GitHub with the App or a personal access token, and understand what each grants.

GitHub connects either through the Coroid GitHub App or a personal access token. Configure it at Settings → Connections → Source control.

App or token

Prefer the App. It grants access per repository rather than per user, keeps working when the person who set it up leaves, and receives webhook events without polling.

Use a token where App installation needs an organization admin approval you cannot get.

GitHub AppPersonal access token
Access scopePer repositoryEverything the user can see
Survives the installer leavingYesNo
Webhook eventsYesPolling
AttributionThe AppThe token owner

Installing the App

Choose GitHub at Settings → Connections → Source control and follow the install flow. GitHub asks which repositories to grant; you can change that later from GitHub's own settings.

If a repository does not appear when creating a project, the App almost certainly was not granted that specific repository — that is the most common cause by a wide margin.

Using a token

Create a classic token with the repo scope, or a fine-grained token with read and write on contents and pull requests, then paste it into the source control settings.

Tokens are encrypted at rest, never returned by the API, and never included in settings exports.

GitHub Issues

The same connection supports importing issues as work. See Importing work.

What Coroid does in your repository

  • reads code to understand and change it
  • creates a branch per 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 apply unchanged.