GitHub

Overview

Heeler connects at the organization level and uses GitHub Apps. The Heeler GitHub app requires these permissions:

• Read-Only Metadata: A mandatory permission for GitHub applications to gather information about the repositories in your environment.

• Read-Only Content: Permission to read the contents of repositories in order to run checks and correlate services.

• Read and Write Checks: Permission to run checks against Pull Requests and update Check Status upon check completion.

• Read and Write Pull Requests: Permission to track the Pull Request process and open pull requests to fix security issues.

• Heeler Subscribes to webhook events for “Pull Request”, “Release”, and “Push”. These allow for Heeler to have real-time processing of repository changes and manage Pull Request processes.

Requirements

• To install the Heeler GitHub app, you must be an organization owner or have administrative permissions for the repositories you wish to connect to Heeler.

• If your organization uses an IP Allow List, ensure that Heeler's outbound IP addresses are added. Note that the outbound IPs are added to the Heeler GitHub app and you will be prompted to accept upon setup.

  • 44.221.229.40

  • 52.73.231.96

Setup

1. Select the icon from the top navigation

2. Select Connections -> Code Organizations then select 'Add Code Organization'

3. You will be redirected to GitHub to authorize the Heeler GitHub App.

4. Select whether you want Heeler to secure all repositories or limit to a specific set of repositories.

5. Click Save and that's it, Heeler is now connected to your GitHub repositories.