Connect GitHub
Install the Prodgator GitHub App and link a GitHub organization or personal account to Prodgator.
Prodgator connects to GitHub through the Prodgator GitHub App. The App receives workflow, deployment and security alert events for the repositories you install it on, and Prodgator uses its installation token to read run details and logs.
Requirements
- On GitHub: Owner of the GitHub organization, or your own personal account.
- In Prodgator: the role.
Step 1: Install the GitHub App
Open the Prodgator GitHub App install page and install the App on the GitHub organization or account you want to watch. The GitHub card in Admin Console > Integrations and the onboarding provider step link to the same page (Install the Prodgator GitHub App). During installation GitHub asks whether the App gets All repositories or Only select repositories. You can change this later on GitHub under Settings > GitHub Apps > Prodgator > Configure.
If you install the App from GitHub before starting in Prodgator, GitHub sends you back to Prodgator with the message "Finish connecting here". Continue with step 2.
Step 2: Connect it in Prodgator
- Open Admin Console > Integrations.
- On the GitHub card, click Connect GitHub (or Add Another Organization if one is already connected).
- GitHub asks you to authorize Prodgator. Prodgator uses this only to list the App installations you administer.
- If you administer one installation, Prodgator connects it. If you administer several, pick the ones to connect. The picker also has an Install on another GitHub account link.
The GitHub card then lists each connected organization with its installation ID.
Only organizations or accounts where you are an admin are offered. A GitHub installation can belong to one Prodgator organization at a time. If it is already connected elsewhere you see "Already connected elsewhere", and it has to be disconnected there first.
What Prodgator receives
The App's webhook sends these events to Prodgator. You do not configure a webhook yourself.
| GitHub event | Shown in Prodgator as |
|---|---|
| A pipeline run, and a new evaluation of pull request gates on the run's commit | |
| A job (stage) in a run | |
| , , | Deployments and approvals |
| , , | Security findings |
| , | SPACE metrics, the status check, and pull request gates |
| , , | Other checks and statuses that pull request gate rules read, and Re-run of the Prodgator Policies check |
| Pull request gate evaluation of a merge queue's merge group |
Prodgator also pulls Dependabot, code scanning and secret scanning alerts from every connected installation every 6 hours, so alerts raised before you connected show up too.
Permissions
Besides the permissions above, pull request gates need the App to have Checks: Read and write (to create and update the Prodgator Policies check run, and to read other checks) and Merge queues: Read (to receive events; Prodgator never changes a queue). The Required checks rule also reads the base branch's required status checks with Administration: Read and pending workflow runs with Actions: Read. Every installation must accept these once GitHub asks, or its pull requests get no check.
Check the connection
Push a commit or run a workflow in a repository the App can see. The run appears on the Pipelines page within a few seconds.
Troubleshooting
No runs appear. Check that the App is installed on the repository (GitHub, Settings > GitHub Apps > Prodgator > Configure) and that the repository has workflows in . Runs that started before you connected are not imported.
"Nothing to connect". The App is not installed on any organization where you are an admin, or on your own account. Install the App (the toast has an Install the Prodgator GitHub App button), or ask an organization owner to, then click Connect GitHub again.
Approving required-reviewer deployments. That needs your own GitHub account linked to your Prodgator profile. See Linked accounts.
Disconnecting
In Admin Console > Integrations, click the delete icon next to the organization. Prodgator stops accepting events for that installation. Runs already recorded stay until your plan's retention removes them. To remove the App from GitHub as well, uninstall it on GitHub.