GitHub integration templates enable teams to quickly and efficiently roll out integrations for their GitHub repositories. With configuration templates, you can save any GitHub integration you create for a given workspace to use across your account. This enables others to apply that template to future integrations.
Click any of the following links to skip ahead:
- Why use integration templates
- Create a template
- Use an existing template
- Security considerations
- Remove a template
Why use integration templates
Templates allow you to:
- Easily manage large numbers of integrations.
- Speed up the process of setting up integrations.
- Implement standards across your account.
- Simplify the process when utilizing a single set of credentials.
- Move items between projects using the same integration template.
Note: Both 1.0 and 2.0 integrations allow you to use integration templates, though the template and the integration versions need to match (2.0 integrations need 2.0 templates, etc.).
When a single user is also the owner of the GitHub repository, they are able to create the first integration using their username and password. From that point on, workspace owners can use this template every time a new integration is added without having to change or add a username and password. If the username and password needs to be updated in the future, updating the template will refresh the credentials for all integrations utilizing that template.
Note: Github limits the number of tokens that are issued per user/application/scope combination. So, if you request enough tokens to go over one of the limits, older tokens with the same scope being requested will stop working. This is a known limitation with GitHub tokens.
In addition, when a template is applied to a new GitHub integration, the user that creates the integration can choose to edit any of the configuration options as it relates to their Aha! workspace. This allows teams to quickly configure multiple integrations while maintaining the flexibility to have unique integrations per workspace.
Create a template
You will need to be a workspace owner in Aha! to create a GitHub integration through the Settings ⚙️ > Workspace area of your account. Once on the integration configuration page, click the More options menu at the top right of the page.
Selecting Use as a template will save the configuration you are working on as a new template.
Once saved, it will be available to use for future integrations your team configures.
Use an existing template
If you choose to use an existing template, its configuration will be applied to your new integration. Each configuration option will have a checkbox next to it, allowing you to uncheck and apply a unique configuration on a per-field basis. For example, you can inherit user credentials and feature mapping from a template, but define custom field mappings unique to your workspace.
Since the templates allow credentials to be used throughout an Aha! account, only users with access to the workspace containing the template will be able to apply the template.
For example, if someone creates a template for "Workspace A" in your account, and you do not have access to "Workspace A," you will not be able to use the template when you configure your own "Workspace B" integration.
In order to use a template defined on another workspace, a user needs at least viewer access on that workspace. Without full workspace owner access, the user will be able to use the template but will not have access to edit it. This is particularly important because it allows templates to be configured without the concern of other users editing it and impacting integrations across the account.
Remove a template
To remove a template or delete an integration serving as a template, you first need to switch any integrations using it to a different template. When viewing the template, there will be the option to view all integrations currently using it.
Once all integrations using the template have been removed, the More options menu will allow you to delete the integration or remove it as a template.