Quickstart on GitHub Enterprise Server

Sourcery reviews every pull request on the repos you connect. Set it up on your GitHub Enterprise Server instance: connect the instance, create the Sourcery GitHub App on it, and open a pull request to read your first review. This works on every plan.

Before you start

Required permissions

You connect GHES as an admin. You need a personal access token with the read:org scope, and creating the Sourcery GitHub App on an organization is an owner-level action, so you need owner permissions on each organization you connect.

If your GHES instance sits behind a firewall, allow Sourcery’s static egress IPs so Sourcery can reach it. See Network requirements for the addresses to allowlist.

Install Sourcery

1. Enter your GHES instance URL

   Go to /login/github-enterprise-server, enter your GitHub Enterprise Server URL (for example, https://github.example.com), and click Login. If the instance isn’t connected yet, Sourcery moves you to setup.

2. Provide a read:org access token

   In the GitHub access token field, paste a personal access token with the read:org scope, created from an admin account. Sourcery uses it to fetch your organizations and seed the GitHub App. Click Continue. You can delete the token once setup finishes.

3. Create the GitHub App on your organization

   Choose an organization for the sourcery-ai GitHub App, then click Create GitHub App. GHES creates the App from a manifest and redirects back to Sourcery, which finishes setup.

   Permissions

   The GHES App requests the same permissions as the GitHub.com app:

   Read-only access

   metadata, organization members, and email addresses

   Read and write access

   actions, checks, code, commit statuses, issues, pull requests, and workflows

   Your code stays yours

   Write access lets Sourcery post reviews, set the status check, and apply suggested fixes. We don’t retain your source code after a review. See Code retention for the detail your security team will want.

4. Log in and start reviewing

   That’s it for setup: Sourcery logs you in through the new connection, the account dashboard opens, and code review is ready on the connected organization. If you have other organizations to connect, just repeat the setup for each one.

Already using Sourcery?

To connect another GHES organization later, run the same login flow and pick a different organization when you create the GitHub App.

Your first review

Open a pull request on any connected repo. Review behavior matches GitHub.com, and you’ll see:

• A summary in the pull request description covering the change’s purpose and risk.
• A reviewer’s guide comment with the code paths that changed and how to verify them.
• Inline comments on the specific lines they’re about.
• A status check called Sourcery review next to the merge button.

Re-review on new commits and @sourcery-ai chat commands work the same as on GitHub.com.

What’s next

Network requirements Egress IPs and connectivity rules for connecting Sourcery to GHES.

Anatomy of a review Walk through one Sourcery review from top to bottom.

Configure code reviews Adjust Sourcery's review behavior per repo or per organization.