Close

Enable GitLab deployments in Jira

Tye Davis
Tye Davis

Technical Marketing Engineer at GitLab

This guide demonstrates how to leverage integrated issues and deployments when you connect GitLab and Jira. The Deployments in Jira feature provides enhanced deployment visibility by tracking and displaying GitLab CI/CD Pipelines against Jira issues over a particular time. By integrating Jira and GitLab, any team member can visualize the progress of a work item as it moves through a deployment pipeline.

Time

10-minute read.

Audience

You work on projects within Jira and would like to leverage integrated issues and deployments with GitLab.

Time

You have a Jira account and basic proficiency in Jira. Get started with Jira here.

You are an existing GitLab customer. Get the GitLab Jira Cloud integration here.

If you’re new to GitLab, get started here. 

Enable Deployments for your team-managed software project

Only project admins can enable and disable project features. 

1. In Jira, navigate to your team-managed software project.

2. Go to Project Settings > Features.

3. Enable the Deployments feature.

Jira Software Projects

4. Navigate back to your project.

5. Go to Deployments.

6. Choose Add another CI/CD tool.

Jira Software Deployments

7. Select Connect to other providers.

Connect Jira Software Deployments to Bitbucket

8. Select GitLab.com for Jira Cloud.

GitLab.com for Jira Cloud

9. Download the GitLab.com for Jira Cloud app.

GitLab.com for Jira Cloud

10. Add a namespace from GitLab.com.

Namespace from GitLab.com
Link namespace from GitLab.com

11. Back in GitLab, after making changes to your code using GitLab CI/CD, use Smart Commits to tie the GitLab commit and branch to your Jira Issue. 

GitLab commit and branch to your Jira Issue

12. You can also use Smart Commits to tie your GitLab merge request to your Jira Issue. This provides visibility in Jira deployments. 

GitLab new merge request

13. Back in Jira, you can see that Smart Commit moved the issue from “Backlog” to “In-Progress”.

Smart Commit moved the issue on Jira

14. Navigate to Deployments.

View deployment pipelines with Jira

The Deployments in Jira view displays a list of issues and deployments, with options to filter by environments.

To display your project deployment information, include issue keys in your branch names, commit messages, and pull requests.

Understand the Deployments in Jira view

The Deployments view includes the following filters and settings:

Filters and settings
  • Search: In the search text filter, specify the keywords that will display desired issues and associated deployment pipelines.
  • Environment: This filter allows you to focus the deployments view on a development instance by selecting an environment from the dropdown.
Filters
  • Versions: This filter allows you to screen issues based on the released product versions. For example, product features released through different versions.
  • Epic: This filter allows you to group deployments and issues by epics. You can also filter the issues that don’t have a parent epic.
Filters
  • Type: This filter allows you to sort issues by types.
Types

1 "Issue key","Issue summary","Issue URL","Deployment date","Deployment state","Environment type","Environment name"

2 "ABC-1111","agent-service: Add a POST endpoint to allow runner creation","https://workteams.xyz.net/browse/ABC-1111","2020-12-04 14:40:31","SUCCESSFUL","PRODUCTION","Production"

3 "ABC-2222","agent-service: Add PUT endpoint for runners","https://workteams.xyz.net/browse/ABC-2222","2020-12-04 14:40:31","SUCCESSFUL","PRODUCTION","Production"

  • View settings: This panel allows you to configure the deployments view using filters such as Environment types, Icons, and Issues. You can also disable the deployments feature using the information on this panel.

Configure your Deployments in Jira view

To configure the Deployments view, navigate to the View settings panel on the board. It contains the following filters:

Deployment settings

Environment types

Customize your Deployments view using environment types. Select environment types to modify the view for visualizing deployment statuses over a particular time.

Icons

  • Deployment keys: Hide or show the deployment status on the time scale.
Deployment keys
  • Multiple deployments: Hide or show the number of deployment environments corresponding to each issue in your project timeline.

Issues

  • Show issues without deployments: Hide or show the issues that are not associated with any deployments.

A project administrator can view and click the More options (…) menu from the top-right corner of the Deployments page, to manage installed app and project features.

See more integrations for Atlassian Open DevOps

Tye Davis
Tye Davis

Tye Davis is an evangelist and Technical Marketing Engineer at GitLab. Tye has more than 10 years of experience rooted in agile and DevOps transformations. With roles as a Solution Architect, Product Marketing, and Product Management, he has worked closely with numerous Fortune 500 companies that implemented agile transformations and DevOps best practices.


Share this article

Recommended reading

Bookmark these resources to learn about types of DevOps teams, or for ongoing updates about DevOps at Atlassian.

Devops illustration

DevOps community

Devops illustration

Simulation workshop

Map illustration

Get started for free

Sign up for our DevOps newsletter

Thank you for signing up