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.
githubNotify: Notifies GitHub of the status of a Pull RequestThe githubNotify step gives full controll to pipelines about the commit status
You can check the oficial GitHub's documentation about statutes here
status
PENDING, SUCCESS, ERROR, FAILUREdescription : String
The notification description, it will be displayed by GitHub
You can check the oficial GitHub's documentation here
account : String (optional)
The GitHub account that owns the repos that contains the commit to notify
You can check the oficial GitHub's documentation here
context : String (optional)
The Notification key, keys are used by GitHub to diferentiate between notifications, two notification with the same key are meant to be the same
You can check the oficial GitHub's documentation here
credentialsId : String (optional)
The GitHub credentials, username/password or username/accessToken
gitApiUrl : String (optional)
If you are a user of GitHub Enterprise use this field to set your custom API endpoint
repo : String (optional)
The GitHub repository that contains the commit to validate, must be owned by the user specified in the account field
You can check the oficial GitHub's documentation here
sha : String (optional)
The SHA that identifies the commit to notify
You can check the oficial GitHub's documentation here
targetUrl : String (optional)
Use this field to specify a custom target URL for the notification, if not specified the build's URL will be used
You can check the oficial GitHub's documentation here
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.