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.

Prerequisites

  • You will need Owner permissions in FireHydrant to configure integrations
  • You will need admin permissions in your GitHub organization to install apps
  • FireHydrant will need read access to checks, code, commit statuses, deployments, metadata, and pull requests. FireHydrant needs access to only whichever repositories you want linked with FireHydrant.

Installing the GitHub integration

GitHub tile on the integrations page

GitHub tile on the integrations page

  1. Navigate to FireHydrant's Integrations page located at Settings > Integrations list and search for the GitHub tile. Click the '+'.
  2. On the next page, click Authorize Application. This will take you to the login page for GitHub, or the org selection page if already logged in.
  3. On this page, click the GitHub organization you'd like to integrate FireHydrant with, and then either all repositories or only select repositories. Click Install.

Linking services

After you install the GitHub app, you can link repositories with specific Services or Functionalities. This unlocks automatically logging merges into your main branch as Change Events for specific components in FireHydrant.

You can link in bulk by navigating to Catalog > [Services | Functionalities] > Add functionality > Import from third party, or you can link individual components by going to the specific component in FireHydrant, editing its settings, and then linking a repository from there:

Adding a repository link on a Service/Functionality's **Edit** page

Adding a repository link on a Service/Functionality's Edit page

To learn more, visit Import and Link Components. After importing or linking one or more services or functionalities from GitHub, the associated pull requests appear on the Change Events page as PRs are merged into your primary branch.

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:

Example Change Event from a PR merge

Example Change Event from a PR merge

Next Steps

  • Learn more about Change Events and how responders can more quickly identify breaking changes during incidents
  • See how the Service Catalog takes your incident management to the next level with metrics and tying together teams and resources with their areas of ownership
  • Browse the rest of our integrations