> User Documentation Home

User Handbook
Tutorials
Resources

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.

GitHub Integration Plugin

View this plugin on the Plugins site

setGitHubPullRequestStatus: Set GitHub PullRequest Commit Status

Sets the commit status of the commit that triggered a pull request build. Note that this step can only be used by builds that were triggered by a pull request.
  • context (optional)
    A string label to differentiate this status from the status of other systems.
    • Type: String
  • message (optional)
    A short detail message to add to the status
    • Type: String
  • state (optional)
    State of the status indicating the progress or completion of the check.
    • Values: PENDING, SUCCESS, ERROR, FAILURE

githubPRStatusPublisher: GitHub PR: set PR status

  • statusMsg
    Description message for GitHub status.
      Nested Object
    • content
      Message content that will be posted. Support core variable expansion i.e. ${WORKSPACE}.
      If token-macro plugin enabled, then support token expansion.
      If email-ext plugin enabled, then support expanding groovy templates with ${SCRIPT, path="template.groovy"}.
      • Type: String
  • unstableAs
    • Values: PENDING, SUCCESS, ERROR, FAILURE
  • buildMessage
      Nested Object
    • successMsg
        Nested Object
      • content
        Message content that will be posted. Support core variable expansion i.e. ${WORKSPACE}.
        If token-macro plugin enabled, then support token expansion.
        If email-ext plugin enabled, then support expanding groovy templates with ${SCRIPT, path="template.groovy"}.
        • Type: String
    • failureMsg
        Nested Object
      • content
        Message content that will be posted. Support core variable expansion i.e. ${WORKSPACE}.
        If token-macro plugin enabled, then support token expansion.
        If email-ext plugin enabled, then support expanding groovy templates with ${SCRIPT, path="template.groovy"}.
        • Type: String
  • statusVerifier
      Nested Object
    • buildStatus
      • Type: String
  • errorHandler
      Nested Object
    • buildStatus
      • Type: String

githubPRClosePublisher: GitHub PR: close PR

  • statusVerifier
      Nested Object
    • buildStatus
      • Type: String
  • errorHandler
      Nested Object
    • buildStatus
      • Type: String

githubPRComment: GitHub PR: post comment

  • comment
      Nested Object
    • content
      Message content that will be posted. Support core variable expansion i.e. ${WORKSPACE}.
      If token-macro plugin enabled, then support token expansion.
      If email-ext plugin enabled, then support expanding groovy templates with ${SCRIPT, path="template.groovy"}.
      • Type: String
  • statusVerifier
      Nested Object
    • buildStatus
      • Type: String
  • errorHandler
      Nested Object
    • buildStatus
      • Type: String

githubPRAddLabels: GitHub PR: add labels

  • labelProperty
      Nested Object
      Help page for GitHubPRLabel class. Not used anywhere?
    • labels

      Every new label on new line

      • Type: String
  • statusVerifier
      Nested Object
    • buildStatus
      • Type: String
  • errorHandler
      Nested Object
    • buildStatus
      • Type: String

githubPRRemoveLabels: GitHub PR: remove labels

  • labelProperty
      Nested Object
      Help page for GitHubPRLabel class. Not used anywhere?
    • labels

      Every new label on new line

      • Type: String
  • statusVerifier
      Nested Object
    • buildStatus
      • Type: String
  • errorHandler
      Nested Object
    • buildStatus
      • Type: String

gitHubPRStatus: GitHub PR: set 'pending' status

  • statusMessage
      Nested Object
    • content
      Message content that will be posted. Support core variable expansion i.e. ${WORKSPACE}.
      If token-macro plugin enabled, then support token expansion.
      If email-ext plugin enabled, then support expanding groovy templates with ${SCRIPT, path="template.groovy"}.
      • Type: String

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.