EditComment

jiraEditComment

This step updates a particular comment on particular issue.

Input

• idOrKey - Issue id or key.
• commentId - comment id.
• input - comment, supports jira wiki formatting.
• site - Optional, default: JIRA_SITE environment variable.
• failOnError - Optional. default: true.
• Deprecated: comment - comment, supports jira wiki formatting.

Output

• Each step generates generic output, please refer to this link for more information.
• The api response of this jira_edit_comment 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 comment = [ body: 'test comment' ]
      jiraEditComment idOrKey: 'TEST-1', commentId: '1000', input: comment
    }
  }
  

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

  node {
    stage('JIRA') {
      withEnv(['JIRA_SITE=LOCAL']) {
        def comment = [ body: 'test comment' ]
        jiraEditComment idOrKey: 'TEST-1', commentId: '1000', input: comment
      }
    }
  }
  

• Without environment variables.

    def comment = [ body: 'test comment' ]
    jiraEditComment site: 'LOCAL', idOrKey: 'TEST-1', commentId: '1000', input: comment
  

• With limited visibility.

    def comment = [ 
      body: 'test comment',
      visibility: [ 
        type: 'role', 
        value: 'Developer'
      ]
    ]
    jiraEditComment site: 'LOCAL', idOrKey: 'TEST-1', commentId: '1000', input: comment
  

• Deprecated.

    jiraEditComment site: 'LOCAL', idOrKey: 'TEST-1', commentId: '1000', comment: 'test comment'