Enable deployments

The Deployments feature gives you greater visibility of deployments by tracking and displaying CI/CD Pipelines against your Jira issues over a time scale. You can visualize the progress of a work-item as it moves through your deployment pipeline.

Enable Deployments for your software project

1. Navigate to your software project.

2. Go to Project Settings > Features.

3. Enable the Deployments feature.

A new menu item, Deployments, will be added to the project menu.

Integrate your deployment pipelines with Jira

The Deployments screen will display a list of issues and deployments information with options to filter by the environments.

To display deployment information in your project, include issue keys in your branch names, commit messages, and pull requests. Learn how to reference issues in your development work.

Read more about integrating Jira with your development tools.

Understand your deployments view

The deployments view comes with the following filters and settings:

• Search: In this text filter, specify the keywords to display issues of your interest and their associated deployment pipelines.

• Environment: Using this filter, laser focus the deployments view on a development instance by selecting an environment from the dropdown.

• Versions: This filter allows you to screen issues based on the released product versions. For example, the product features that you have 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.

• Type: This filter allows you to sort issues by type.

• Date range: This filter allows you to set a date range for your deployments. Learn how to use the data range filter.

• Insights: This panel allows you to get deep insights into deployment metrics. Learn how to view and understand your deployment insights.

• Export: This button allows you to download the deployments view in a CSV file. Based on the filters that you choose the information gets exported in the CSV file. You can further import this CSV file into Microsoft Excel or Google Sheets. For example, see the sample CSV file.

  1 2 3 "Issue key","Issue summary","Issue URL","Deployment date","Deployment state","Environment type","Environment name" "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" "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 view

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

Environment types

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

Icons

• Deployment keys: Hide or show the deployment status on the time scale.

• 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.

View deployment information on the release page

If you’ve enabled releases in your Jira project, you’ll see deployment information on the release page. Go to your project and select Releases in the project menu, then select a version to view its release page. The deployment status of each issue in your version will be displayed in the Deployments column. We'll show an icon to indicate whether an issue has been deployed successfully and a label to tell you what environment it’s been deployed to. Click on a deployment status to view a detailed dialog with links to the associated pipelines in your CI/CD tool.