JIRA Trigger Plugin

This plugin is published through the Jenkins official plugin center.

Please consider starring the project to show your ❤️ and support.

Features

Triggers a build when a comment is added to JIRA
Triggers a build when an issue is updated in JIRA
Transforms JIRA Webhook POST data to Jenkins parameters
Transforms JIRA standard custom fields to Jenkins parameters (See CustomFieldParameterResolverTest for the full list of supported custom field types)
Reply back to JIRA for scheduled builds
Sets JIRA information as environment variables to the triggered build

This plugin has been tested against JIRA 7.0.0, although theoretically it should work with older version of JIRA as long as it supports the webhook type required (see Setup section below).

Check src/test/groovy/*AcceptanceTest to see how these features are expected to behave.

Getting help

Go to Troubleshooting section for commonly faced problems.
Generic questions (how to, etc), ask a question at stackoverflow with jenkins-jira-trigger tag.
Ideas or bugs, file an issue to JENKINS issue tracker with jira-trigger-plugin component.

Setup

Add new JIRA webhook (One time)

Go to JIRA > Cog > System > Advanced > WebHooks (Requires admin permission)
Create a new Webhook
Set URL to: ${Jenkins URL}/jira-trigger-webhook-receiver/ e.g. http://localhost:8080/jenkins/jira-trigger-webhook-receiver/
Enable issue updated event
If you are on JIRA Cloud, enable comment created event
Do not check Exclude body as this plugin requires the JSON to operate
Save!

Jenkins global configuration (One time)

This configuration is crucial, especially for JQL filter usage.

Go to Jenkins global configuration (${Jenkins URL}/configure)
Configure JIRA Trigger Configuration

Job configuration

New triggers will be made available after you have successfully install this plugin from Jenkins plugin center. More in depth documentation about how you can configure the job are documented in the help files. Be sure to hit those question mark buttons in Jenkins configuration page!

The configuration of Pipeline jobs are located in the job configuration page as well and not the Jenkinsfile, as per the screenshot shown below. The new triggers will come up next to the "Build periodically" trigger.

If you are creating a new Pipeline job, you'll have to reconfigure the job and save it again before the job can be triggered properly. This is currently a known issue.

Comment trigger

Changelog trigger

Environment variables

JIRA Trigger Plugin sets environment variables you can use during the build:

JIRA_ISSUE_KEY - The JIRA issue key that triggers the build

Troubleshooting

Build is not triggered

Firstly, enable Jenkins logging at FINE level for troubleshooting: com.ceilfors.jenkins.plugins.jiratrigger.webhook. You should see "Received Webhook callback ..." log messages when Jenkins is receiving webhook events from JIRA.

If you are not seeing anything in the log, your problem will either be in JIRA configuration or the network connectivity in between JIRA and Jenkins:

Make Webhook configuration more lenient for testing:
- Remove JQL configuration in JIRA Webhook page if you configure one
- Try to update an issue again and check if you are getting the logs now. If not, you might have network connectivity problem, proceed below.
If using JIRA Cloud:
- Your Jenkins must be hosted with 80 or 443 port
If you own JIRA Server:
- SSH to JIRA machine.
- Try to cURL Jenkins URL and make sure that you can get a response back.
- If you are getting a timeout, your firewall rule might be blocking JIRA Webhook events to be sent to Jenkins. You'll need to fix this for this plugin to work.

If you are seeing "Received Webhook callback ..." but your build is not triggered, your configuration for this plugin in Jenkins might be too restrictive, please double check.

Building Project

To build, run acceptance test, and release commands, refer to this document

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Pavel Zaikin}
💻

_{Craig Rodrigues}
💻

_{Steve Hill}
💻

_{Denys Digtiar}
💻

This project follows the all-contributors specification. Contributions of any kind welcome!

web-logs2 / jira-trigger-plugin Goto Github PK