Skip to main content

Integrating with GitHub

Deploy to and from your hosted GitHub source control provider using Gearset

Valerio Chang avatar
Written by Valerio Chang
Updated over 2 weeks ago

Connecting to your source control repository with Gearset allows you to deploy to and from your source of truth. This article demonstrates how simple it is to connect to your cloud-based repository on GitHub.

If your GitHub repository is not on the URL https://github.com/, it's likely you have an on-premise instance, called GitHub Enterprise Server. We have a separate document to guide you through Integrating with GitHub Enterprise Server.

If you'd like to Integrate with GitHub through a GitHub App, we have a separate document that guides your through Integrating with GitHub through a GitHub App.

Once you're logged into Gearset, head to the Source control and services section and click Connect to GitHub.

This will take you to GitHub's OAuth page. You may need to click Authorize Gearset to provide access to your organization.

Please make sure that you see a green check mark after you grant access. The green check mark will display like below, confirming that access has been granted.

Once complete, it should look like this (with your authenticated GitHub username being visible):

Common issues with being unable to access a GitHub repository

Organization access

Double-check your organization has given Gearset access to your repository. If your see the GitHub connection gives the error "Gearset can't find any repositories, you may need to request access from the repository owner(s). Once you are ready to proceed, click Authorize Gearset to continue and input your password.

Third-party application access policy

Also check that your access policy isn't blocking Gearset from viewing the repo. If you see below restriction, then Gearset may be unable to read your organization's repo.

To allow Gearset access to your repository, click Yes, remove application restriction. You may need to consult your Git admin first.

Authorized apps

Additionally, your GitHub applications settings should show you "Gearset Deploy" as an authorized app. You have the ability to revoke the application at any time.

Did this answer your question?