Connect GitHub

Connect GitHub and every release on your charts and in Releases shows the pull requests it shipped, with who wrote them. Deploys mark the chart when they go live, the suspect change behind a bad release names its pull request, and error alerts can open GitHub issues.

GitHub is installed once per GitHub account and shared by your workspace. Each site then reads one repository.

Only workspace owners and admins can connect GitHub. See Members.

Open the connect dialog

Open Integrations in the sidebar, find GitHub in the Code group and click Connect. The dialog lists what SnowAnalytics can do (See pull requests and deploys, Open issues for errors) and what it will never do (Change your code, Push, merge or deploy). Click Continue to GitHub.

Install the app on GitHub

Choose the GitHub account or organization, then All repositories or only the ones you select. GitHub asks you to authorize SnowAnalytics once, which only proves the install is yours.

In an organization where you aren't an owner, GitHub sends your request to the owners. Connect again once one of them approves.

Choose the repository

GitHub sends you back to Integrations. If the install reaches one repository, SnowAnalytics picks it and the GitHub card shows Connected. Otherwise a dialog lists the repositories, most recently pushed first. Click Choose next to the one this site ships from.

Another site in the same workspace skips GitHub: its Connect opens the repository list straight away.

What you see

  • Release markers. Hover a day with a release to see its newest pull request and how many more it shipped, such as #418 +2. Click it for the day's releases, newest first: when each shipped, its commit, Compare on GitHub, and one line per pull request. Click a face or a name to open that person's GitHub profile. Pull requests a bot opened, such as release or dependency updates, come last and quieter.
  • Releases. Each release in Releases shows the pull request it is known by, linked to GitHub.
  • Rollbacks. A release that went back to older code says so and lists what it took out.
  • Suspect change. It names the pull request that changed the file a new issue fails in, with Open pull request.

Releases need names that are commits, which the SDK reports by default. A version name such as [email protected] shows no pull requests. See Tag your releases.

Monorepos

When several sites ship from one repository, open Integrations, click Manage on GitHub and fill in Only count changes in with this site's folders, such as apps/web, packages/ui. A pull request then counts only when it changed a file inside one of them. One that changed more than 100 files always counts.

Deploys

GitHub hears about deploys from Vercel and from GitHub Actions jobs that name an environment. SnowAnalytics reads the production ones. To use another environment, pick it in Deploys from.

  • A release ships when its first deploy succeeded, if that came before its first visit.
  • On a site whose releases are commits, or that reports none, each deploy becomes a release on the chart.
  • Hosts that don't tell GitHub about deploys, such as Netlify and Cloudflare Pages, keep the time of the first visit.

Error alerts as GitHub issues

Add GitHub issues in your alert destinations and choose the repository. Issues open as SnowAnalytics' app, so no token is needed and nothing breaks when someone leaves the team. Each carries the snowanalytics label, which SnowAnalytics adds to the repository in its own teal the first time, so a workflow such as fixing errors with an agent can start on it.

What SnowAnalytics can read

The app asks GitHub for these permissions:

PermissionWhy
Metadata (read)Repository names, which every app needs.
Contents (read)Commits and comparisons between releases.
Pull requests (read)Pull request titles, authors and changed file names.
Deployments (read)When deploys go live.
Issues (read and write)Issues for the alerts you route to GitHub.

SnowAnalytics keeps commit titles, pull request titles and authors, and the names of the files a pull request changed. It never copies your code.

Disconnect

Click Manage on GitHub, then Disconnect. The site stops showing pull requests, and the app stays installed for your other sites. To remove SnowAnalytics from GitHub entirely, uninstall it from Settings → Applications on GitHub. Sites using it then show Reconnect.

Troubleshooting

On this page