Connect GitHub
GitHub connects through the Truly Shipped GitHub App. It reads pull requests, reviews, commits and deployments from the repositories you choose, and never your code.
Before you start
Installing an app on a GitHub organization takes an owner of that organization. If you aren't one, you can still start the install: GitHub sends your owners a request, and once one approves it, you press the button again to finish.
Install the app
- In Truly Shipped, open Connections (under your name, in the Workspace section) and press Install the GitHub app on the GitHub card.
- On GitHub, pick your organization.
- Choose the repositories: All repositories, or Only select repositories and tick the ones your engineering teams work in. You can change this later.
- Press Install. GitHub asks you to authorize Truly Shipped, which lets us confirm that you can reach this installation.
- You come back to Connections, which says “GitHub connected”. Your history starts syncing right away.
What each permission is for
Every permission is read-only. The app can't change anything in GitHub.
| Permission | Why we need it |
|---|---|
| Metadata | Required by GitHub for every app: repository names and who can see them. |
| Pull requests | Pull requests and reviews: when work opened, was reviewed and merged, and by whom. This is the heart of cycle time, review load and throughput. |
| Contents | Commits and their change counts, and which commit last changed each line, which is how rework is measured. We read line history and file paths, never file contents. |
| Deployments | When code reached production, for deployment frequency. |
| Actions | Workflow runs, for teams that deploy through GitHub Actions. No number uses them yet. |
| Copilot metrics (organization) | Only if you turn on Copilot usage. See Connect GitHub Copilot. |
The app also receives GitHub's notifications, so new and updated pull requests, reviews and deployments reach Truly Shipped within 15 minutes. Commits pushed outside a pull request arrive with the nightly sync.
Changing repositories later
An organization owner opens GitHub → your organization's Settings → GitHub Apps → Truly Shipped → Configure, and changes the repository list. New repositories are picked up at the next nightly sync. Data from repositories you remove stays, but nothing new arrives from them.
Checking it works
The GitHub card on Connections shows Working and when it last synced. Test connection checks that we can still sign in as the app; Sync now pulls what's changed without waiting for the night. If something is wrong, the card says what happened and what to do next.
Disconnecting
Disconnect on the card stops new data. What's already synced stays. To remove the app from GitHub too, an owner uninstalls it under Settings → GitHub Apps. To have the data deleted, see Security, privacy and data.
Stuck? Write to chris@trulyshipped.com and we'll help.
Next: Connect Jira →