More about jiraAddWatcher step.

Overview

This step adds a user as watcher to a particular issue.

Input

  • idOrKey - Issue id or key.
  • userName - username of the person who should be added as a watcher.
  • site - Optional, default: JIRA_SITE environment variable.
  • failOnError - Optional. default: true.

Note: It supports all the fields that any jira instance supports including custom fields. For more information about all available input fields, please refer to the JIRA Api documentation depending on your JIRA version.

Output

  • Each step generates generic output, please refer to this link for more information.
  • The api response of this jira_add_watcher 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.

Note: response.data returns all the fields returned by JIRA API.

Examples:

  • With default site from global variables.

    node {
  stage('JIRA') {
    jiraAddWatcher idOrKey: 'TEST-1', userName: 'Jenkins'
  }
}

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

    node {
  stage('JIRA') {
    withEnv(['JIRA_SITE=LOCAL']) {
      jiraAddWatcher idOrKey: 'TEST-1', userName: 'Jenkins'
    }
  }
}

  • Without environment variables.

      jiraAddWatcher site: 'LOCAL', idOrKey: 'TEST-1', userName: 'Jenkins'
Tags: steps