• Products
  • Documentation
  • Resources

Setup decisions necessary when connecting Jenkins to Jira Software Cloud

As you or your Jenkins admin set up a Jenkins server to connect to Jira, you’ll be given the option to enable the following two settings:

  • Send builds automatically

  • Send deployments automatically

Whether, and how, you should enable these settings depends on how your team uses Jenkins. Discuss your connection with your team, then use their answers to apply these settings:

Send build data automatically

This setting covers how Jenkins sends build events to Jira.

Based on how your team uses Jenkins, here’s what to select:


If your team:

  1. Wants Jenkins to send build updates to Jira every time it runs a pipeline.

  2. Has a consistent naming structure for build stages when writing Jenkinsfiles.

    • For example, if every build stage is called stage('build')

You or your Jenkins admin should:

  • Enable this option

  • Enter a regular expression filter matching your team’s build stage name structure

    • For example:

      • If every build stage is called stage('build')

      • Enter the regular expression ^build$


If your team:

  1. Want Jenkins to send build and deployment updates to Jira every time it runs a pipeline.

  2. Do not have a consistent naming structure for build stages when writing Jenkinsfiles.

You or your Jenkins admin should:

  • Enable this option

  • Leave the regular expression filter field empty


If your team:

  1. Want granular control of each pipeline that sends data to Jira

You or your Jenkins admin should:

  • Disable this option

Send deployment data automatically

This setting covers how Jenkins sends deployment events to Jira.

Based on how your team uses Jenkins, here’s what to tell your Jenkins admin:


If your team:

  1. Have a consistent naming structure for deployment stages when writing Jenkinsfiles.

    • For example, if every deployment stage is called stage('deploy to staging'), stage('deploy to prod'), and so on

  2. Want every pipeline to send deployment data to Jira

You or your Jenkins admin should:

  1. Enable this option

  2. Enter a regular expression filter matching the names your teams use for deployment stages

    • For example:

      • If every deployment stage is called stage('deploy to staging'), stage('deploy to prod'), and so on

      • Enter the regular expression ^deploy to (?<envName>.*)$

        • Use (?<envName>.*) in place of specific stage names like ‘staging' or ‘prod’ to let Jenkins extract environment names and display these in Jira


If your team:

  • Does not have a consistent naming structure for deployment stages when writing Jenkinsfiles, or

  • Want granular control of each pipeline that sends data to Jira

You or your Jenkins admin should:

  • Disable this option

 

Additional Help