Aha! Roadmaps | Integrate with GitHub commit

This integration allows your team to better understand what work engineers are completing in real-time. It also provides engineers with a record of all of the changes that were made for a feature and provides a hassle-free way to keep everyone in the loop.

Once you have enabled the integration, GitHub will create a comment in Aha! Roadmaps each time a feature or requirement is referenced in a GitHub commit message.

All GitHub Commit integrations are configured in Settings ⚙️ Account Integrations. You need to be an Aha! Roadmaps administrator to configure account integrations.

Click any of the following links to skip ahead:

• Prerequisites

• Configuration

  • In GitHub

  • In Aha! Roadmaps

Prerequisites

Top

Configuration

In GitHub

1. On the Settings tab of the Github repository, open the Webhooks & Services section.

2. Click Add webhook.

3. Paste the payload URL from Hook URL section below.

4. The Content type should be

   application/x-www-form-urlencoded

5. The secret should be empty.

6. Select Just the push event.

In Aha! Roadmaps

1. Create the integration in Aha! Roadmaps by navigating to Settings ⚙️ Account Integrations, clicking the + button and selecting GitHub Commit Hook.

2. Enter the webhook you generated in GitHub as the Webhook URL.

3. Click Enable to enable the integration

When you are using Github's two factor authentication you must use their One Time Password (OTP) for applications using the API. Just put the OTP in for your username and leave the password blank. See this GitHub article for details.

Each commit message to the Github repository will be processed. If the commit message contains the reference from an Aha! Roadmaps feature or requirement then the commit message will be added as a comment to the feature or requirement.

Top