Set up Jira Automations

Owned by Sarah Schmitt-Bär
Last updated: May 24, 2024
3 min read

Templating.app supports integration with Jira Automations, allowing administrators to automatically apply issue templates when specific actions are triggered. This feature helps ensure consistency and standardization across your projects by automating the template application process. This documentation will guide you through setting up and using this functionality to streamline your workflow.

Start using Jira Automations for Templating.app

https://www.loom.com/share/fb569f761f0a4ee2be5ccf8ac68d7db6

  1. Activate Feature in Templating.app

    • Navigate to the configuration page.

    • Locate the WebTrigger URL and API token.

    • Both are needed to configure Jira Automation rules using TemplatingApp features.

  2. Generate API Token

    • Click on the "Enable Automations" button to generate the API token.

  3. Manage Automations

    • To disable automations, click on the designated button.

    • To re-enable them, click the button again.

  4. API Token Management

    • Disabling/enabling automations does not change the API token.

    • To change the API token, click on "Generate new API token" and follow the instructions.

  5. Important Note

    • Changing the API token will affect Jira Automation rules using the old token.

    • Update the token in the automation rules if you generate a new one.

 

 

There are many use cases that can be improved by using Jira Automations together with Templating.app. Here are some examples:

Release Management: Apply Issue Template when Version has been created

  1. Identify the Issue Template:

    • Choose the issue template you want to use in your Jira Automation.

    • Review the configuration of the selected Issue Template.

  2. Navigate to Templating.app Administration:

    • Access the Templating.app administration.

    • Ensure that automations are enabled for Templating.app.

  3. Create a Jira Automation:

    • Go to the Jira Automation screen.

    • Create a new Jira automation.

    • Set up a trigger for the creation of new versions in the Jira project.

  4. Configure Automation Actions:

    • Use a version name filter to trigger the automation for iOS app releases.

    • Utilize a web request as an action.

    • Copy the web request URL from the Templating.app configuration.

    • Use the API token as an 'Authorization' header.

  5. Define Issue Template and Variables:

    • Send a custom data body to specify the project ID and version name.

    • Copy the code from the documentation for the custom data body.

    • Paste the issue template ID from the URL.

  6. Turn on the Automation Rule:

    • Give the automation rule a name.

    • Activate the new rule.

  7. Test the Automation:

    • Create a new version in a project with "iOS" in its name.

    • Check the execution log in the templating app configuration.

    • Verify that the automation has run successfully and issues have been created.

  8. Review the Results:

    • Confirm that the new issues have been created with the specified details.

    • Check that the issues are using the iOS release version in their summaries.

 

Custom Data Body
{
"id": "Enter your Template ID here",
"projectId": "{{version.project.id}}",
"input": {"Version Name": "{{version.name}}"}
}

 

 

Multi-Projectmanagement: Apply Issue Template when new Project has been created

https://www.loom.com/share/63064b72fab247008a8a05bec6afbc77

  1. Identify the Issue Template:

    • Choose the issue template you want to use in your Jira Automation.

    • Review the configuration of the selected Issue Template.

  2. Navigate to Templating.app Administration:

    • Access the Templating.app administration.

    • Ensure that automations are enabled for Templating.app.

  3. Create a Jira Automation:

    • Go to the Jira Automation screen.

    • Create a new Jira automation.

    • Set up a trigger for the creation of projects.

  4. Configure Automation Actions:

    • Utilize a web request as an action.

    • Copy the web request URL from the Templating.app configuration.

    • Use the API token as an 'Authorization' header.

  5. Define Issue Template and Variables:

    • Send a custom data body to specify the project ID and customer name.

    • Copy the code from the documentation for the custom data body.

    • Paste the issue template ID from the URL.

  6. Turn on the Automation Rule:

    • Give the automation rule a name.

    • Activate the new rule.

  7. Test the Automation:

    • Create a new project.

    • Check the execution log in the templatin.app configuration.

    • Verify that the automation has run successfully and issues have been created.

  8. Review the Results:

    • Confirm that the new issues have been created with the specified details.

    • Check that the issues are using the customer name in their summaries.

Custom Data Body
{
"id": "Enter your Template ID here",
"projectId": "{{project.id}}",
"input": {"Customer Name": "{{project.name}}"}
}