Integrating with GitHub

FireHydrant's GitHub integration allows you to track a change--from its origin in a pull request to its eventual impact on your system.

Note: Currently FireHydrant supports connecting to one GitHub org. If you need support for multiple GitHub orgs, please submit this feedback to support.

Setting up GitHub integration

To get started:

  1. In the left nav, click Integrations. Click the GitHub tile.
  2. On the next page, click Install App.
    setup.github.png
  3. You are directed to GitHub. Choose the GitHub organization where you want to install FireHydrant. github_org.png

Note: You must be a GitHub organization admin to install the app.

Linking Services

After you install the GitHub app, you are returned to the Services import setup page. (You can also find this page by navigating to Infrastructure > Services and clicking Link and import.)

To choose GitHub as your import source, select it from the dropdown.

import.github.png

This reveals all of the services available to import from your GitHub instance. Select the checkbox for the service(s) you want to import. Using the dropdown menu, indicate whether you want to import each service as new or link it to an existing service.

service.import.create.png

Click Start Import to import the service. After your import is complete, the page shows import results, listing the Name and Remote ID of the service you imported.

After you have imported or linked a service (or services) from GitHub, the associated pull requests appear on the Change Events page as they're merged.

Example of a Change Event

Whenever a pull request is merged to the primary branch in the repo, the change event will show:

  • Name of PR and what time it occurred
  • Labels for base, source, merged_by, and repository from GitHub
  • Revision and branch from Github
  • Associated Services and Environments
  • Associated Change Events
  • Diff link to Github

Here's an example of what that looks like:

Screen_Shot_2021-11-15_at_5.45.00_PM.png

Permissions for this integration

FireHydrant needs read access to checks, code, commit statuses, deployments, metadata, and pull requests. FireHydrant needs access to only select repositories.

Last updated on 2/9/2024