EditComponent

jiraEditComponent

Edit component based on given input, which should have some minimal information on that object.

Input

• id - component id. (Note: Applicable only from version 1.3.0)
• component - component to be edited.
• site - Optional, default: JIRA_SITE environment variable.
• failOnError - Optional. default: true.
• auditLog - Optional. default: true. Append the build url and build user name to the description.

Output

• Each step generates generic output, please refer to this link for more information.
• The api response of this jira_edit_component 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 testComponent = [ name: "test-component",
                            description: "desc",
                            project: "TEST" ]
      jiraEditComponent id: "1000", component: testComponent
    }
  }
  

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

  node {
    stage('JIRA') {
      withEnv(['JIRA_SITE=LOCAL']) {
        def testComponent = [ name: "test-component",
                              description: "desc",
                              project: "TEST" ]
        jiraEditComponent id: "1000", component: testComponent
      }
    }
  }
  

• Without environment variables.

  def testComponent = [ name: "test-component",
                        description: "desc",
                        project: "TEST" ]
  jiraEditComponent id: "1000", site: "LOCAL", component: testComponent