Skip to content
Manage JenkinsSign in

Configure

General

Description
Plain textPreviewHide preview
?
Strategy
Days to keep builds
if not empty, build records are only kept up to this number of days
Max # of builds to keep
if not empty, only up to this number of build records are kept
Edited
Days to keep artifacts
if not empty, artifacts from builds older than this number of days will be deleted, but the logs, history, reports, etc for the build will be kept
Max # of builds to keep with artifacts
if not empty, only up to this number of builds have their artifacts retained
Remove last build?
?
Project url?
Edited
Display name?
GitLab Connection
Credential :
?
Custom Pipeline Speed/Durability Level
?
Keep this many of the most recent builds' stashes?
?
Boolean Parameter ?
Choice Parameter ?
Credentials Parameter ?
File Parameter ?
Multi-line String Parameter
Password Parameter ?
Run Parameter ?
String Parameter ?
?
Number of builds?
Time period?
?
Triggers
Set up automated actions that start your build based on specific events, like code changes or scheduled times.
?
Projects to watch
?
Schedule?
?
Enabled GitLab triggers
Push Events?
Push Events in case of branch delete?
Opened Merge Request Events?
Build only if new commits were pushed to Merge Request?
Accepted Merge Request Events?
Closed Merge Request Events?
Rebuild open Merge Requests?
Approved Merge Requests (EE-only)?
Comments?
Comment (regex) for triggering a build?
Edited
Enable [ci-skip]?
Ignore WIP Merge Requests?
Labels that launch a build if they are added (comma-separated)?
Set build description to build cause (eg. Merge request or Git Push)?
Build on successful pipeline events
Pending build name for pipeline?
Cancel pending merge request builds on update?
Allowed branches
?
?
Include
Exclude
?
Source Branch Regex
Target Branch Regex
Include
Exclude
Secret token?
?

Is triggered by HTTP requests to http://JENKINS_URL/generic-webhook-trigger/invoke

There are example configurations in the Git repository.

You can fiddle with JSONPath here. You may also want to checkout the syntax here.

You can fiddle with XPath here. You may also want to checkout the syntax here.

You can fiddle with regular expressions here. You may also want to checkout the syntax here.

If your job is not parameterized, then the resolved variables will just be contributed to the build. If your job is parameterized, and you resolve variables that have the same name as those parameters, then the plugin will populate the parameters when triggering job. That means you can, for example, use the parameters in combination with an SCM plugin, like GIT Plugin, to pick a branch.

Post content parameters
Variable
Name of variable
Expression
Expression to evaluate in POST content. Use JSONPath for JSON or XPath for XML.
Value filter
Optional. Anything in the evaluated value, matching this regular expression, will be removed. Having [^0-9] would only allow numbers. The regexp syntax is documented here.
Default value
Optional. This value will be used if expression does not match anything.
If you want value of param1 from post content { "param1": "value1" } to be contributed, you need to add $.param1 here.
Header parameters
Request header
Request header to be captured. The resulting variable name will be in lowercase and '-' will be replaced with '_' character.
Value filter
Optional. Anything in the evaluated value, matching this regular expression, will be removed. Having [^0-9] would only allow numbers. The regexp syntax is documented here.
If you want value of header param1 to be contributed, you need to add "param1" here.
Request parameters
Request parameter
Name of request parameter
Value filter
Optional. Anything in the evaluated value, matching this regular expression, will be removed. Having [^0-9] would only allow numbers. The regexp syntax is documented here.
If you want value of query parameter param1 to be contributed, you need to add "param1" here.
Token
Optional token. If it is specified then this job can only be triggered if that token is supplied when invoking http://JENKINS_URL/generic-webhook-trigger/invoke. It can be supplied as a:
  • Query parameter /invoke?token=TOKEN_HERE
  • A token header token: TOKEN_HERE
  • A Authorization: Bearer header Authorization: Bearer TOKEN_HERE
Token Credential
Same as token above, but configured with a secret text credential.
Cause
This will be displayed in any triggered job. You can use the variables here to create a custom cause like "$name committed to $branch", if you have configured variables named name and branch.
Override Quiet Period
Allow the trigger to override this job's quiet period. If selected you can you can provide a quiet period (an integer number of seconds) and the build will use that quiet period instead of its default. If this is selected and no quiet period is given the job's quiet period will still be used. It can be supplied as a:
  • Query Parameter /invoke?jobQuietPeriod=QUIET_PERIOD_HERE
  • A quiet period header jobQuietPeriod: QUIET_PERIOD_HERE
Allow several triggers per build
If checked, the plugin will allow one build to have several triggers. If not checked, the plugin will trigger exactly one job when invoked.
Silent response
Avoid responding with information about triggered jobs.
Avoid flattening branches
Avoid flattening any selected branch. If the selected node is a branch, not a leaf, the plugin will, by default, flatten its content and create variables for each leaf on that branch.
Print post content
Print post content in job log.
Print contributed variables
Print contributed variables in job log.
Optional filter
Expression
Regular expression to test on the evaluated text specified below. The regexp syntax is documented here.
Text
Text to test for the given expression. You can use any combination of the variables you configured above.
This is an optional feature. If specified, this job will only trigger when given expression matches given text.
?
?
Schedule?
?
?
Authentication Token
Concealed
Use the following URL to trigger build remotely: JENKINS_URL/view/all/job/garasiku-deploy/build?token=TOKEN_NAME or /buildWithParameters?token=TOKEN_NAME
Optionally append &cause=Cause+Text to provide text that will be included in the recorded build cause.
Pipeline
Define your Pipeline using Groovy directly or pull it from source control.
Definition
SCM ?
?
Repositories?
Repository URL?
Credentials?
Edited
Name?
Refspec?
Repository URL?
Credentials?
Edited
Name?
Refspec?
Branches to build?
Branch Specifier (blank for 'any')?
Branch Specifier (blank for 'any')?
Branch Specifier (blank for 'any')?
Branch Specifier (blank for 'any')?
Repository browser ?
Additional Behaviours
Additional refSpecs to fetch in case of clone links.
Advanced checkout behaviours
Advanced clone behaviours
Advanced sub-modules behaviours
Build single revision only ?
Calculate changelog against a specific branch ?
Check out to a sub-directory
Check out to specific local branch ?
Clean after checkout ?
Clean before checkout ?
Contribute additional environment variables about the target branch.
Create a tag for every build ?
Custom SCM name ?
Custom user name/e-mail address
Don't trigger a build on commit notifications ?
First build changelog ?
Force polling using workspace ?
Git LFS pull after checkout ?
Merge before build ?
Polling ignores commits from certain users
Polling ignores commits in certain paths ?
Polling ignores commits with certain messages
Prune stale remote-tracking branches ?
Prune stale tags
Sparse Checkout paths ?
Strategy for choosing what to build ?
Translated git client credentials.
Use commit author in changelog ?
Wipe out repository & force clone ?
Script Path?
Lightweight checkout?
Advanced
Edited
?
Quiet period
Number of seconds
Display Name?