Jira Issue Validator
Introduction
The Jira Issue Validator plugin extends the filtering capabilities of the Devtron CI and lets users perform validation based on Jira Ticket ID status. This plugin ensures that only builds associated with valid Jira tickets are executed, improving the accuracy of the CI process.
Prerequisites
A Jira account with the necessary API access.
The API credentials (username, password, and base URL) for your Jira instance. Obtain the API credentials from your Jira admin if required.
A pull request raised with your Git provider. Title of pull request must contain the Jira ID.
Jira Issue (e.g., REDOC-12)
Webhook added to the git repository. Click here to know more.
Steps
On the Edit build pipeline page, go to the Pre-Build Stage (or Post-Build Stage).
Click + Add task.
Select Jira Issue Validator from the list of plugins.
Enter a task name (mandatory).
Optionally, enter a description.
Provide values for the input variables.
VariableFormatDescriptionJiraUsername
String
Your Jira username (e.g., johndoe@devtron.ai)
JiraPassword
String
Your Jira API token provided by the Jira admin
JiraBaseUrl
String
The base URL of your Jira instance (e.g., https://yourdomain.atlassian.net)
Trigger/Skip Conditionallows you to set conditions under which this task will execute or be skipped.Pass/Failure Conditionallows you to define conditions that determine whether the build passes or fails based on Jira validation.
Go to the Build Stage.
Select Pull Request in the Source Type dropdown.
Use filters to fetch only the PRs matching your regex. Here are few examples:
Title can be a regex pattern (e.g.,
^(?P<jira_Id>([a-zA-Z0-9-].*))) to extract the Jira ID from the PR title. Only those PRs fulfilling the regex will be shown for image build process.State can be
^open$, where only PRs in open state will be shown for image build process.
Click Update Pipeline.
Results
Case 1: If Jira issue exists and the same is found in the PR title
Case 2: If Jira issue is not found
Last updated
Was this helpful?
