Enable deployments

Are you on the right help page?

The following information only applies to next-gen projects.

To check which type project you need help with, look at the bottom of your project’s left-hand sidebar:

  • If you see an icon stating You’re in a next-gen project with Give feedback and Learn more menu items, you're in a next-gen project.

  • If you don't, you're in a classic project. Check out our classic project documentation.

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

To enable the Deployments feature, you’ll first need to integrate Jira Software with your CI/CD provider. Learn how to connect your CI/CD Pipelines with your project.

For a classic software project, refer to Integrate your deployments with Jira.

Enable Deployments for your next-gen software project

Only project admins can enable and disable features on a project.

  1. Navigate to your next-gen 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 the features available when integrating Jira Software with your development tools.

Understand your deployments view

The deployments view comes with the following filters and settings:

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

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

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

type
  • Insights: This panel allows you to see deep insights into deployment metrics.

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

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

Configure your deployments view

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

deployments

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.

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.

Get your deployments insights

You can now get deployments insights via the deployment frequency beacon.

Deployment frequency: This beacon shows how many times a day you deploy code to production.

How is deployment frequency calculated?
Deployment frequency will display an entire day’s deployments that have been made. It will show a state of the beacon without an average until sufficient data is gathered to calculate it. You need 1 x full week to have passed to calculate an average. The average is then calculated as a rolling average of the last 4 x full weeks.

deployment frequency beacon
Last modified on Jan 4, 2021
Cached at 9:26 PM on Jan 20, 2021 |

Additional Help

Ask the Community