NotifyIssue

jiraNotifyIssue

This step notifies users (like watchers, assignee and so on..) of a particular issue.

Input

• idOrKey - Issue id or key.
• notify - more info about whom should we notify and so on.
• site - Optional, default: JIRA_SITE environment variable.
• failOnError - Optional. default: true.

Output

• Each step generates generic output, please refer to this link for more information.
• The api response of this jira_notify_issue step can be reused later in your script by doing response.data.required_field_name.
• You can see some example scenarios here
• All the available fields for a jira response can be found in JIRA API documentation depending on your JIRA version.

Examples

• With default site from global variables.

  node {
    stage('JIRA') {
      def notify = [ subject: 'Update about TEST-01',
                     textBody: 'Just wanted to update about this issue...',
                     htmlBody: 'Just wanted to update about this issue...',
                     to: [ reporter: true,
                           assignee: true,
                           watchers: false,
                           voters: false,
                           users: [{
                                    name: 'rao'
                                  },
                                  {
                                    name: 'naresh'
                                  }]
                        ]
                    ]
      jiraNotifyIssue idOrKey: 'TEST-1', notify: notify
    }
  }
  

• withEnv to override the default site (or if there is not global site)

  node {
    stage('JIRA') {
      withEnv(['JIRA_SITE=LOCAL']) {
        def notify = [ subject: 'Update about TEST-01',
                       textBody: 'Just wanted to update about this issue...',
                       htmlBody: 'Just wanted to update about this issue...',
                       to: [ reporter: true,
                             assignee: true,
                             watchers: false,
                             voters: false,
                             users: [{
                                      name: 'rao'
                                    },
                                    {
                                      name: 'naresh'
                                    }]
                          ]
                      ]
        jiraNotifyIssue idOrKey: 'TEST-1', notify: notify
      }
    }
  }
  

• Without environment variables.

  def notify = [ subject: 'Update about TEST-01',
                 textBody: 'Just wanted to update about this issue...',
                 htmlBody: 'Just wanted to update about this issue...',
                 to: [ reporter: true,
                       assignee: true,
                       watchers: false,
                       voters: false,
                       users: [{
                                name: 'rao'
                              },
                              {
                                name: 'naresh'
                              }]
                     ]
                ]
  jiraNotifyIssue idOrKey: 'TEST-1', notify: notify, site: 'LOCAL'