Coming soon: We are introducing a fresh new look for record drawer and details pages on September 30, 2020. This article describes the current experience. Preview the upcoming improvements in your account now so you can get familiar with the new way of working in Aha!
Aha! provides a two-way integration with GitHub that allows teams to send their planned work from Aha! to their team working in GitHub. Before configuring any integration for the first time, it is important to fully understand how to think about integrating Aha! with your development tool.
Note: For teams using GitHub Enterprise please see the integration instructions here.
Click any of the following links to skip ahead:
- Configure mappings
- Enable the integration
- Test the integration
- Add additional security
- Receive updates
|Required user permissions:
|Required user permissions:
|Associated record types||
To set up an integration with GitHub, you need to be a workspace owner in Aha! for the workspace you wish to integrate. You will also need to have an GitHub account that has proper access to create/edit records in GitHub for the repository you plan to integrate with.
1. Navigate to Settings ⚙️ > Workspace > Integrations and click the + on the left side navigation bar. Select GitHub from the integrations 2.0 grouping.
2. This will launch the integration configuration wizard. The first step is to name your integration and optionally select a template if you have already created one. Click Save and continue.
3. Next, you will be prompted to authenticate. Aha! uses OAuth 2.0 for authentication, and if you are already logged into an active GitHub session in your browser, you will not be prompted for credentials and instead you will be prompted by GitHub to grant Aha! access. If you are not currently logged into GitHub, you will be prompted with an GitHub authentication screen.
Note: We recommend using unique credentials wherever possible, as GitHub limits the number of tokens available for each implementation. This is also advisable for account security purposes.
If you use SSO to log in to GitHub, then you should first login to GitHub in another tab of your browser using the same credentials that you want Aha! to use. Then come back to the Aha! tab and click the Authenticate button to continue.
4. After authenticating, you will be prompted to choose a repository to integrate with. The list of repositories is based on what your GitHub user has available to them. This setting cannot be changed once the integration is in use.
5. After selecting a repository, you will be prompted to choose which project in GitHub you wish to integrate with. Similar to the workspace selection, the list presents the projects that you have access to within the previously selected workspace.
6. This integration can be optionally configured to bi-directionally sync GitHub issue state, project columns, and labels with the status of an Aha! record. The selections below will determine the status mapping options available in the next step.
- Enable issue state enables you to map the status of Aha! records with the state (open/closed) of GitHub issues.
- Enable project columns enables you to map the status of Aha! records with GitHub project columns.
- Enable status labels enables you to map the status of Aha! records with GitHub labels. Choose the GitHub labels that you would like to map to record status.
After you've enabled the desired status sync options, you will then set the actual mappings between Aha! and Github in the next step.
The next step is configuring how Aha! records are mapped to your GitHub records. The default mappings are based on what is most widely used by our customers. However, you are free to remove the default mappings and add your own to map records together based on what makes sense for your team and how you work.
Within each record mapping section, you can also specify your field mappings. This is an advanced option within the configuration that allows you to customize how each field within the record is mapped between Aha! and GitHub Enterprise — as well as what relationship links exist for those records.
Tip: If you have configured required fields in GitHub, we recommend setting the Required flag on those fields in the custom layout associated to your workspace. This will ensure that any required fields are populated when records are created on the Aha! record creation form.
The relationship links are important to consider because they establish the ability for records created in your development system to be automatically imported into Aha! in certain use cases.
You need to define the way statuses are mapped from GitHub to Aha! Within the field mapping section for each Aha! record, there is a line for Status with a Configure ⚙️ icon at the far right. Click the Configure ⚙️ icon to open up the status mapping window. By default, this window will map matching values to each other, but you can adjust mappings or manually rearrange statuses to your preferred mappings as needed.
When mapping statuses, you will be presented with your Aha! status workflow for the record type on the left and your integrated system status workflow on the right. You can drag and drop the statuses to create groupings and mappings.
Enable the integration
With your records, field mappings and statuses defined, you can click Save and continue to move onto the last step in the workflow. The Enable step allows you to specify how updates from Aha! are sent to your development system. The default setting is: Automatically send outgoing changes, which means that any change made to an integrated record will send to GitHub automatically.
We recommend the Approve outgoing changes setting for teams that are unfamiliar with how the integration works. The approval step allows teams that are new to the integration to validate what is being sent to their development system, which can help prevent unintentional changes from going through.
Test the integration
Finally, test the integration by opening one of your features or activities in Aha!, clicking the Send dropdown, and selecting Send to GitHub. You should see a link to the created GitHub record appear on the Aha! feature or activity after a few seconds. This will let you easily click into GitHub to verify that everything was sent through correctly.
Note: You also have the ability of manually bulk sending a subset of features to GitHub.
Add additional security
2.0 integrations with on-premises tools have the option to include a client certificate for added integration security.
To set a client certificate, open your integration settings and click the More options icon in the upper right, then click Set client certificate. From here, enter the private key and certificate — we recommend creating a private key and client certificate specifically for this purpose — and click Save to save your changes.
Note: This feature will only provide additional security when the server that Aha! is communicating with validates the certificate. This is usually only possible with customer-configured on-premises integrations. Client certificate authentication is in addition to the standard username and password/token authentication and is not a replacement.
To receive updates when an issue is changed in GitHub, you have to set up a webhook for the GitHub repository.
- In Aha!, copy the webhook URL from the GitHub issues integration settings.
- In GitHub, go to the settings page of the GitHub repository and click on the Webhooks tab.
- Add a new webhook.
- Paste the webhook URL into the Payload URL field. Choose application/json as content type and leave the secret field blank.
- Select Let me select individual events and then check only Issues, Issue comments, Labels, Milestones, and Project cards.
- Finally, click Add webhook.