Integrating Gearset with Jira for seamless user story tracking
Ellis Toms on December 11th 2017
Gearset's Jira integration makes it easy to automatically post deployment updates to your tickets and track user story progress.
The days of manually updating Jira tickets and attaching deploy package zip files are over. With Gearset, all you have to do is add the Jira ticket reference on the summary of objects to deploy page and Gearset will automatically post updates to your Jira ticket and provide a direct link back to the deployment or validation. Now you’ll be able to effortlessly see all the changes your team are making, keep up-to-date with the progress of tickets and approve releases more efficiently and confidently.
Initial Jira setup (team owner)
To get started, you’ll need your Jira administrator to create an application link in Jira itself and your team owner to authorise Gearset. This provides a mechanism for Gearset to authenticate against Jira in order to post updates to tickets, and only has to be completed once. After this has been done, any subsequent users can set up a Jira connection in just a couple of clicks.
Step 1: Copy Gearset’s public key
- In Gearset, navigate to the connections page, switch to the source control tab and click connect to Jira under manage linked services [Note: you must be the owner of your Gearset team to complete these steps]
- From the resulting dialog, keep the generated public key and consumer key to hand as you’ll need them for Step 2
Step 2: Creating an application link in Jira
- In a new tab, sign in to your Jira instance as an administrator and navigate to the applications page [Note: this must be completed in a new tab to preserve the generated consumer key]:
- Click the application links tab, paste Gearset’s URL into the application URL text box, and click create new link:
- When prompted with a dialog to confirm the application URL, click continue:
- In the link applications dialog, fill in the application name and application type, and be sure that the create incoming link box is checked, and click continue:
- In the link applications dialog, enter the consumer name and Gearset’s consumer key and public key from Step 1. Once the configuration is complete, click continue:
- Once completed, Gearset should appear as an application link in your Jira instance
Step 3: Authorize your Gearset to post on behalf of your Jira user
- In Gearset, navigate to the connections page, switch to the source control tab and click connect to Jira under manage linked services
- Enter the URL of your Jira Cloud instance and and click connect:
- Upon clicking connect, you’ll be redirected to your Jira instance and prompted to log in, if you aren’t already. When prompted, grant Gearset permission to make changes to your Jira data by clicking allow:
- Once complete, Jira will redirect you back to Gearset.
Connecting to Jira (team members)
Once the Jira application link has been created and Gearset has been authorized by the team owner, the rest of the team members will be able to connect to Jira:
- Navigate to the connections page, switch to the source control tab and click connect to Jira under manage linked services
- Click allow within the Welcome to Jira dialogue box (as shown above)
- You'll then be redirected back to Gearset and can start linking Jira tickets
Adding a Jira ticket
Once you have created and set up an application link in Jira, you can start linking Jira tickets to your deployments and validations. For Gearset to automatically update your Jira ticket, simply add the Jira ticket reference before you deploy or run a validation.
- To link a Jira ticket, follow the usual comparison process, selecting which metadata items you would like to deploy or include in your validated package.
- Once the pre-deployment problem analysis has checked for any potential issues, you’ll be taken to the summary of objects to deploy page.
- Click on the Jira updates tab, add in your ticket reference, and you’re all set! From there you can either validate and schedule the deployment or deploy instantly as usual.
Within Jira, any actions performed will have been automatically recorded for you in your Jira ticket.
With this feature you’ll be able to see exactly what changes have been made at each step of the user story, making it easier to review changes and speed up your release cycles.
Jumping for joy over Jira?
If you've had a chance to try out this feature and have any feedback or questions then we want to hear from you! Chat to us via the live in-app chat or at [email protected] and a member of the team will get back you.