When building web applications industry best practices are to have a CI/CD (continuous integration and continuous delivery) pipeline put in place. With Bitbucket Pipelines this is as easy as providing a bitbucket-pipelines.yml file that contains the logic and code to do just that. However, infrequently the development team might want to block releases to their production environment due to various reasons (earnings calls, major traffic days, release windows, significant new feature, change review, and several more).
A great way to implement this type of release block is to configure a Jira Issue as a "release blocker" (typically using labels). Whenever this release blocker is found the release to your production environment the release pipeline would bail over before continuing waiting for a human to resolve the release blocker ticket.
This Bitbucket Pipelines Pipe will query the provided JQL and/or Jira Filter (cloud only) and will block any and all deployments to the configured environments if Jira Issues are found as a result of the provided search.
Add the following snippet to the script section of your bitbucket-pipelines.yml file:
When referencing a Bitbucket Pipe via a repository reference <owner>/<repo>:<tag> this tells Bitbucket Pipelines to look at the relative pipe.yml within that repository for where to find the Pipe Docker image. This is best as this allows the DockerHub namespace to change over time if needed.
script:
- pipe: atlassian/jira-release-blocker:0.2.0
variables:
JIRA_JQL: "<string>"
JIRA_CLOUD_ID: "<string>"
JIRA_USERNAME: "<string>"
JIRA_API_TOKEN: $JIRA_API_TOKEN # DO NOT type value of api_token here, instead store as "secure" environment variable in pipelines settings
# JIRA_HOSTNAME: "<string>" # Optional, required if JIRA_CLOUD_ID not specifiedscript:
- pipe: docker://atlassianlabs/jira-release-blocker:0.2.0
variables:
JIRA_JQL: "<string>"
JIRA_CLOUD_ID: "<string>"
JIRA_USERNAME: "<string>"
JIRA_API_TOKEN: $JIRA_API_TOKEN # DO NOT type value of api_token here, instead store as "secure" environment variable in pipelines settings
# JIRA_HOSTNAME: "<string>" # Optional, required if JIRA_CLOUD_ID not specified| Variable | Usage |
|---|---|
| JIRA_JQL (*) | Jira Query Language (JQL) for executing a search against a Jira Instance. |
| JIRA_CLOUD_ID (1*) | Cloud ID of the Jira Site to execute a search against. |
| JIRA_HOSTNAME (1*) | Jira Hostname to use if Jira Cloud ID isn't specified. |
| JIRA_USERNAME (*) | Username of the user you want this pipe to query Jira with (remember project permissions). Typically the username/email used to log into the Atlassian Account (via id.atlassian.net) which has access to the Jira you want to query. |
| JIRA_API_TOKEN (***) | API Token associated with JIRA_USERNAME stored as a secure environment variable. |
| ALLOW_ROLLBACK_DEPLOYS | Boolean to opt rollback deploys into release blockers. Default: true |
| DEBUG | Turn on extra debug information. Default: false. |
(*) = required variable.
(***) = required secure environment variable.
(1*) = at least one of these variables is required.
There are a few options for execution in other CI/CD Platforms. The best method to verify that all nessecary files, dependency programs, and configurations are properly setup is to execute the Docker container that would be executed in Bitbucket Pipelines. The alternative is to setup all dependencies yourself and execute the shell script directly.
If the following returns an error code (non zero) abort the build with a "paused" or "failed" status.
docker run -e JIRA_USERNAME=${username} -e JIRA_API_TOKEN=${api_token} -e JIRA_JQL=<jql-search-string> -e JIRA_HOSTNAME=<my-instance>.atlassian.net atlassianlabs/jira-release-blocker:0.2.0If the following returns an error code (non zero) abort the build with a "paused" or "failed" status.
The benefit with this method is that there is no build dependency on docker, though most build images now adays contain docker runtimes as it is a commonly used containerization framework. Downsize is as dependencies and additional sources are added to jira-release-blocker release engineers will need to update their scripts to be compatible.
wget -P / https://bitbucket.org/atlassian/jira-release-blocker/raw/0.1.3/src/release-blocker.sh
wget -P / https://bitbucket.org/atlassian/jira-release-blocker/raw/0.1.3/src/url-encoding.sh
wget -P / https://bitbucket.org/bitbucketpipelines/bitbucket-pipes-toolkit-bash/raw/0.6.0/common.sh
chmod a+x ./*.sh
JIRA_USERNAME=${username} JIRA_API_TOKEN=${api_token} JIRA_JQL=<jql-search-string> JIRA_HOSTNAME=<my-instance>.atlassian.net ./release-blocker.shIf you'd like help with this pipe, or you have an issue or feature request, let us know. The pipe is maintained by Trevor Mack, tmack(at)atlassian.com.
If you're reporting an issue, please include:
- the version of the pipe
- relevant logs and error messages
- steps to reproduce
Contributions to Release Blockers are welcome! Please see CONTRIBUTING.md for details.
Copyright (c) [2020] Atlassian and others. Apache 2.0 licensed, see LICENSE file.
