More about jiraNewRemoteIssueLink step.

Overview

This step creates a new remote link to a particular issue.

Input

  • idOrKey - issue id or key.
  • remoteLink - remote link.
  • 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_new_remote_issuelinks 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') {
    def remoteLink =  [globalId: "system=http://www.mycompany.com/support&id=1",
                       application: [type: "com.acme.tracker",
                                     name: "My Acme Tracker"],
                       relationship: "causes",
                       object: [url: "http://www.mycompany.com/support?id=1",
                                title: "MYTEST-111"]]

    def issueLink = jiraNewRemoteIssueLink idOrKey: 'TEST-27', remoteLink: remoteLink
    echo issueLink.data.toString()
  }
}

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

    node {
  stage('JIRA') {
    withEnv(['JIRA_SITE=LOCAL']) {
      def remoteLink =  [globalId: "system=http://www.mycompany.com/support&id=1",
                         application: [type: "com.acme.tracker",
                                       name: "My Acme Tracker"],
                         relationship: "causes",
                         object: [url: "http://www.mycompany.com/support?id=1",
                                  title: "MYTEST-111"]]

      def issueLink = jiraNewRemoteIssueLink idOrKey: 'TEST-27', remoteLink: remoteLink
      echo issueLink.data.toString()
    }
  }
}

  • Without environment variables.

    def remoteLink =  [globalId: "system=http://www.mycompany.com/support&id=1",
                   application: [type: "com.acme.tracker",
                                 name: "My Acme Tracker"],
                   relationship: "causes",
                   object: [url: "http://www.mycompany.com/support?id=1",
                            title: "MYTEST-111"]]

def issueLink = jiraNewRemoteIssueLink idOrKey: 'TEST-27', remoteLink: remoteLink, site: 'LOCAL', failOnError: false
echo issueLink.data.toString()
Tags: steps