Skip to main content

​
GitHub authentication methods

Currently, GitHub is the only git provider that Graphite integrates with. When setting up an account with Graphite, you’ll have two options to authenticate with GitHub:
We no longer support OAuth as an authentication method. Users who previously authenticated with OAuth remain supported, but new signups must use GitHub App or PAT.

​
Option 1 - Install the Graphite GitHub App

When creating an account on Graphite, it’s strongly recommended that you install or request installation of Graphite’s GitHub App on your organization. GitHub Apps are the officially recommended way to integrate with GitHub. Some benefits for installing Graphite’s GitHub App on your organization:
  • Access to GitHub webhooks, which provides Graphite with push-based updates for information like CI status, mergeability, and real-time push events within seconds.
  • Access to the Graphite Merge Queue. The Merge Queue is only available if our GitHub App is installed on the organization.
  • Avoid hitting secondary rate limits with the GitHub API. This means fewer API requests to keep your data up-to-date, leading to fewer API errors and lower latency.
  • Provides the most security for your organization, giving users more control over which repositories the app can access through fine-grained permissions and short-lived tokens.

​
Install the Graphite App on an organization

You can only install a Graphite App on an organization if you’re an organization owner. If you’re not an owner, you should request to install the Graphite App instead.
If you’re an organization owner, you can install the Graphite App on your chosen organization by following the Graphite onboarding flow, or directly from the GitHub marketplace. See GitHub’s instructions to install an App from the GitHub marketplace.

​
Request to install the Graphite App on an organization

If you’re not an organization owner, you can request approval for the app to be installed. Once you’ve done so, you should reach out to an organization owner to have your request approved. You can find a list of organization roles and members using this link: https://github.com/orgs/{org-name}/people.

​
Authorize the GitHub App with your personal account

After the Graphite App has been installed on your organization or if you’re signing up for Graphite with an organization that has the app installed, you’ll also need to give the Graphite App approval to retrieve information about your GitHub account and make changes on your behalf. The screen to do so will look like this: