• Products
  • Get started
  • Documentation
  • Resources

Set up deployment gating

The features described in this article are available for service projects using the IT service management template. Learn more about the IT service management template.

 

Deployment gating lets you allow or prevent deployments at specific points in the change management process using a CI/CD tool that you’ve connected to Jira Service Management.

To use deployment gating, you’ll need to set it up in Jira Service Management, and then set it up in your CI/CD tool.

To set up deployment gating, you’ll need to:

Set up deployment gating in Jira Service Management

  1. From your service project, go to Project settings > Change management

  2. Under Deployment gating, select Allow or prevent deployments using statuses in the change request workflow.

  3. Under Allow deployment, select a status to transition to when the deployment is allowed.

    • If you’re using the default change management workflow, we recommend selecting Implementing.

  4. Under Prevent deployment, select a status to transition to when the deployment is prevented.

    • If you’re using the default change management workflow, we recommend selecting Declined.

  5. Select Save changes.

Jira Service Management will send a message to the deployment provider when a deployment is allowed or prevented.


Set up deployment gating in your CI/CD tool

Bitbucket

To use deployment gating with Bitbucket, you’ll need to have a Standard or Premium Bitbucket license, be an admin for the repository for the service you want to connect, and set up deployment gating in Jira Service Management following the instructions above.

To set up deployment gating with Bitbucket:

  1. From your service project, go to Project settings > Change management

  2. Under Bitbucket pipelines, select Configure next to the service you want to use with deployment gating.

    • If you don’t see Bitbucket pipelines, set up deployment tracking.

    • If you see Bitbucket pipelines but you don’t see the service that you want to use, select Connect service and follow the prompts to connect your service.

  3. Select the environment that you want to gate deployments for.

  4. Turn on Enable deployment gating for this environment.

Jenkins

Before you begin, you’ll need to integrate Jira Cloud with Jenkins.

To set up deployment gating with Jenkins:

  1. From your service project, go to Project settings > Change management.

  2. Under Deployment gating, select Allow or prevent deployments using statuses in the change request workflow.

  3. Under Allow deployment, select a status in the workflow when the deployment is considered ‘allowed’ to proceed. For example, if approval is granted.

    • If you’re using the default change management workflow, we recommend selecting Awaiting Implemention.

  4. Under Prevent deployment, select a status in the workflow when the deployment is considered ‘not allowed’ and should be prevented (e.g. if approval is denied).

    • If you’re using the default change management workflow, we recommend selecting Declined.

  5. Select Save changes.

  6. Under Other CI/CI tools:

    • Select the service(s) which are deployed from your Jenkins pipeline.

    • For each service, select (…) > Copy service ID.

    • Save your service IDs as you will need them later.

Other CI/CD tools

Deployment gating for other CI/CD tools is coming soon. Check back here for updates.

Last modified on Nov 9, 2020
Cached at 8:54 PM on Nov 29, 2020 |

Additional Help

Ask the Community