> 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 Status Wrapper Plugin

View this plugin on the Plugins site

gitStatusWrapper: gitStatusWrapper

The gitStatusWrapper step wraps a block of commands and handles PENDING/SUCCESS/FAILURE git statuses automatically

Check documentation here

  • account (optional)

    The GitHub account that owns the repos that contains the commit to notify

    Default: If SCM used, plugin will attempt to get details from SCM execution

    Check documentation here

    • Type: String
  • credentialsId (optional)

    The GitHub credentials, username/password or username/accessToken

    • Type: String
  • description (optional)

    The notification description, it will be displayed by GitHub

    Default: ""

    Check documentation here

    • Type: String
  • failureDescription (optional)

    The notification description for a failure, it will be displayed by GitHub

    Default: value set to description

    This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"

    Check documentation here

    • Type: String
  • gitApiUrl (optional)

    If you are a user of GitHub Enterprise use this field to set your custom API endpoint

    Default: https://api.github.com

    • Type: String
  • gitHubContext (optional)

    The git status context key. Keys are used by GitHub to differentiate between notifications

    Default: gitStatusWrapper

    Check documentation here

    • Type: String
  • repo (optional)

    The GitHub repository that contains the commit to validate, must be owned by the user specified in the account field

    Default: If SCM used, plugin will attempt to get details from SCM execution

    Check documentation here

    • Type: String
  • sha (optional)

    The SHA that identifies the commit to notify

    Default: If SCM used, plugin will attempt to get details from SCM execution

    Check documentation here

    • Type: String
  • successDescription (optional)

    The notification description for a success, it will be displayed by GitHub

    Default: value set to description

    This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"

    Check documentation here

    • Type: String
  • targetUrl (optional)

    Use this field to specify a custom target URL for the notification

    Default: Jenkins build URL

    Check documentation here

    • 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.