Set up the Orbit GitHub integration

This guide will walk you through setting up the GitHub integration.

The Orbit GitHub integration will automatically ingest contributors and activities from the repos you provide access to. We'll create a profile for every contributor, a global and personal timeline for all activities, and generate an automatic report.

Installing the Orbit app in your GitHub organization

With your workspace created, the next step is to install the Orbit for GitHub app, which will sync your repos with your workspace.

The “Connect with GitHub” button will prompt you a list of GitHub accounts and organizations for you to choose from.The “Connect with GitHub” button will prompt you a list of GitHub accounts and organizations for you to choose from.

The “Connect with GitHub” button will prompt you a list of GitHub accounts and organizations for you to choose from.

The Orbit app will ask for Read-only permissions, and you can select which repos it will have access to.

🚧

If you aren’t the admin of the GitHub organization, you won’t be able to install the app yourself, you’ll need to request it. Requesting it will send a message to the admins of the GitHub organization. Once they approve it, you’ll have the ability to attach it to your new workspace.

You can import all repositories, or select any number of specific ones.You can import all repositories, or select any number of specific ones.

You can import all repositories, or select any number of specific ones.

If you choose "All", Orbit will only connect to public repositories. If you choose a specific set of repositories, public or private, Orbit will connect to those and those only. If you wish to have a hybrid of public and private repositories connected to Orbit, you'll need to choose "Only select repositories" and select all of the ones you're interested in.

Adding your GitHub organization to your workspace

Finally, add your organization to your workspace.

📘

Tip: you can attach multiple GitHub orgs to an Orbit workspace.

Orbit will now import activities and contributors from your organization's repos. It may take a few minutes to fully sync.

Configuring your installation post-setup

If you need to update which repos are included in your workspace, navigate to Settings and view the Integrations section

Understanding GitHub data in Orbit post-setup

You may notice a small discrepancy between the count of GitHub stars and the count of GitHub issues showing in GitHub vs Orbit.
Why is there a discrepancy between the count of issues and stars in GitHub vs Orbit?

GitHub Stars
The discrepancy between the count of GitHub stars shown in GitHub vs count of GitHub stars shown in Orbit is expected because we're not currently measuring removed stars or "un-stars". Therefore, you can expect Orbit to reflect a slightly higher star count than you see in GitHub.

GitHub Issues
GitHub issues are typically represented 1:1 between GitHub and Orbit, meaning, there is typically no discrepancy between GitHub issues in GitHub vs Orbit.
1 issue in GitHub = 1 issue in Orbit

If it's not 1:1, there can be a few situations that explain why the discrepancy exists:

  • GitHub outages
  • Deleted members
  • Initial import - In some cases, GitHub issues are missing from Orbit that should have been collected during the initial import.
    In these situations, the discrepancy between the count of GitHub issues shown in GitHub vs the count of GitHub issues shown in Orbit is typically small, respectively around 2%. No "un-stars" to explain in this case :)

In the long term, we intend to benchmark our metrics on issues/pull requests against GitHub to understand standards, flag, resolve and communicate in the case of a data discrepancy.
We are steadily improving the mechanisms to make sure as few GitHub issues as possible are missing from the activities count in Orbit.