The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Jira plugin

View this plugin on the Plugins site

jiraComment: Jira: Add a comment to issue(s)

  • issueKey : String
  • body : String

jiraIssueSelector: Jira: Issue selector

  • issueSelector (optional)
      Nested Choice of Objects
    • $class: 'DefaultIssueSelector'
      • $class: 'ExplicitIssueSelector'
        • issueKeys : String
      • $class: 'JqlIssueSelector'
        • jql : String
      • $class: 'P4JobIssueSelector'

      jiraSearch: Jira: Search issues

      • jql : String

      step([$class: 'IssueFieldUpdateStep']): Jira: Issue custom field updater

      JiraIssueFieldUpdater can be used to update custom Jira issue field.
      • issueSelector (optional)
          Nested Choice of Objects
        • $class: 'DefaultIssueSelector'
          • $class: 'ExplicitIssueSelector'
            • issueKeys : String
          • $class: 'JqlIssueSelector'
            • jql : String
          • $class: 'P4JobIssueSelector'
          • fieldId : String (optional)
          • fieldValue : String (optional)

          step([$class: 'JiraIssueUpdateBuilder']): Jira: Progress issues by workflow action

          Performs a Jira workflow action for every issue that matches the JQL query. A common use might be to consider a ticket "confirmed" in the last build step of a job, or to mark an issue as "merged" if the job is used to merge changes from one SCM repository to another.

          Optionally, include a comment that will be attached to those tickets that are modified as a result of this build step.
          • jqlSearch : String
            Issues which match this JQL Query will be progressed using the specified workflow action.

            This can contain $PARAM values which will be replaced by the build parameters.

            Example:

            project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
            or (e.g., combined with a Jira Issue Parameter, selecting one issue from a JQL result set): 
            issue = $ISSUE_ID

          • workflowActionName : String
            The workflow action to be performed on the selected Jira issues.

            Be mindful of the issues being selected by the JQL query, because not all actions are valid for all issue statuses.

            NOTE: the Jenkins user must have access to perform the workflow step, as if the user were logged in and viewing the issue in a web browser.
          • comment : String
            An optional comment to be added to the issue after updating the workflow. If left empty, no comment will be added.

            This can contain $PARAM values which will be replaced by the build parameters.

          wrap([$class: 'JiraCreateReleaseNotes']): Generate Release Notes

          • jiraProjectKey : String

            Specify Jira project key. A project key is the all capitals part before the issue number in Jira.

            (EXAMPLE-100)

          • jiraRelease : String

            Specify the name of the parameter which will contain the release version. This can reference a build parameter.

          • jiraEnvironmentVariable : String

            Specify the environment variable to which the release notes will be stored, defaults to RELEASE_NOTES.

            This can be used in another build step which supports environments.

          • jiraFilter : String

            Apply additional filtering criteria to the issue filter. This will be concatenated with an AND operator.

            Defaults To:

            status in (Released, Closed)

          Was this page helpful?

          Please submit your feedback about this page through this quick form.

          Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

              


          See existing feedback here.