Install the GitHub App
Install the Qodex GitHub App before you connect repos for PR review. The install lives on a GitHub user account or organization. The grant lives inside a Qodex project. One GitHub install can be granted to more than one Qodex project when different teams need independent reviews.Prerequisites
- A Qodex project. The install grants access to one project at a time, even when the App is installed once for a whole org.
- Owner or admin on the GitHub account or organization you are installing to. GitHub does not allow non-admins to install Apps.
1. Start the install from Qodex
In your project, open Settings > Integrations > GitHub and click Install on a new account. Qodex creates a short-lived signed token that remembers your user and project, then redirects you to GitHub. The token expires in 10 minutes.2. Choose an account on GitHub
GitHub lists every account and organization where you can install the App. Pick the account that owns the repos you want Qodex to review. If you do not have admin access, GitHub will refuse the install on that account. Pick a different account or ask an admin to install it.3. Pick repos
Two choices:- All repositories. Every existing and future repo on the account is visible to the install. New repos created on the account are visible immediately.
- Only select repositories. Pick the repos you want Qodex to see. You can change this from your GitHub account settings later.
4. Return to Qodex
GitHub redirects you back to Qodex with the new install. Qodex records it, grants it to the project you started from, and returns you to the GitHub integration panel. From there, pick which repos from that install should be linked to this project. The App stays installed on GitHub. The project grant is what lets a specific Qodex project use that install.Try it yourself
Connect a repo
Link a repo from the install to your project.
Disconnect an install
Revoke a project’s grant on an install.