Issue
- I have a pipeline which uses a feature of the Github plugin which forces a workspace (like “ignore certain users”, etc) but would like to not require a workspace
- I have a pipeline which I would like to custom trigger based on certain conditions from a Github Webhook
Environment
- CloudBees Core
- CloudBees Core on modern cloud platforms - Managed Master
- CloudBees Core on modern cloud platforms - Operations Center
- CloudBees Core on traditional platforms - Client Master
- CloudBees Core on traditional platforms - Operations Center
- CloudBees Jenkins Enterprise
- CloudBees Jenkins Enterprise - Managed Master
- CloudBees Jenkins Enterprise - Operations Center
- CloudBees Jenkins Team
- CloudBees Jenkins Platform - Client Master
- CloudBees Jenkins Platform - Operations Center
- Github Plugin
Resolution
You will need to do some pre-setup before this will work.
The pre-setup consists of first installing 4 plugins on all the masters you want to trigger this way:
The external notification plugin will give you the ability to have a new screen under Manage Jenkins -> Manage Notification Webhook HTTP Endpoints which allows you to configure new webhook endpoints. The Notification API provides the ability to configure multiple event types under that screen and to enable the trigger(combined with the OC notification plugin). Finally the Pipeline event step creates the API used in the pipeline.
To correctly set this up after installing those plugins, is to follow this procedure:
1. Allow webhooks by going to Manage Jenkins > Configure Notification and checking the Allow box
2. Create a new webhook location by going to Manage Jenkins > Manage Notification Webhook HTTP Endpoints and hit the Create New Endpoint button
3. Adjust that webhook to use github and generate a new secret
3. Configure a new webhook(under Settings> Webhooks) on a github repo to hit that newly created endpoint(Payload URL) with the secret
4. Add an eventTrigger step to your pipeline which will do the json parsing you want. Below is an example pipeline:
pipeline {
agent any
triggers {
eventTrigger jmespathQuery("repository.name=='REPO_NAME'&&head_commit.author.username!='test_account'")
}
stages {
stage('Example') {
steps {
echo 'received Webhook'
}
}
}
}
The above is for a declarative pipelines and if you want to use scripted then properties([pipelineTriggers([eventTrigger(jmespathQuery("repository.name=='REPO_NAME'&&head_commit.author.username!='test_account'"))])])
The JQ command I am doing there is matching the repo name(REPO_NAME) and ensuring the last commit was not written by test_account. The full Webhook API for github can be found here for what will be included in that json file and can be parsed with JQ
0 Comments