Skip to content

How to connect GitHub

Use this guide when a project should include repository context in supported workflows.

1. Open the GitHub integration surface

Go to the GitHub integration area for the project you want to connect.

2. Start OAuth

Start the GitHub connection flow. The application requests an authorize URL from the backend and redirects the browser to GitHub.

3. Complete authorization in GitHub

Approve the requested access in GitHub, then return through the product callback flow.

4. Exchange the callback and inspect status

After the callback returns, let the application complete the exchange step. At this point the project can inspect:

  • whether authorization succeeded
  • whether a repository is already bound
  • whether the token is ACTIVE, REAUTH_REQUIRED, or REVOKED

5. Choose a repository and branch

Load the repository list, select the target repository, and choose the branch that should be attached to the project.

6. Bind the project

Save the binding so the project can use repository context during supported runtime flows.

7. Reauthorize or unbind when needed

If the token enters REAUTH_REQUIRED or REVOKED, re-run the OAuth flow. If the project should stop using repository context, remove the binding.

For the exact contract, see GitHub integration.