Configuring the Jira Plugin

Overview 

Edit Jira Configuration

Before using the Jira plugin, the Jira configuration must be updated in the Flow config file.

Edit /etc/continuum/flow.yaml. Edit the file so that it reads as follows. If there are already entries in the file add jiraplugin before or after. The Jira section must be indented as in the example below.

plugins:
    jiraplugin:
        user: tomthumb
        password: thepassword
        url: https://jiraserver.mycompany.net

Enter the url of the Jira server where you would normally log in. The port should be included unless it is port 80/443. Make sure http or https is set properly.

To have the config changes take effect, restart the Flow processes.

ctm-restart-services

Using the Jira Plugin, Passing in the Issue Id

Once Jira has been configued in the flow.yaml file and the services restarted, the Jira plugin will display in the Stage editor. You can either create a new Stage and add a step that uses the Jira plugin "issue.get_issue" function or add the Jira function to an existing Stage.

There are two ways to use the Jira plugin. The first is to pass in the Jira issue id as an argument in the plugin's arguments box. The syntax would be as follows.

{
    "issue": "PET-103"
}

Parameters and Variable Data

Another example Arguments using the Jira plugin with data that may be passed into the pipeline:

{
    "issue": {
        "Ref": "jira_issue"
    }
}

The Ref syntax will perform a substitution in place from the data passed in when the pipeline instance was created. In this case we are passing in a value for jira_issue which will be stored as data with the Pipeline Instance.

ctm-initiate-pipeline -p "Test Jira" -s "test" -d '{"jira_issue" : "PET-103"}'

Determining the Issue from Git Webhook, Alternative Method

The second way of determining the Jira issue id is based on Git Webhook information. If the issue parameter is not used in the arguments box, the pipeline instance data will be searched for a Git Ref id. It will then strip off the first 11 characters to get the branch name. The plugin will then assume that the branch matches the story / issue id in Jira.

For instance, if the pipeline was triggered by a Git Webhook, the data would contain the following.

refs/heads/PET-103

The logic would get the PET-103 branch name and attempt to match with that a Jira story.

Running the Plugin

As previously mentioned, currently the Jira plugin simply pulls the Jira issue information into Flow for reporting purposes. This would typically be done in an early phase of a pipeline. Future revisions may update issue tickets with status or logging information. Contact support@versionone.com to request specific features.