Note: This guide is specific to GitHub Enterprise Servers. For github.com connections, see Integrating with GitHub.
To verify which type of GitHub server you have, see GitHub's Enterprise Server documentation.
Github App is not supported for Github Enterprise server connections.
Initial application setup
Depending on your company's firewall settings, you may need add Gearset’s static IPs to the allowlist in your repository's settings. Next, you will need to create a new OAuth application for Gearset to be able to access your GitHub Enterprise Server instance:
Log in to GitHub Enterprise Server.
Go to the
Applicationspage in your organization’s settings. You may also need to navigate toDeveloper settings.
Under
OAuth Apps, clickRegister new application.Enter the following:
Application name->GearsetHomepage URL->https://app.gearset.comAuthorization callback URL->https://app.gearset.com/authorization/github-enterprise/callback
Click
Register application
Note of the
Client IDand theClient Secretfor later.
Gearset setup
If a member of your team has already set up a GitHub Enterprise Server connection, you can skip this section. Now that you have your application Client ID and Client Secret, you can link Gearset with your GitHub Enterprise Server instance.
Navigate to the Source control and services page.
Click
+ Connect to GitHub Enterprise Server.Fill in the
URLof your GitHub Enterprise Server instance (don’t forget HTTPS),Client ID, andClient Secret(from earlier).Press
Connect. You will then go through the normal authentication flow from within GitHub Enterprise.
Once complete, you will be redirected back to Gearset and you should now be able to use GitHub Enterprise Server repositories as your source or target.
Anyone else in your team who wants to connect to GitHub Enterprise Server will need to follow the Gearset setup steps.