Skip to content

All integrations

Connect GitHub to ShipVitals

CI runs, releases, stars and traffic per repo

AvailableApp install · about 2 minutes

Connect GitHub

What it reads

Metadata · Read
Lists the repositories you install it on
Contents · Read
Release assets, and finding a repository's surfaces (site, package, app)
Actions · Read
Workflow runs and their results
Deployments · Read
Deploy history
Administration · Read
Repository traffic (GitHub requires it)

Read-only: ShipVitals can't change anything at GitHub.

What ShipVitals keeps: The installation id; the app's key stays with ShipVitals and tokens last an hour.

Every connector's scopes, on one page

How to connect

  1. Continue to GitHub and choose the account or organization.
  2. Choose All repositories, or select the ones ShipVitals should read.
  3. Install. GitHub brings you back here.

About 2 minutes.

How to revoke

Revoke it at GitHub

Removing the connection in ShipVitals deletes the stored key at once.

What it powers

Dashboard tabs: Health.

Figures it fills

  • Release downloads
  • Release downloads, all time
  • GitHub stars
  • Repository views
  • Unique repository views
  • Repository clones
  • Unique repository clones
  • ci.runs.total
  • ci.runs.failed

Sync

  • Free: Daily
  • Indie: Hourly
  • Studio: Every 15 minutes
  • Agency: Every 15 minutes

Troubleshooting

Each error a connection can hit, and its fix. The connection's health page names the one it hit.

Access refused
GitHub no longer accepts what ShipVitals signs in with. Create a new key, or connect again, and replace it in the connection.
A permission is missing
What ShipVitals has can't read everything it needs. Add the permissions under What it reads, or create a new key with them, and test again.
Access removed
ShipVitals' access was removed in GitHub. Connect it again; the history it brought in is kept.
Rate-limited
GitHub asked ShipVitals to slow down. Nothing to do: the sync carries on by itself and catches up.
Quota reached
The account used up a GitHub quota. The sync resumes when the quota resets.
Not found
Something the connection reads is gone from GitHub: renamed, moved or removed. Review the connection's resources, or connect again.
GitHub is unavailable
GitHub is having trouble on its side. Check its status page; ShipVitals retries by itself.
Couldn't reach GitHub
The request didn't get through. ShipVitals retries by itself; if it keeps failing, check that GitHub is reachable.
An answer ShipVitals didn't expect
GitHub answered in a shape ShipVitals didn't expect, usually after a change on its side. We're told, and the data you have is kept.
A setting doesn't work
A field in the connection doesn't work with GitHub. Check it against How to connect, and test again.

Docs