.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "JENKINS-JOBS" "1" "Mar 31, 2023" "3.11.0" "Jenkins Job Builder"
.SH NAME
jenkins-jobs \- Jenkins Job Builder Documentation
.sp
Jenkins Job Builder takes simple descriptions of \fI\%Jenkins\fP jobs in \fI\%YAML\fP or \fI\%JSON\fP
format and uses them to configure Jenkins. You can keep your job descriptions in
human readable text format in a version control system to make changes and
auditing easier. It also has a flexible template system, so creating many
similarly configured jobs is easy.
.sp
To install:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ pip install \-\-user jenkins\-job\-builder
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Online documentation:
.INDENT 0.0
.IP \(bu 2
\fI\%https://jenkins\-job\-builder.readthedocs.io/en/latest/\fP
.UNINDENT
.SH DEVELOPERS
.sp
Bug report:
.INDENT 0.0
.IP \(bu 2
\fI\%https://storyboard.openstack.org/#!/project/723\fP
.UNINDENT
.sp
Repository:
.INDENT 0.0
.IP \(bu 2
\fI\%https://opendev.org/jjb/jenkins\-job\-builder\fP
.UNINDENT
.sp
Cloning:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
git clone https://opendev.org/jjb/jenkins\-job\-builder.git
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Install pre\-commit from \fI\%https://pre\-commit.com/#intro\fP in order to run some
minimal testing on your commits.
.sp
A virtual environment is recommended for development.  For example, Jenkins
Job Builder may be installed from the top level directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ virtualenv .venv
$ source .venv/bin/activate
$ pip install \-r test\-requirements.txt \-e .
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Patches are submitted via Gerrit at:
.INDENT 0.0
.IP \(bu 2
\fI\%https://review.opendev.org\fP
.UNINDENT
.sp
Please do not submit GitHub pull requests, they will be automatically closed.
.sp
Mailing list:
.INDENT 0.0
.IP \(bu 2
\fI\%https://groups.google.com/forum/#!forum/jenkins\-job\-builder\fP
.UNINDENT
.sp
IRC:
.INDENT 0.0
.IP \(bu 2
\fB#openstack\-jjb\fP on OFTC
.UNINDENT
.sp
More details on how you can contribute is available on our wiki at:
.INDENT 0.0
.IP \(bu 2
\fI\%https://docs.openstack.org/infra/manual/developers.html\fP
.UNINDENT
.SH WRITING A PATCH
.sp
We ask that all code submissions be \fI\%pep8\fP and \fI\%pyflakes\fP clean.  The
easiest way to do that is to run \fI\%tox\fP before submitting code for
review in Gerrit.  It will run \fBpep8\fP and \fBpyflakes\fP in the same
manner as the automated test suite that will run on proposed
patchsets.
.sp
When creating new YAML components, please observe the following style
conventions:
.INDENT 0.0
.IP \(bu 2
All YAML identifiers (including component names and arguments)
should be lower\-case and multiple word identifiers should use
hyphens.  E.g., \(dqbuild\-trigger\(dq.
.IP \(bu 2
The Python functions that implement components should have the same
name as the YAML keyword, but should use underscores instead of
hyphens. E.g., \(dqbuild_trigger\(dq.
.UNINDENT
.sp
This consistency will help users avoid simple mistakes when writing
YAML, as well as developers when matching YAML components to Python
implementation.
.SH UNIT TESTS
.sp
Unit tests have been included and are in the \fBtests\fP folder. Many unit
tests samples are included as examples in our documentation to ensure that
examples are kept current with existing behaviour. To run the unit tests,
execute the command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tox \-e py34,py27
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
Note: View \fBtox.ini\fP to run tests on other versions of Python,
generating the documentation and additionally for any special notes
on running the test to validate documentation external URLs from behind
proxies.
.UNINDENT
.SH INSTALLING WITHOUT SETUP.PY
.sp
For YAML support, you will need \fI\%libyaml\fP installed.
.sp
Mac OS X:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ brew install libyaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then install the required python packages using \fI\%pip\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ sudo pip install PyYAML python\-jenkins
.ft P
.fi
.UNINDENT
.UNINDENT
.SH QUICK START GUIDE
.sp
This guide was made with the impatient in mind so explanation is sparse.
It will guide users through a set of typical use cases for JJB using the same
job definitions we use to test JJB.
.INDENT 0.0
.IP 1. 3
Clone the \fI\%repository\fP to get the JJB job definition \fI\%examples\fP
.IP 2. 3
The \fI\%Installation\fP can be either from \fI\%pypi\fP (released version) or from the clone (master).
.UNINDENT
.sp
Usage of the commands below assumes that you are at the root of the cloned directory.
.SS Use Case 1: Test a job definition
.sp
JJB creates Jenkins XML configuration file from a YAML/JSON definition file and
just uploads it to Jenkins.  JJB provides a convenient \fBtest\fP command to allow
you to validate the XML before you attempt to upload it to Jenkins.
.sp
Test a YAML job definition:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs test tests/yamlparser/fixtures/templates002.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above command prints the generated Jenkins XML to the console.  If you
prefer to send it to a directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs test \-o output tests/yamlparser/fixtures/templates002.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fIoutput\fP directory will contain files with the XML configurations.
.SS Use Case 2: Updating Jenkins Jobs
.sp
Once you\(aqve tested your job definition and are happy with it then you can use the
\fBupdate\fP command to deploy the job to Jenkins.  The \fBupdate\fP command requires a
configuration file.  An example file is supplied in the etc folder, you should
update it to match your Jenkins master:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs \-\-conf etc/jenkins_jobs.ini\-sample update tests/yamlparser/fixtures/templates002.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above command will update your Jenkins master with the generated jobs.
.sp
\fBCaution\fP: JJB caches Jenkins job information locally.  Changes
made using the Jenkins UI will not update that cache, which may
lead to confusion.  See \fI\%Updating Jobs\fP for more information.
.SS Use Case 3: Working with JSON job definitions
.sp
You can also define your jobs in json instead of yaml:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs \-\-conf etc/jenkins_jobs.ini\-sample update tests/jsonparser/fixtures/simple.json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above command just uses a simple job definition.  You can also convert any
of the YAML examples to JSON and feed that to JJB.
.SS Use Case 4: Deleting a job
.sp
To delete a job:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs \-\-conf etc/jenkins_jobs.ini\-sample delete simple
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above command deletes the job \fIsimple\fP from the Jenkins master.
.SS Use Case 5: Providing plugins info
.sp
To generate a plugins info, using an account with Administrator rights:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs get\-plugins\-info \-o plugins_info.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To run JJB update using the plugins_info.yaml:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs update \-p plugins_info.yaml ./myjobs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Please refer to the jenkins\-jobs \fI\%Command Reference\fP and the
\fI\%Job Definitions\fP pages for more details.
.SH INSTALLATION
.sp
To install Jenkins Job Builder from source, run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
pip install \-\-user jenkins\-job\-builder
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A virtual environment is recommended for development.  For example, Jenkins
Job Builder may be installed from the top level directory:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ virtualenv .venv
$ source .venv/bin/activate
$ pip install \-r test\-requirements.txt \-e .
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternatively, the current release can be installed from pypi:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo pip install jenkins\-job\-builder
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The OpenStack project uses Puppet to manage its infrastructure
systems, including Jenkins.  If you use Puppet, you can use the
\fI\%OpenStack Jenkins module\fP to install Jenkins Job Builder.
.SS Documentation
.sp
Documentation is included in the \fBdoc\fP folder. To generate docs
locally execute the command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tox \-e docs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The generated documentation is then available under
\fBdoc/build/html/index.html\fP\&.
.sp
As over time URLs change or become stale there is also a testenv available
to verify any links added. To run locally execute the command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tox \-e docs\-linkcheck
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
Note: When behind a proxy it is necessary to use \fBTOX_TESTENV_PASSENV\fP
to pass any proxy settings for this test to be able to check links are
valid.
.UNINDENT
.SS Unit Tests
.sp
Unit tests have been included and are in the \fBtests\fP folder.  We recently
started including unit tests as examples in our documentation so to keep the
examples up to date it is very important that we include unit tests for
every module.  To run the unit tests, execute the command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tox \-e py27
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
Note: View \fBtox.ini\fP to run tests on other versions of Python.
.UNINDENT
.SS Test Coverage
.sp
To measure test coverage, execute the command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
tox \-e cover
.ft P
.fi
.UNINDENT
.UNINDENT
.SH CONFIGURATION FILE
.sp
After installation, you will need to create a configuration file.  By
default, \fBjenkins\-jobs\fP looks for \fB~/.config/jenkins_jobs/jenkins_jobs.ini\fP,
\fB<script directory>/jenkins_jobs.ini\fP or \fB/etc/jenkins_jobs/jenkins_jobs.ini\fP
(in that order), but you may specify an alternative location when running
\fBjenkins\-jobs\fP\&.  The file should have the following format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[job_builder]
ignore_cache=True
keep_descriptions=False
include_path=.:scripts:~/git/
recursive=False
exclude=.*:manual:./development
allow_duplicates=False
update=all

[jenkins]
user=jenkins
password=1234567890abcdef1234567890abcdef
url=https://jenkins.example.com
query_plugins_info=False
##### This is deprecated, use job_builder section instead
#ignore_cache=True

[plugin \(dqhipchat\(dq]
authtoken=dummy

[plugin \(dqstash\(dq]
username=user
password=pass

.ft P
.fi
.UNINDENT
.UNINDENT
.SS job_builder section
.INDENT 0.0
.TP
\fBignore_cache\fP
(Optional) If set to True, Jenkins Job Builder won\(aqt use any cache.
.TP
\fBkeep_descriptions\fP
By default \fIjenkins\-jobs\fP will overwrite the jobs descriptions even if no
description has been defined explicitly.
When this option is set to True, that behavior changes and it will only
overwrite the description if you specified it in the yaml. False by default.
.TP
\fBinclude_path\fP
(Optional) Can be set to a \(aq:\(aq delimited list of paths, which jenkins
job builder will search for any files specified by the custom application
yaml tags \(aqinclude\(aq, \(aqinclude\-raw\(aq and \(aqinclude\-raw\-escape\(aq.
.TP
\fBrecursive\fP
(Optional) If set to True, jenkins job builder will search for job
definition files recursively.
.TP
\fBexclude\fP
(Optional) If set to a list of values separated by \(aq:\(aq, these paths will be
excluded from the list of paths to be processed when searching recursively.
Values containing no \fB/\fP will be matched against directory names at all
levels, those starting with \fB/\fP will be considered absolute, while others
containing a \fB/\fP somewhere other than the start of the value will be
considered relative to the starting path.
.TP
\fBallow_duplicates\fP
(Optional) By default \fIjenkins\-jobs\fP will abort when a duplicate macro,
template, job\-group or job name is encountered as it cannot establish the
correct one to use. When this option is set to True, only a warning is
emitted.
.TP
\fBallow_empty_variables\fP
(Optional) When expanding strings, by default \fIjenkins\-jobs\fP will raise an
exception if there\(aqs a key in the string, that has not been declared in the
input YAML files. Setting this option to True will replace it with the empty
string, allowing you to use those strings without having to define all the
keys it might be using.
.TP
\fBprint_job_urls\fP
(Optional) If set to True it will print full jobs urls while updating jobs,
so user can be sure which instance was updated. User may click the link to
go directly to that job. False by default.
.TP
\fBretain_anchors\fP
(Optional) If set to True, YAML anchors will be retained across files,
allowing jobs to be composed from bits of YAML defined in separate files.
Note this means that the order of processing files matters \- \fIjenkins\-jobs\fP
loads files in alphabetical order (all files in a dir are loaded before any
files in subdirs). For example, if your anchors are in a file named \fIfoo.yml\fP
they will be accessible in \fIqux.yml\fP but not in \fIbar.yml\fP\&. They will also be
accessible in \fImydir/bar.yml\fP and \fImydir/qux.yml\fP\&. False by default.
.TP
\fBupdate\fP
(Optional) If set, allows the user to specify if only \(dqjobs\(dq or \(dqviews\(dq
(or \(dqall\(dq) are updated. Users can override the setting here by passing
\fB\-\-jobs\-only\fP or \fB\-\-views\-only\fP CLI options.
(Valid options: jobs, views, all)
.UNINDENT
.SS jenkins section
.INDENT 0.0
.TP
\fBuser\fP
This should be the name of a user previously defined in Jenkins.
Appropriate user permissions must be set under the Jenkins security
matrix: under the \fBGlobal\fP group of permissions, check \fBRead\fP,
then under the \fBJob\fP group of permissions, check \fBCreate\fP,
\fBDelete\fP, \fBConfigure\fP and finally \fBRead\fP\&.
.TP
\fBpassword\fP
The API token for the user specified.  You can get this through the
Jenkins management interface under \fBPeople\fP \-> username \->
\fBConfigure\fP and then click the \fBShow API Token\fP button.
.TP
\fBurl\fP
The base URL for your Jenkins installation.
.TP
\fBtimeout\fP
(Optional) The connection timeout (in seconds) to the Jenkins server.
By default this is set to the system configured socket timeout.
.TP
\fBquery_plugins_info\fP
Whether to query the Jenkins instance for plugin info. If no configuration
files are found (either in the default paths or given through the
command\-line), \fIjenkins\-jobs\fP will skip querying for plugin information.
False by default.
.UNINDENT
.SS hipchat section
.INDENT 0.0
.TP
\fBsend\-as\fP
This is the hipchat user name that will be used when sending notifications.
.TP
\fBauthtoken\fP
The API token necessary to send messages to hipchat.  This can be generated in
the hipchat web interface by a user with administrative access for your
organization. This authtoken is set for each job individually; the
JJB Hipchat Plugin does not currently support setting different tokens for
different projects, so the token you use will have to be scoped such that it
can be used for any room your jobs might be configured to notify. For more
information on this topic, please see the \fI\%Hipchat API Documentation\fP
.UNINDENT
.SS stash section
.INDENT 0.0
.TP
\fBusername\fP
This is the stash user name that will be used to connect to stash
when using the stash publisher plugin and not defining it in the
yaml part.
.TP
\fBpassword\fP
This is the related password that will be used with the stash username
when using the stash publisher plugin and not defining it in the
yaml part.
.UNINDENT
.SS __future__ section
.sp
This section is to control enabling of beta features or behaviour changes that
deviate from previously released behaviour in ways that may require effort to
convert existing JJB configs to adopt. This essentially will act as a method
to share these new behaviours while under active development so they can be
changed ahead of releases.
.INDENT 0.0
.TP
\fBparam_order_from_yaml\fP
Used to switch on using the order of the parameters are defined in yaml to
control the order of corresponding XML elements being written out. This is
intended as a global flag and can affect multiple modules.
.UNINDENT
.SH RUNNING
.sp
After it\(aqs installed and configured, you can invoke Jenkins Job
Builder by running \fBjenkins\-jobs\fP\&.  You won\(aqt be able to do
anything useful just yet without a configuration; that is
discussed in the next section.
.SS Test Mode
.sp
Once you have a configuration defined, you can run the job builder in test mode.
.sp
If you want to run a simple test with just a single YAML job definition file
and see the XML output on stdout:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs test /path/to/foo.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also pass JJB a directory containing multiple job definition files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs test /path/to/defs \-o /path/to/output
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
which will write XML files to the output directory for all of the jobs
defined in the defs directory.
.sp
If you run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs test /path/to/defs \-o /path/to/output \-\-config\-xml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
the output directory will contain config.xml files similar to the
internal storage format of Jenkins.  This might allow you to more
easily compare the output to an existing Jenkins installation.
.SS Updating Jobs
.sp
When you\(aqre satisfied with the generated XML from the test, you can run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs update /path/to/defs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
which will upload the job and view definitions to Jenkins if needed.  Jenkins
Job Builder maintains, for each host, a cache [1] of previously configured
jobs and views, so that you can run that command as often as you like, and it
will only update the jobs configurations in Jenkins if the defined definitions
have changed since the last time it was run.  Note: if you modify a job
directly in Jenkins, jenkins\-jobs will not know about it and will not
update it.
.sp
To update a specific list of jobs/views, simply pass the job/view names as
additional arguments after the job definition path. To update Foo1 and Foo2
run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs update /path/to/defs Foo1 Foo2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also enable the parallel execution of the program passing the workers
option with a value of 0, 2, or higher. Use 0 to run as many workers as cores
in the host that runs it, and 2 or higher to specify the number of workers to
use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs update \-\-workers 0 /path/to/defs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To update only views or only jobs, simply add the argument
\-\-views\-only or \-\-jobs\-only after the command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs update \-\-views\-only Foo\-view
jenkins\-jobs update \-\-jobs\-only Foo\-job
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Passing Multiple Paths
.sp
It is possible to pass multiple paths to JJB using colons as a path separator on
*nix systems and semi\-colons on Windows systems. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs test /path/to/global:/path/to/instance:/path/to/instance/project
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This helps when structuring directory layouts as you may selectively include
directories in different ways to suit different needs. If you maintain multiple
Jenkins instances suited to various needs you may want to share configuration
between those instances (global). Furthermore, there may be various ways you
would like to structure jobs within a given instance.
.SH RECURSIVE SEARCHING OF PATHS
.sp
In addition to passing multiple paths to JJB it is also possible to enable
recursive searching to process all yaml files in the tree beneath each path.
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
For a tree:
  /path/
    to/
      defs/
        ci_jobs/
        release_jobs/
      globals/
        macros/
        templates/

jenkins\-jobs update \-r /path/to/defs:/path/to/globals
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
JJB will search defs/ci_jobs, defs/release_jobs, globals/macros and
globals/templates in addition to the defs and globals trees.
.SH EXCLUDING PATHS
.sp
To allow a complex tree of jobs where some jobs are managed differently without
needing to explicitly provide each path, the recursive path processing supports
excluding paths based on absolute paths, relative paths and patterns. For
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
For a tree:
  /path/
    to/
      defs/
        ci_jobs/
          manual/
        release_jobs/
          manual/
        qa_jobs/
      globals/
        macros/
        templates/
        special/

jenkins\-jobs update \-r \-x man*:./qa_jobs \-x /path/to/defs/globals/special \e
  /path/to/defs:/path/to/globals
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
JJB will search the given paths, ignoring the directories qa_jobs,
ci_jobs/manual, release_jobs/manual, and globals/special when
building the list of yaml files to be processed. Absolute paths
are denoted by starting from the root, relative by containing
the path separator, and patterns by having neither.
Patterns use simple shell globing to match directories.
.SS Deleting Jobs/Views
.sp
Jenkins Job Builder supports deleting jobs and views from Jenkins.
.sp
To delete a specific job:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs delete Foo1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To delete a list of jobs or views, simply pass them as additional
arguments after the command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs delete Foo1 Foo2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To delete only views or only jobs, simply add the argument
\-\-views\-only or \-\-jobs\-only after the command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs delete \-\-views\-only Foo1
jenkins\-jobs delete \-\-jobs\-only Foo1
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBupdate\fP command includes a \fBdelete\-old\fP option to remove obsolete
jobs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs update \-\-delete\-old /path/to/defs
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Obsolete jobs are jobs once managed by JJB (as distinguished by a special
comment that JJB appends to their description), that were not generated in this
JJB run.
.sp
There is also a command to delete \fBall\fP jobs and/or views.
\fBWARNING\fP: Use with caution.
.sp
To delete \fBall\fP jobs and views:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs delete\-all
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
TO delete \fBall\fP jobs:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs delete\-all \-\-jobs\-only
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To delete \fBall\fP views:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs delete\-all \-\-views\-only
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Globbed Parameters
.sp
Jenkins job builder supports globbed parameters to identify jobs from a set of
definition files.  This feature only supports JJB managed jobs.
.sp
To update jobs/views that only have \(aqfoo\(aq in their name:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs update ./myjobs \e*foo\e*
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To delete jobs/views that only have \(aqfoo\(aq in their name:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs delete \-\-path ./myjobs \e*foo\e*
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Providing Plugins Info
.sp
With Jenkins LTS 1.651.1+ retrieving plugins info became a secure feature and
now requires Administrator rights to use [#f2]. This causes JJB to no longer be
able to work in situations where a user wants to publish jobs to Jenkins but is
not able to receive the Administrator permissions. In this case we can provide
a plugins_info.yaml file containing the plugin versions data needed by JJB to
parse the job templates.
.sp
To generate a plugins info, using an account with Administrator rights:
.INDENT 0.0
.INDENT 3.5
jenkins\-jobs get\-plugins\-info \-o plugins_info.yaml
.UNINDENT
.UNINDENT
.sp
To run JJB update using the plugins_info.yaml:
.INDENT 0.0
.INDENT 3.5
jenkins\-jobs update \-p plugins_info.yaml ./myjobs
.UNINDENT
.UNINDENT
.SS Command Reference
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: jenkins\-jobs [\-h] [\-\-conf CONF] [\-l LOG_LEVEL] [\-\-ignore\-cache]
                    [\-\-flush\-cache] [\-\-version] [\-\-allow\-empty\-variables]
                    [\-\-server SECTION] [\-\-user USER] [\-\-password PASSWORD]
                    {delete,delete\-all,get\-plugins\-info,list,test,update} ...

positional arguments:
  {delete,delete\-all,get\-plugins\-info,list,test,update}
                        update, test, list or delete job
    delete\-all          delete *ALL* jobs from Jenkins server, including those
                        not managed by Jenkins Job Builder.
    get\-plugins\-info    get plugins info yaml by querying Jenkins server.
    list                List jobs

options:
  \-h, \-\-help            show this help message and exit
  \-\-conf CONF           configuration file [JJB_CONF]
  \-l LOG_LEVEL, \-\-log_level LOG_LEVEL
                        log level (default: info) [JJB_LOG_LEVEL]
  \-\-ignore\-cache        ignore the cache and update the jobs anyhow (that will
                        only flush the specified jobs cache)
  \-\-flush\-cache         flush all the cache entries before updating
  \-\-version             show version
  \-\-allow\-empty\-variables
                        Don\(aqt fail if any of the variables inside any string
                        are not defined, replace with empty string instead.
  \-\-server SECTION, \-s SECTION
                        The Jenkins server ini section to use. Defaults to
                        \(aqjenkins\(aq [JJB_SECTION]
  \-\-user USER, \-u USER  The Jenkins user to use for authentication. This
                        overrides the user specified in the configuration
                        file. [JJB_USER]
  \-\-password PASSWORD, \-p PASSWORD
                        Password or API token to use for authenticating
                        towards Jenkins. This overrides the password specified
                        in the configuration file. [JJB_PASSWORD]
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: jenkins\-jobs test [\-h] [\-r] [\-x EXCLUDE] [\-\-config\-xml]
                         [\-p PLUGINS_INFO_PATH] [\-o OUTPUT_DIR]
                         [path] [names ...]

positional arguments:
  path                  colon\-separated list of paths to YAML files or
                        directories
  names                 name(s) of job(s)

options:
  \-h, \-\-help            show this help message and exit
  \-r, \-\-recursive       look for yaml files recursively
  \-x EXCLUDE, \-\-exclude EXCLUDE
                        paths to exclude when using recursive search, uses
                        standard globbing.
  \-\-config\-xml          use alternative output file layout using config.xml
                        files
  \-p PLUGINS_INFO_PATH, \-\-plugin\-info PLUGINS_INFO_PATH
                        path to plugin info YAML file
  \-o OUTPUT_DIR         path to output XML
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: jenkins\-jobs update [\-h] [\-r] [\-x EXCLUDE] [\-\-delete\-old]
                           [\-p PLUGINS_INFO_PATH] [\-\-workers N_WORKERS]
                           [\-\-existing\-only] [\-j | \-v]
                           [path] [names ...]

positional arguments:
  path                  colon\-separated list of paths to YAML files or
                        directories
  names                 name(s) of job(s)

options:
  \-h, \-\-help            show this help message and exit
  \-r, \-\-recursive       look for yaml files recursively
  \-x EXCLUDE, \-\-exclude EXCLUDE
                        paths to exclude when using recursive search, uses
                        standard globbing.
  \-\-delete\-old          delete obsolete jobs
  \-p PLUGINS_INFO_PATH, \-\-plugin\-info PLUGINS_INFO_PATH
                        path to plugin info YAML file. Can be used to provide
                        previously retrieved plugins info when connecting
                        credentials don\(aqt have permissions to query.
  \-\-workers N_WORKERS   number of workers to use, 0 for autodetection and 1
                        for just one worker.
  \-\-existing\-only       update existing jobs only
  \-j, \-\-jobs\-only       update only jobs
  \-v, \-\-views\-only      update only views
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: jenkins\-jobs delete\-all [\-h] [\-r] [\-x EXCLUDE] [\-j] [\-v]

options:
  \-h, \-\-help            show this help message and exit
  \-r, \-\-recursive       look for yaml files recursively
  \-x EXCLUDE, \-\-exclude EXCLUDE
                        paths to exclude when using recursive search, uses
                        standard globbing.
  \-j, \-\-jobs\-only       delete only jobs
  \-v, \-\-views\-only      delete only views
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: jenkins\-jobs delete [\-h] [\-r] [\-x EXCLUDE] [\-p PATH] [\-j] [\-v]
                           name [name ...]

positional arguments:
  name                  name of job

options:
  \-h, \-\-help            show this help message and exit
  \-r, \-\-recursive       look for yaml files recursively
  \-x EXCLUDE, \-\-exclude EXCLUDE
                        paths to exclude when using recursive search, uses
                        standard globbing.
  \-p PATH, \-\-path PATH  colon\-separated list of paths to YAML files or
                        directories
  \-j, \-\-jobs\-only       delete only jobs
  \-v, \-\-views\-only      delete only views
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: jenkins\-jobs get\-plugins\-info [\-h] [\-o PLUGINS_INFO_FILE]

options:
  \-h, \-\-help            show this help message and exit
  \-o PLUGINS_INFO_FILE, \-\-output\-file PLUGINS_INFO_FILE
                        file to save output to.
.ft P
.fi
.UNINDENT
.UNINDENT
.SH FOOTNOTES
.IP [1] 5
The cache default location is at \fB~/.cache/jenkins_jobs\fP, which
can be overridden by setting the \fBXDG_CACHE_HOME\fP environment
variable.
.IP [2] 5
Jenkins Security Advisory affecting plugins info retrieval
\fI\%https://www.jenkins.io/security/advisory/2016\-05\-11/#information\-on\-installed\-plugins\-exposed\-via\-api\fP
.SH JOB DEFINITIONS
.sp
The job definitions for Jenkins Job Builder are kept in any number of
YAML or JSON files, in whatever way you would like to organize them.  When you
invoke \fBjenkins\-jobs\fP you may specify either the path of a single
YAML file, or a directory.  If you choose a directory, all of
the .yaml/.yml or .json files in that directory will be read, and all the
jobs they define will be created or updated.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Jenkins Job Builder 2.x plugins are designed to default to generating the
xml format for the latest supported version of JJB. This is a change in
behaviour from 1.x and below which defaulted to the oldest supported plugin
version.
.UNINDENT
.UNINDENT
.SS Definitions
.sp
Jenkins Job Builder understands a few basic object types which are
described in the next sections.
.SS Job
.sp
The most straightforward way to create a job is simply to define a
Job in YAML.  It looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: job\-name
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
That\(aqs not very useful, so you\(aqll want to add some actions such as
\fI\%Builders\fP, and perhaps \fI\%Publishers\fP\&.  Those are described
later.
.sp
These are job parameters that are common to every type of Jenkins job.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: job\-name
    project\-type: freestyle
    defaults: global
    description: \(aqDo not edit this job through the web!\(aq
    disabled: false
    display\-name: \(aqFancy job name\(aq
    concurrent: true
    workspace: /srv/build\-area/job\-name
    quiet\-period: 5
    block\-downstream: false
    block\-upstream: false
    retry\-count: 3
    node: NodeLabel1 || NodeLabel2
    logrotate:
      daysToKeep: 3
      numToKeep: 20
      artifactDaysToKeep: \-1
      artifactNumToKeep: \-1

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B Job Parameters
.INDENT 7.0
.IP \(bu 2
\fBproject\-type\fP:
Defaults to \(dqfreestyle\(dq, but \(dqmaven\(dq as well as \(dqmultijob\(dq, \(dqflow\(dq,
\(dqpipeline\(dq or \(dqexternaljob\(dq can also be specified.
.IP \(bu 2
\fBdefaults\fP:
Specifies a set of \fI\%Defaults\fP to use for this job, defaults to
\(aq\(aqglobal\(aq\(aq.  If you have values that are common to all of your jobs,
create a \fBglobal\fP \fI\%Defaults\fP object to hold them, and no further
configuration of individual jobs is necessary.  If some jobs
should not use the \fBglobal\fP defaults, use this field to specify a
different set of defaults.
.IP \(bu 2
\fBdescription\fP:
The description for the job.  By default, the description
\(dq!\-\- Managed by Jenkins Job Builder\(dq is applied.
.IP \(bu 2
\fBdisabled\fP:
Boolean value to set whether or not this job should be disabled in
Jenkins. Defaults to \fBfalse\fP (job will be enabled).
.IP \(bu 2
\fBdisplay\-name\fP:
Optional name shown for the project throughout the Jenkins web GUI in
place of the actual job name.  The jenkins_jobs tool cannot fully remove
this trait once it is set, so use caution when setting it.  Setting it to
the same string as the job\(aqs name is an effective un\-set workaround.
Alternately, the field can be cleared manually using the Jenkins web
interface.
.IP \(bu 2
\fBconcurrent\fP:
Boolean value to set whether or not Jenkins can run this job
concurrently. Defaults to \fBfalse\fP\&.
.IP \(bu 2
\fBworkspace\fP:
Path for a custom workspace. Defaults to Jenkins default
configuration.
.IP \(bu 2
\fBfolder\fP:
The folder attribute provides an alternative to using \(aq<path>/<name>\(aq as
the job name to specify which Jenkins folder to upload the job to.
.sp
Requires the Jenkins \fI\%CloudBees Folders Plugin\fP\&.
.IP \(bu 2
\fBchild\-workspace\fP:
Path for a child custom workspace. Defaults to Jenkins default
configuration. This parameter is only valid for matrix type jobs.
.IP \(bu 2
\fBquiet\-period\fP:
Number of seconds to wait between consecutive runs of this job.
Defaults to \fB0\fP\&.
.IP \(bu 2
\fBblock\-downstream\fP:
Boolean value to set whether or not this job must block while
downstream jobs are running. Downstream jobs are determined
transitively. Defaults to \fBfalse\fP\&.
.IP \(bu 2
\fBblock\-upstream\fP:
Boolean value to set whether or not this job must block while
upstream jobs are running. Upstream jobs are determined
transitively. Defaults to \fBfalse\fP\&.
.IP \(bu 2
\fBauth\-token\fP:
Specifies an authentication token that allows new builds to be
triggered by accessing a special predefined URL. Only those who
know the token will be able to trigger builds remotely.
.IP \(bu 2
\fBretry\-count\fP:
If a build fails to checkout from the repository, Jenkins will
retry the specified number of times before giving up.
.IP \(bu 2
\fBnode\fP:
Restrict where this job can be run. If there is a group of
machines that the job can be built on, you can specify that
label as the node to tie on, which will cause Jenkins to build the job on
any of the machines with that label. For matrix projects, this parameter
will only restrict where the parent job will run.
.IP \(bu 2
\fBlogrotate\fP:
The Logrotate section allows you to automatically remove old build
history. It adds the \fBlogrotate\fP attribute to the \fI\%Job\fP
definition. All logrotate attributes default to \(dq\-1\(dq (keep forever).
\fBDeprecated on jenkins >=1.637\fP: use the \fBbuild\-discarder\fP
property instead
.IP \(bu 2
\fBjdk\fP:
The name of the jdk to use
.IP \(bu 2
\fBraw\fP:
If present, this section should contain a single \fBxml\fP entry. This XML
will be inserted at the top\-level of the \fI\%Job\fP definition.
.UNINDENT
.UNINDENT
.SS Job Template
.sp
If you need several jobs defined that are nearly identical, except
perhaps in their names, SCP targets, etc., then you may use a Job
Template to specify the particulars of the job, and then use a
\fI\%Project\fP to realize the job with appropriate variable substitution.
Any variables not specified at the project level will be inherited from
the \fI\%Defaults\fP\&.
.sp
A Job Template has the same syntax as a \fI\%Job\fP, but you may add
variables anywhere in the definition.  Variables are indicated by
enclosing them in braces, e.g., \fB{name}\fP will substitute the
variable \fIname\fP\&.  When using a variable in a string field, it is good
practice to wrap the entire string in quotes, even if the rules of
YAML syntax don\(aqt require it because the value of the variable may
require quotes after substitution. In the rare situation that you must
encode braces within literals inside a template (for example a shell
function definition in a builder), doubling the braces will prevent
them from being interpreted as a template variable.
.sp
You must include a variable in the \fBname\fP field of a Job Template
(otherwise, every instance would have the same name).  For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{name}\-unit\-tests\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will not cause any job to be created in Jenkins, however, it will
define a template that you can use to create jobs with a \fI\%Project\fP
definition.  It\(aqs name will depend on what is supplied to the
\fI\%Project\fP\&.
.sp
If you use the variable \fB{template\-name}\fP, the name of the template
itself (e.g. \fB{name}\-unit\-tests\fP in the above example) will be
substituted in. This is useful in cases where you need to trace a job
back to its template.
.sp
Sometimes it is useful to have the same job name format used even
where the template contents may vary. \fIIds\fP provide a mechanism to
support such use cases in addition to simplifying referencing
templates when the name contains the more complex substitution with
default values.
.SS Default Values for Template Variables
.sp
To facilitate reuse of templates with many variables that can be
substituted, but where in most cases the same or no value is needed,
it is possible to specify defaults for the variables within the
templates themselves.
.sp
There are 2 ways JJB allows us to define defaults for a parameter in a
job\-template.
.INDENT 0.0
.IP 1. 3
Defining the default variable value in the job\-template itself
.sp
With this method we declare the default value of the variable in the
job\-template itself just once. We can section off the job\-template into
two sections like this:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{project\-name}\-verify\(aq

    #####################
    # Variable Defaults #
    #####################

    branch: master

    #####################
    # Job Configuration #
    #####################

    parameters:
      \- string:
          name: BRANCH
          default: \(aq{branch}\(aq

    scm:
      \- git:
          refspec: \(aqrefs/heads/{branch}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case there is still two branch definitions for the job\-template.
However we also provide the default value for the {branch} variable at the
top of the file. Just once. This will be the value that the job takes on if
it is not passed in by a project using the template.
.IP 2. 3
Using {var|default}
.sp
In this method we can define the default with the definition of the
variable. For example:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{project\-name}\-verify\(aq
    parameters:
      \- string:
          name: BRANCH
          default: \(aq{branch|master}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However where this method falls apart if we need to use the same JJB
variable in more than one place as we will have multiple places to define
the default value for the template. For example:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{project\-name}\-verify\(aq
    parameters:
      \- string:
          name: BRANCH
          default: \(aq{branch|master}\(aq

    scm:
      \- git:
          refspec: \(aqrefs/heads/{branch|master}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
We can see in this case the \fB{branch|master}\fP variable is defined in two
places. Not ideal.
.UNINDENT
.sp
More complex example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: template_variable_defaults
    jobs:
        \- \(aqtemplate\-variable\-defaults\-{num}\(aq:
            num: 1
            disabled_var: true
        \- \(aqtemplate\-variable\-defaults\-{num}\(aq:
            test_var: Goodbye World
            num: 2

\- job\-template:
    # template specific defaults
    # empty value causes disabled_var to be ignored internally
    disabled_var:
    test_var: Hello World
    type: periodic

    # template settings
    name: \(aqtemplate\-variable\-defaults\-{num}\-{type}\(aq
    id: \(aqtemplate\-variable\-defaults\-{num}\(aq
    disabled: \(aq{obj:disabled_var}\(aq
    builders:
      \- shell: |
         echo \(dqJob Name: template\-variable\-defaults\-{num}\-{type}\(dq
         echo \(dqVariable: {test_var}\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To use a default value for a variable used in the name would be
uncommon unless it was in addition to another variable. However you
can use \fI\%Ids\fP simplify such use cases.
.SS Project
.sp
The purpose of a project is to collect related jobs together, and
provide values for the variables in a \fI\%Job Template\fP\&.  It looks like
this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: project\-name
    jobs:
      \- \(aq{name}\-unit\-tests\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Any number of arbitrarily named additional fields may be specified,
and they will be available for variable substitution in the job
template.  Any job templates listed under \fBjobs:\fP will be realized
with those values.  The example above would create the job called
\(aqproject\-name\-unit\-tests\(aq in Jenkins.
.sp
The \fBjobs:\fP list can also allow for specifying job\-specific
substitutions as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: project\-name
    jobs:
      \- \(aq{name}\-unit\-tests\(aq:
          mail\-to: developer@nowhere.net
      \- \(aq{name}\-perf\-tests\(aq:
          mail\-to: projmanager@nowhere.net
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If a variable is a list, the job template will be realized with the
variable set to each value in the list.  Multiple lists will lead to
the template being realized with the cartesian product of those
values.  Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: project\-name
    pyver:
      \- 26
      \- 27
    jobs:
      \- \(aq{name}\-{pyver}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If there are templates being realized that differ only in the variable
used for its name (thus not a use case for job\-specific substitutions),
additional variables can be specified for project variables. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{name}\-{pyver}\(aq
    builders:
      \- shell: \(aqgit co {branch_name}\(aq

\- project:
   name: project\-name
   pyver:
    \- 26:
       branch_name: old_branch
    \- 27:
       branch_name: new_branch
   jobs:
    \- \(aq{name}\-{pyver}\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also specify some variable combinations to exclude from the matrix with
the \fBexclude\fP keyword, to avoid generating jobs for those combinations. You
can specify all the variables of the combination or only a subset, if you
specify a subset, any value of the omited variable will match:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: project\-name
    axe1:
      \- axe1val1
      \- axe1val2
    axe2:
      \- axe2val1
      \- axe2val2
    axe3:
      \- axe3val1
      \- axe3val2
    exclude:
      \- axe1: axe1val1
        axe2: axe2val1
        axe3: axe3val2
      \- axe2: axe2val2
        axe3: axe3val1
    jobs:
      \- build\-{axe1}\-{axe2}\-{axe3}

\- job\-template:
    name: build\-{axe1}\-{axe2}\-{axe3}
    builders:
      \- shell: \(dqecho Combination {axe1}:{axe2}:{axe3}\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The above example will omit the jobs:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
build\-axe1val1\-axe2val1\-axe3val2
.IP \(bu 2
build\-axe1val1\-axe2val2\-axe3val1
.IP \(bu 2
build\-axe1val2\-axe2val2\-axe3val1
.UNINDENT
.UNINDENT
.UNINDENT
.sp
To achieve the same without the \fBexclude\fP tag one would have to do something
a bit more complicated, that gets more complicated for each dimension in the
combination, for the previous example, the counterpart would be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: project\-name_comb1
    axe1:
      \- axe1val1
      \- axe1val2
    axe2: axe2val1
    axe3: axe3val1
    jobs:
      \- build\-{axe1}\-{axe2}\-{axe3}

\- project:
    name: project\-name_comb2
    axe1:
      \- axe1val1
      \- axe1val2
    axe2: axe2val2
    axe3: axe3val2
    jobs:
      \- build\-{axe1}\-{axe2}\-{axe3}

\- project:
    name: project\-name_comb3
    axe1: axe1val2
    axe2: axe2val1
    axe3: axe3val2
    jobs:
      \- build\-{axe1}\-{axe2}\-{axe3}

\- job\-template:
    name: build\-{axe1}\-{axe2}\-{axe3}
    builders:
      \- shell: \(dqecho Combination {axe1}:{axe2}:{axe3}\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.SS Job Group
.sp
If you have several Job Templates that should all be realized
together, you can define a Job Group to collect them.  Simply use the
Job Group where you would normally use a \fI\%Job Template\fP and all of
the Job Templates in the Job Group will be realized.  For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{name}\-unit\-tests\(aq
    builders:
    \- shell: unittest
    publishers:
    \- email:
        recipients: \(aq{mail\-to}\(aq

\- job\-template:
    name: \(aq{name}\-perf\-tests\(aq
    builders:
    \- shell: perftest
    publishers:
    \- email:
        recipients: \(aq{mail\-to}\(aq

\- job\-group:
    name: \(aq{name}\-tests\(aq
    jobs:
    \- \(aq{name}\-unit\-tests\(aq:
        mail\-to: developer@nowhere.net
    \- \(aq{name}\-perf\-tests\(aq:
        mail\-to: projmanager@nowhere.net

\- project:
    name: project\-name
    jobs:
    \- \(aq{name}\-tests\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Would cause the jobs \fIproject\-name\-unit\-tests\fP and \fIproject\-name\-perf\-tests\fP to be created
in Jenkins.
.SS Views
.sp
A view is a particular way of displaying a specific set of jobs. To
create a view, you must define a view in a YAML file and have a variable called view\-type with a valid value. It looks like this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- view:
    name: view\-name
    view\-type: list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Views are processed differently than Jobs and therefore will not work within a \fI\%Project\fP or a \fI\%Job Template\fP\&.
.SS View Template
.sp
Allow views to also be configured via templates similar to job\-templates. This
is useful when you have multiple views defined that have similar configuration
except for a few variables. View Templates can be passed variables to fill in
sections automatically via a project configuration using the new \(aqviews\(aq key.
.sp
Minimal Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- view\-template:
    name: \(aq{name}\-template\-{seq}\(aq
    description: \(aqtesting view templates feature\(aq
    view\-type: list
    regex: \(aqtest\-view\-.*\(aq

\- project:
    name: \(aqtest\-view\(aq
    views:
        \- \(aq{name}\-template\-{seq}\(aq
    seq:
        \- a
        \- b
        \- c
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Macro
.sp
Many of the actions of a \fI\%Job\fP, such as builders or publishers, can
be defined as a Macro, and then that Macro used in the \fI\%Job\fP
description.  Builders are described later, but let\(aqs introduce a
simple one now to illustrate the Macro functionality.  This snippet
will instruct Jenkins to execute \(dqmake test\(dq as part of the job:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: foo\-test
    builders:
      \- shell: \(aqmake test\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you wanted to define a macro (which won\(aqt save much typing in this
case, but could still be useful to centralize the definition of a
commonly repeated task), the configuration would look like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- builder:
    name: make\-test
    builders:
      \- shell: \(aqmake test\(aq

\- job:
    name: foo\-test
    builders:
      \- make\-test
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This allows you to create complex actions (and even sequences of
actions) in YAML that look like first\-class Jenkins Job Builder
actions.  Not every attribute supports Macros, check the documentation
for the action before you try to use a Macro for it.
.sp
Macros can take parameters, letting you define a generic macro and more
specific ones without having to duplicate code:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# The \(aqadd\(aq macro takes a \(aqnumber\(aq parameter and will creates a
# job which prints \(aqAdding \(aq followed by the \(aqnumber\(aq parameter:
\- builder:
    name: add
    builders:
     \- shell: \(dqecho Adding {number}\(dq

# A specialized macro \(aqaddtwo\(aq reusing the \(aqadd\(aq macro but with
# a \(aqnumber\(aq parameter hardcoded to \(aqtwo\(aq:
\- builder:
    name: addtwo
    builders:
     \- add:
        number: \(dqtwo\(dq

# Glue to have Jenkins Job Builder to expand this YAML example:
\- job:
    name: \(dqtestingjob\(dq
    builders:
     # The specialized macro:
     \- addtwo
     # Generic macro call with a parameter
     \- add:
        number: \(dqZERO\(dq
     # Generic macro called without a parameter. Never do this!
     # See below for the resulting wrong output :(
     \- add
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Then \fB<builders />\fP section of the generated job show up as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
<builders>
  <hudson.tasks.Shell>
    <command>echo Adding two</command>
  </hudson.tasks.Shell>
  <hudson.tasks.Shell>
    <command>echo Adding ZERO</command>
  </hudson.tasks.Shell>
  <hudson.tasks.Shell>
    <command>echo Adding {number}</command>
  </hudson.tasks.Shell>
</builders>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
As you can see, the specialized macro \fBaddtwo\fP reused the definition from
the generic macro \fBadd\fP\&.
.SS Macro Notes
.sp
If a macro is not passed any parameters it will not have any expansion
performed on it.  Thus if you forget to provide \fIany\fP parameters to a
macro that expects some, the parameter\-templates (\fB{foo}\fP) will be
left as is in the resulting output; this is almost certainly not what
you want.  Note if you provide an invalid parameter, the expansion
will fail; the expansion will only be skipped if you provide \fIno\fP
parameters at all.
.sp
Macros are expanded using Python string substitution rules.  This can
especially cause confusion with shell snippets that use \fB{\fP as part
of their syntax.  As described, if a macro has \fIno\fP parameters, no
expansion will be performed and thus it is correct to write the script
with no escaping, e.g.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- builder:
  name: a_builder
  builders:
    \- shell: |
        VARIABLE=${VARIABLE:\-bar}
        function foo {
            echo \(dqmy shell function\(dq
        }
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
However, if the macro \fIhas\fP parameters, you must escape the \fB{\fP you
wish to make it through to the output, e.g.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- builder:
  name: a_builder
  builders:
     \- shell: |
       PARAMETER={parameter}
       VARIABLE=${{VARIABLE:\-bar}}
       function foo {{
            echo \(dqmy shell function\(dq
       }}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that a \fBjob\-template\fP will have parameters by definition (at
least a \fBname\fP).  Thus embedded\-shell within a \fBjob\-template\fP should
always use \fB{{\fP to achieve a literal \fB{\fP\&.  A generic builder will need
to consider the correct quoting based on its use of parameters.
.SS Folders
.sp
Jenkins supports organising jobs, views, and slaves using a folder hierarchy.
This allows for easier separation of access as well credentials and resources
which can be assigned to only be available for a specific folder.
.sp
JJB has two methods of supporting uploading jobs to a specific folder:
.INDENT 0.0
.IP \(bu 2
Name the job to contain the desired folder \fB<folder>/my\-job\-name\fP
.IP \(bu 2
Use the \fBfolder\fP attribute on a job definition, via a template, or through
\fI\%Defaults\fP\&.
.UNINDENT
.sp
Supporting both an attributed and use of it directly in job names allows for
teams to have all jobs using their defaults automatically use a top\-level
folder, while still allowing for them to additionally nest jobs for their
own preferences.
.sp
Job Name Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: python\-jobs/tox\-py27
    builders:
      \- shell: |
          tox \-e py27

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Folder Attribute Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- defaults:
    name: team1
    folder: team1\-jobs

\- job:
    name: ruby\-jobs/rspec
    defaults: team1
    builders:
      \- shell: |
          rvm use \-\-create ruby\-2.3.0@rspec
          bundle install
          bundle exec rspec

.ft P
.fi
.UNINDENT
.UNINDENT
.SS Item ID\(aqs
.sp
It\(aqs possible to assign an \fIid\fP to any of the blocks and then use that
to reference it instead of the name. This has two primary functions:
.INDENT 0.0
.IP \(bu 2
A unique identifier where you wish to use the same naming format for
multiple templates. This allows you to follow a naming scheme while
still using multiple templates to handle subtle variables in job
requirements.
.IP \(bu 2
Provides a simpler name for a \fIjob\-template\fP where you have multiple
variables including default values in the name and don\(aqt wish to have
to include this information in every use. This also makes changing
the template output name without impacting references.
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: test_template_id
    jobs:
        \- \(aqsimple\-template\(aq:
            test_var: Hello World
            type: periodic
            num: 1
        \- \(aqnot\-as\-simple\-template\(aq:
            test_var: Goodbye World
            type: canary
            num: 2

\- job\-template:
    name: \(aqtemplate\-test\-ids\-{num}\-{type}\(aq
    id: simple\-template
    builders:
      \- shell: |
         echo \(dqTemplate name: {template\-name}\(dq
         echo \(dqJob name: template\-test\-ids\-{num}\-{type}\(dq
         echo \(dq{test_var}\(dq

\- job\-template:
    name: \(aqtemplate\-test\-ids\-{num}\-{type}\(aq
    id: not\-as\-simple\-template
    builders:
      \- shell: |
         echo \(dqTemplate name: {template\-name}\(dq
         echo \(dqJob name: template\-test\-ids\-{num}\-{type}\(dq
      \- shell: |
         echo \(dq{test_var}\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.SS Raw config
.sp
It is possible, but not recommended, to use \fIraw\fP within a module to
inject raw xml into the job configs.
.sp
This is relevant in case there is no appropriate module for a
Jenkins plugin or the module does not behave as you expect it to do.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- raw:
      xml: |
        <hudson.plugins.xvnc.Xvnc>
          <takeScreenshot>true</takeScreenshot>
          <useXauthority>false</useXauthority>
        </hudson.plugins.xvnc.Xvnc>

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Is the raw way of adding support for the \fIxvnc\fP wrapper.
.sp
To get the appropriate xml to use you would need to create/edit a job
in Jenkins and grab the relevant raw xml segment from the
\fIconfig.xml\fP\&.
.sp
The xml string can refer to variables just like anything else and as
such can be parameterized like anything else.
.sp
You can use \fIraw\fP in most locations, the following example show them
with arbitrary xml\-data:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: complete002
    version:
        \- 1.2
    jobs:
        \- \(aqcomplete001_{version}\(aq

\- job\-template:
    name: \(aqcomplete001_{version}\(aq
    project\-type: maven
    scm:
      \- raw:
          xml: |
            <!\-\- <scm> for raw replaces the whole scm section.
             where as for others the raw part is added to the existing.
            \-\->
            <scm>
              <scmraw/>
            </scm>
    triggers:
      \- raw:
          xml: |
            <triggersraw/>
    wrappers:
      \- raw:
          xml: |
            <wrappersraw/>
    builders:
      \- raw:
          xml: |
            <buildersraw/>
    publishers:
      \- raw:
          xml: |
            <publishersraw/>
    properties:
      \- raw:
          xml: |
            <propertiesraw/>
    parameters:
      \- raw:
          xml: |
            <parametersraw/>
    notifications:
      \- raw:
          xml: |
            <metadataraw/>
    reporters:
      \- raw:
          xml:
            <reportersraw/>

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note: If you have a need to use \fIraw\fP please consider submitting a patch to
add or fix the module that will remove your need to use \fIraw\fP\&.
.SS Defaults
.sp
Defaults collect job attributes (including actions) and will supply
those values when the job is created, unless superseded by a value in
the \(aqJob\(aq_ definition.  If a set of Defaults is specified with the
name \fBglobal\fP, that will be used by all \fI\%Job\fP (and \fI\%Job Template\fP)
definitions unless they specify a different Default object with the
\fBdefaults\fP attribute.  For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- defaults:
    name: global
    description: \(aqDo not edit this job through the web!\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will set the job description for every job created.
.sp
You can define variables that will be realized in a \fIJob Template\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- defaults:
    name: global
    arch: \(aqi386\(aq

\- project:
    name: project\-name
    jobs:
        \- \(aqbuild\-{arch}\(aq
        \- \(aqbuild\-{arch}\(aq:
            arch: \(aqamd64\(aq

\- job\-template:
    name: \(aqbuild\-{arch}\(aq
    builders:
        \- shell: \(dqecho Build arch {arch}.\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Would create jobs \fBbuild\-i386\fP and \fBbuild\-amd64\fP\&.
.sp
You can also reference a variable \fB{template\-name}\fP in any value and it will
be subtitued by the name of the current job template being processed.
.SS Variable References
.sp
If you want to pass an object (boolean, list or dict) to templates you can
use an \fB{obj:key}\fP variable in the job template.  This triggers the use
of code that retains the original object type.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: test_custom_distri
    disabled: true
    distributions: !!python/tuple [precise, jessie]
    architectures: !!python/tuple &architectures
      \- amd64
      \- i386
    axis_a:
        type: user\-defined
        name: architectures
        values: *architectures
    jobs:
      \- \(aq{name}\-source\(aq

\- job\-template:
      name: \(aq{name}\-source\(aq
      project\-type: matrix
      disabled: \(aq{obj:disabled}\(aq
      axes:
        \- axis:
            type: user\-defined
            name: distribution
            values: \(aq{obj:distributions}\(aq
        \- axis: \(aq{obj:axis_a}\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
JJB also supports interpolation of parameters within parameters. This allows a
little more flexibility when ordering template jobs as components in different
projects and job groups.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{value\-stream}_{project\-id}_foo\(aq
    display\-name: \(aq{value\-stream} {project\-id} foo\(aq
    publishers:
        \- trigger\-parameterized\-builds:
            \- project: \(aq{downstream}\(aq
              current\-parameters: False
              condition: ALWAYS
              git\-revision: True

\- job\-template:
    name: \(aq{value\-stream}_{project\-id}_bar\(aq
    display\-name: \(aq{value\-stream} {project\-id} bar\(aq
    publishers:
        \- trigger\-parameterized\-builds:
            \- project: \(aq{downstream}\(aq
              current\-parameters: False
              condition: ALWAYS
              git\-revision: True

\- job\-group:
    name: \(aqpipeline2\(aq
    project\-id: \(aqp2\(aq
    jobs:
        \- \(aq{value\-stream}_{project\-id}_foo\(aq:
            downstream: \(aq{value\-stream}_{project\-id}_bar\(aq
        \- \(aq{value\-stream}_{project\-id}_bar\(aq:

\- job\-group:
    name: \(aqpipeline1\(aq
    project\-id: \(aqp1\(aq
    jobs:
        \- \(aq{value\-stream}_{project\-id}_bar\(aq:
            downstream: \(aq{value\-stream}_{project\-id}_foo\(aq
        \- \(aq{value\-stream}_{project\-id}_foo\(aq:

\- project:
    name: derp
    jobs:
        \- \(aqpipeline1\(aq:
            value\-stream: \(aqproduction\(aq
        \- \(aqpipeline2\(aq:
            value\-stream: \(aqexperimental\(aq

\- defaults:
    name: \(aqglobal\(aq
    downstream: \(aq\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
By default JJB will fail if it tries to interpolate a variable that was not
defined, but you can change that behavior and allow empty variables with the
allow_empty_variables configuration option.
.sp
For example, having a configuration file with that option enabled:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[job_builder]
allow_empty_variables = True

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will prevent JJb from failing if there are any non\-initialized variables used
and replace them with the empty string instead.
.sp
\fBTIP:\fP
.INDENT 0.0
.INDENT 3.5
Refer to \fI\%Default Values for Template Variables\fP for details on setting variable defaults.
.UNINDENT
.UNINDENT
.SS Variable Inheritance
.sp
It is possible in JJB to define defaults for variables at different levels such
that it is possible for users of job\-templates to override variables defined
in the job\-template.
.sp
Variable priorities for each definition type are as follows:
.INDENT 0.0
.IP 1. 3
job\-group
.IP 2. 3
project
.IP 3. 3
job\-template
.IP 4. 3
defaults
.UNINDENT
.sp
From this list we can immediately see that if we want to make variables in
job\-templates override\-able then using defaults configuration is useless as it
has the lowest precedence when JJB is deciding where to pull from.
.sp
On the other side of the spectrum, job\-groups has the highest precedence. Which
unfortunately means if we define a variable in a job\-group with the intention
of overriding it at the project level then we are out of luck. For this reason
avoid setting variables in job\-groups unless we want to enforce a setting for a
set of jobs and prevent projects from overriding it.
.SS Declaring variable defaults
.sp
Refer to \fI\%Default Values for Template Variables\fP for details on how to declare variable defaults.
.SS Overriding job\-template variables
.sp
When a project wants to use a job\-template it can use override it as follows:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: foo
    jobs:
      \- \(aq{project\-name}\-merge\(aq
      \- \(aq{project\-name}\-verify\(aq

    branch: master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This is the standard way that most folks use and it will set \fBbranch: master\fP
for every job\-template in the list. However sometimes we may want to provide an
alternative value for a specific job in the list. In this case the more
specific declaration takes precedence:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: foo
    jobs:
      \- \(aq{project\-name}\-merge\(aq:
          branch: production
      \- \(aq{project\-name}\-verify\(aq

    branch: master
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
In this case the verify job will get the value \fBmaster\fP but the merge job
will instead get the branch value \fBproduction\fP\&.
.SS Yaml Anchors & Aliases
.sp
The yaml specification supports \fI\%anchors and aliases\fP which means
that JJB definitions allow references to variables in templates.
.sp
For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- wrapper_defaults: &wrapper_defaults
    name: \(aqwrapper_defaults\(aq
    wrappers:
      \- timeout:
          timeout: 180
          fail: true
      \- timestamps

\- job_defaults: &job_defaults
    name: \(aqdefaults\(aq
    <<: *wrapper_defaults

\- job\-template:
    name: \(aqmyjob\(aq
    <<: *job_defaults

\- project:
    name: myproject
    jobs:
      \- myjob

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fI\%anchors and aliases\fP are expanded internally within JJB\(aqs yaml loading
calls and are not limited to individual documents. That means you can\(aqt use
the same anchor name in included files without collisions.
.sp
A simple example can be seen in the specs \fI\%full length example\fP with the
following being more representative of usage within JJB:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- wrapper_defaults: &wrapper_defaults
    name: \(aqwrapper_defaults\(aq
    wrappers:
      \- timeout:
          timeout: 180
          fail: true
      \- timestamps

\- job_defaults: &job_defaults
    name: \(aqdefaults\(aq
    <<: *wrapper_defaults

\- job\-template:
    name: \(aqmyjob\(aq
    <<: *job_defaults

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Which will be expanded to the following yaml before being processed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- wrapper_defaults:
    name: wrapper_defaults
    wrappers:
    \- timeout:
        fail: true
        timeout: 180
    \- timestamps
\- job_defaults:
    name: defaults
    wrappers:
    \- timeout:
        fail: true
        timeout: 180
    \- timestamps
\- job\-template:
    name: myjob
    wrappers:
    \- timeout:
        fail: true
        timeout: 180
    \- timestamps

.ft P
.fi
.UNINDENT
.UNINDENT
.SS Custom Yaml Tags
.sp
Custom application specific yamls tags are supported to provide
enhancements when reading yaml configuration.
.SS Action Tags
.sp
These allow manipulation of data being stored in one layout in the source
yaml for convenience and/or clarity, to another format to be processed by
the targeted module instead of requiring all modules in JJB being capable
of supporting multiple input formats.
.sp
The tag \fB!join:\fP will treat the first element of the following list as
the delimiter to use, when joining the remaining elements into a string
and returning a single string to be consumed by the specified module option.
.sp
This allows users to maintain elements of data in a list structure for ease
of review/maintenance, and have the yaml parser convert it to a string for
consumption as any argument for modules. The main expected use case is to
allow for generic plugin data such as shell properties to be populated from
a list construct which the yaml parser converts to a single string, instead
of trying to support this within the module code which would require a
templating engine similar to Jinja.
.sp
Generic Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- string\-with\-comma: !join:
    \- \(aq,\(aq
    \-
        \- item1
        \- item2
        \- item3

\- string\-with\-space: !join:
    \- \(aq \(aq
    \-
        \- item1
        \- item2
        \- item3

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Environment Inject:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- project:
    name: string_join_example
    jobs:
        \- \(aqstring\-join\-data\-{name}\(aq:
            name: set1
            files: !join:
              \- \(aq,\(aq
              \-
                \- /path/to/file1
                \- /path/to/file2
                \- /path/to/file3
                \- /path/to/file4
                \- /path/to/file5
                \- /path/to/file6
                \- /path/to/file7
                \- /path/to/file8
                \- /path/to/file9
                \- /path/to/file10
                \- /path/to/file11
                \- /path/to/file12
                \- /path/to/file13
                \- /path/to/file14
                \- /path/to/file15
                \- /path/to/file16
                \- /path/to/file17
                \- /path/to/file18
                \- /path/to/file19
                \- /path/to/file20
        \- \(aqstring\-join\-data\-{name}\(aq:
            name: set2
            files: !join:
              \- \(aq,\(aq
              \-
                \- /another/different/path/to/file1
                \- /another/different/path/to/file2
                \- /another/different/path/to/file3
                \- /another/different/path/to/file4
                \- /another/different/path/to/file5
                \- /another/different/path/to/file6
                \- /another/different/path/to/file7
                \- /another/different/path/to/file8
                \- /another/different/path/to/file9
                \- /another/different/path/to/file10
                \- /another/different/path/to/file11
                \- /another/different/path/to/file12
                \- /another/different/path/to/file13
                \- /another/different/path/to/file14
                \- /another/different/path/to/file15
                \- /another/different/path/to/file16
                \- /another/different/path/to/file17
                \- /another/different/path/to/file18
                \- /another/different/path/to/file19
                \- /another/different/path/to/file20

\- job\-template:
    name: \(aqstring\-join\-data\-{name}\(aq
    properties:
      \- inject:
          keep\-system\-variables: true
          properties\-content: |
            FILE_LIST={files}
    builders:
      \- shell: |
         echo \(dqTemplate name: {template\-name}\(dq
         echo \(dqData to be processed:\(dq
         echo \(dq${{INPUT_DATA}}\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
While this mechanism can also be used items where delimiters are supported by
the module, that should be considered a bug that the existing code doesn\(aqt
handle being provided a list and delimiter to perform the correct conversion
for you. Should you discover a module that takes arguments with delimiters and
the existing JJB codebase does not handle accepting lists, then this can be
used as a temporary solution in place of using very long strings:
.sp
Extended Params Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- extended\-choice:
      name: OPTIONS_VALUE
      description: \(dqAvailable options\(dq
      property\-key: key
      quote\-value: true
      type: multi\-select
      value: \(dqfoo|bar|select\(dq
      visible\-items: 2
      multi\-select\-delimiter: \(aq|\(aq
      default\-value: foo
      default\-property\-key: fookey
  \- extended\-choice:
      name: OPTIONS_FILE
      description: \(dqAvailable options\(dq
      property\-file: /home/foo/property.prop
      property\-key: key
      quote\-value: true
      type: multi\-select
      visible\-items: 2
      multi\-select\-delimiter: \(aq|\(aq
      default\-property\-file: /home/property.prop
      default\-property\-key: fookey
  \- extended\-choice:
      name: OPTIONS_CHECKBOX
      type: checkbox
      value: !join:
        \- \(aq,\(aq
        \-
            \- OptionA
            \- OptionB
            \- OptionC
      visible\-items: 2
  \- extended\-choice:
      name: MULTISELECTOPTIONS
      description: \(dqAvailable options\(dq
      property\-key: key
      quote\-value: true
      type: multi\-select
      value: !join:
        \- \(aq|\(aq
        \-
            \- foo
            \- bar
            \- select
      visible\-items: 2
      multi\-select\-delimiter: \(aq|\(aq
      default\-value: foo
  \- extended\-choice:
      name: JSON
      type: json
      groovy\-script: >\-
          import net.sf.json.JSONObject;
          def jsonEditorOptions = JSONObject.fromObject(/{schema:
          {\(dqtype\(dq: \(dqobject\(dq, \(dqtitle\(dq: \(dqName\(dq, \(dqproperties\(dq:
          {\(dqname\(dq: {\(dqtype\(dq: \(dqstring\(dq, \(dqpropertyOrder\(dq : 1}}}}/);
  \- extended\-choice:
      name: MULTILEVELMULTISELECT
      type: multi\-level\-multi\-select
      value: !join:
          \- \(aq,\(aq
          \-
              \- foo
              \- bar
              \- baz
  \- extended\-choice:
      name: MULTILEVELSINGLESELECT
      type: multi\-level\-single\-select
      value: foo

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Inclusion Tags
.sp
These allow inclusion of arbitrary files as a method of having blocks of data
managed separately to the yaml job configurations. A specific usage of this is
inlining scripts contained in separate files, although such tags may also be
used to simplify usage of macros or job templates.
.sp
The tag \fB!include:\fP will treat the following string as file which should be
parsed as yaml configuration data.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: test\-job\-1
    builders:
      !include: include001.yaml.inc

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
contents of include001.yaml.inc:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- timeout\-wrapper
\- pre\-scm\-shell\-ant
\- copy\-files

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The tag \fB!include\-raw:\fP will treat the given string or list of strings as
filenames to be opened as one or more data blob, which should be read into
the calling yaml construct without any further parsing. Any data in a file
included through this tag, will be treated as string data.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: test\-job\-include\-raw\-1
    builders:
      \- shell:
          !include\-raw: include\-raw001\-hello\-world.sh
      \- shell:
          !include\-raw: include\-raw001\-vars.sh

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
contents of include\-raw001\-hello\-world.sh:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/bash
#
# Sample script showing how the yaml include\-raw tag can be used
# to inline scripts that are maintained outside of the jenkins
# job yaml configuration.

echo \(dqhello world\(dq

exit 0

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
contents of include\-raw001\-vars.sh:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/bash
#
# sample script to check that brackets aren\(aqt escaped
# when using the include\-raw application yaml tag

VAR1=\(dqhello\(dq
VAR2=\(dqworld\(dq
VAR3=\(dq${VAR1} ${VAR2}\(dq

[[ \-n \(dq${VAR3}\(dq ]] && {
    # this next section is executed as one
    echo \(dq${VAR3}\(dq
    exit 0
}

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
using a list of files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: test\-job\-include\-raw\-1
    builders:
      \- shell:
          !include\-raw:
              \- include\-raw001\-hello\-world.sh
              \- include\-raw001\-vars.sh

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The tag \fB!include\-raw\-escape:\fP treats the given string or list of strings as
filenames to be opened as one or more data blobs, which should be escaped
before being read in as string data. This allows job\-templates to use this tag
to include scripts from files without needing to escape braces in the original
file.
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
When used as a macro \fB!include\-raw\-escape:\fP should only be used if
parameters are passed into the escaped file and you would like to escape
those parameters. If the file does not have any jjb parameters passed into
it then \fB!include\-raw:\fP should be used instead otherwise you will run
into an interesting issue where \fBinclude\-raw\-escape:\fP actually adds
additional curly braces around existing curly braces. For example
${PROJECT} becomes ${{PROJECT}} which may break bash scripts.
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: test\-job\-include\-raw\-{num}
    builders:
      \- shell:
          !include\-raw\-escape: include\-raw001\-hello\-world.sh
      \- shell:
          !include\-raw\-escape: include\-raw001\-vars.sh

\- project:
    name: test\-job\-template\-1
    num: 1
    jobs:
      \- \(aqtest\-job\-include\-raw\-{num}\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
contents of include\-raw001\-hello\-world.sh:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/bash
#
# Sample script showing how the yaml include\-raw tag can be used
# to inline scripts that are maintained outside of the jenkins
# job yaml configuration.

echo \(dqhello world\(dq

exit 0

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
contents of include\-raw001\-vars.sh:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
#!/bin/bash
#
# sample script to check that brackets aren\(aqt escaped
# when using the include\-raw application yaml tag

VAR1=\(dqhello\(dq
VAR2=\(dqworld\(dq
VAR3=\(dq${VAR1} ${VAR2}\(dq

[[ \-n \(dq${VAR3}\(dq ]] && {
    # this next section is executed as one
    echo \(dq${VAR3}\(dq
    exit 0
}

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
using a list of files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: test\-job\-include\-raw\-{num}
    builders:
      \- shell:
          !include\-raw\-escape:
              \- include\-raw001\-hello\-world.sh
              \- include\-raw001\-vars.sh

\- project:
    name: test\-job\-template\-1
    num: 1
    jobs:
      \- \(aqtest\-job\-include\-raw\-{num}\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
For all the multi file includes, the files are simply appended using a newline
character.
.sp
To allow for job templates to perform substitution on the path names, when a
filename containing a python format placeholder is encountered, lazy loading
support is enabled, where instead of returning the contents back during yaml
parsing, it is delayed until the variable substitution is performed.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- wrapper:
    !include: lazy\-load\-jobs\-timeout.yaml.inc

\- project:
    name: test
    version:
      \- 1.1
    jobs:
      \- \(aqbuild_myproject_{version}\(aq

\- job\-template:
    name: \(aqbuild_myproject_{version}\(aq
    wrappers:
      !include: lazy\-load\-wrappers\-{version}.yaml.inc
    builders:
      \- shell:
          !include\-raw: echo_vars_{version}.sh

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
using a list of files:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- wrapper:
    !include: lazy\-load\-jobs\-timeout.yaml.inc

\- project:
    name: test
    num: \(dq002\(dq
    version:
      \- 1.1
    jobs:
      \- \(aqbuild_myproject_{version}\(aq

\- job\-template:
    name: \(aqbuild_myproject_{version}\(aq
    wrappers:
      !include: lazy\-load\-wrappers\-{version}.yaml.inc
    builders:
      \- shell:
          !include\-raw:
            \- lazy\-load\-scripts/echo_vars_{version}.sh
            \- include\-raw{num}\-cool.sh

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Because lazy\-loading involves performing the substitution on the file
name, it means that jenkins\-job\-builder can not call the variable
substitution on the contents of the file. This means that the
\fB!include\-raw:\fP tag will behave as though \fB!include\-raw\-escape:\fP tag
was used instead whenever name substitution on the filename is to be
performed.
.sp
Given the behaviour described above, when substitution is to be performed
on any filename passed via \fB!include\-raw\-escape:\fP the tag will be
automatically converted to \fB!include\-raw:\fP and no escaping will be
performed.
.UNINDENT
.UNINDENT
.sp
The tag \fB!include\-jinja2:\fP will treat the given string or list of strings as
filenames to be opened as Jinja2 templates, which should be rendered to a
string and included in the calling YAML construct.  (This is analogous to the
templating that will happen with \fB!include\-raw\fP\&.)
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- builder:
    name: test\-builder
    builders:
        \- shell:
            !include\-jinja2: jinja01.yaml.inc

\- job:
    name: test\-job
    builders:
        \- test\-builder:
            var: \(dqtest variable\(dq
            test_list:
                \- a
                \- b
                \- c

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
contents of jinja01.yaml.inc:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{{ var }}
{% for item in test_list \-%}
{{ item }}
{% endfor %}

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The tag \fB!j2:\fP takes a string and treats it as a Jinja2 template.  It will be
rendered (with the variables in that context) and included in the calling YAML
construct.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- builder:
    name: test\-builder
    builders:
        \- shell:
            !j2: |
                {{ var }}
                {% for item in test_list \-%}
                {{ item }}
                {% endfor %}

\- job:
    name: test\-job
    builders:
        \- test\-builder:
            var: \(dqtest variable\(dq
            test_list:
                \- a
                \- b
                \- c

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The tag \fB!j2\-yaml:\fP is similar to the \fB!j2:\fP tag, just that it loads the
Jinja\-rendered string as YAML and embeds it in the calling YAML construct. This
provides a very flexible and convenient way of generating pieces of YAML
structures. One of use cases is defining complex YAML structures with much
simpler configuration, without any duplication.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: test\-job\-template
    triggers:
    \- gerrit:
        projects:
            !j2\-yaml: |
                {% for item in triggers %}
                \- branches:
                  \- branch\-compare\-type: PLAIN
                    branch\-pattern: \(aq{{ item.branch }}\(aq
                  project\-compare\-type: REG_EXP
                  project\-pattern: \(aq{{ item.repositories|join(\(dq|\(dq) }}\(aq
                {% endfor %}

\- project:
    name: test\-job\-project

    jobs:
    \- test\-job\-template:
        triggers:
        \- repositories:
            \- a
            \- b
            \- c
          branch: master
        \- repositories:
            \- d
            \- e
            \- f
          branch: stable

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Another use case is controlling lists dynamically, like conditionally adding
list elements based on project configuration.
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aqtest\-job\-{variant}\(aq
    properties: !j2\-yaml: |
        \- rebuild
        {% if discard_old_builds|default %}
        \- build\-discarder:
            days\-to\-keep: 7
        {% endif %}

\- project:
    name: test\-project

    jobs:
    \- \(aqtest\-job\-{variant}\(aq:
        variant: abc

    \- \(aqtest\-job\-{variant}\(aq:
        variant: def
        discard_old_builds: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Modules
.sp
The bulk of the job definitions come from the following modules.
.SS ExternalJob Project
.sp
The External Job Project module handles creating ExternalJob Jenkins projects.
You may specify \fBexternaljob\fP in the \fBproject\-type\fP attribute of the
\fI\%Job\fP definition.
.sp
This type of job allows you to record the execution of a process run outside
Jenkins, even on a remote machine. This is designed so that you can use
Jenkins as a dashboard of your existing automation system.
.sp
Requires the Jenkins \fI\%External Monitor Job Type Plugin\fP\&.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: openstack\-infra
project\-type: externaljob

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_externaljob.ExternalJob(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Flow Project
.sp
The flow Project module handles creating Jenkins flow projects.
You may specify \fBflow\fP in the \fBproject\-type\fP attribute of
the \fI\%Job\fP definition.
.sp
Requires the Jenkins \fI\%Build Flow Plugin\fP\&.
.sp
In order to use it for job\-template you have to escape the curly braces by
doubling them in the DSL: { \-> {{ , otherwise it will be interpreted by the
python str.format() command.
.INDENT 0.0
.TP
.B Job Parameters
.INDENT 7.0
.IP \(bu 2
\fBdsl\fP (\fIstr\fP): The DSL content. (optional)
.IP \(bu 2
\fBneeds\-workspace\fP (\fIbool\fP): This build needs a workspace.     (default false)
.IP \(bu 2
\fBdsl\-file\fP (\fIstr\fP): Path to the DSL script in the workspace.     Has effect only when \fIneeds\-workspace\fP is true. (optional)
.UNINDENT
.UNINDENT
.sp
Job example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
      name: test_job
      project\-type: flow
      dsl: |
        build(\(dqjob1\(dq)
        parallel (
          { build(\(dqjob2a\(dq) },
          { build(\(dqjob2b\(dq) }
        )

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Job template example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{name}\-unit\-tests\(aq
    project\-type: flow
    dsl: |
        build(\(dqjob1\(dq)
        parallel (
            {{ build(\(dqjob2a\(dq) }},
            {{ build(\(dqjob2b\(dq) }}
        )
        build(\(dqjob2c\(dq)
    builders:
    \- shell: unittest
    publishers:
    \- email:
        recipients: \(aq{mail\-to}\(aq

\- job\-group:
    name: \(aq{name}\-tests\(aq
    jobs:
    \- \(aq{name}\-unit\-tests\(aq:
        mail\-to: developer@nowhere.net

\- project:
    name: project\-name
    jobs:
    \- \(aq{name}\-tests\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Job example runninng a DSL file from the workspace:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
      name: test_job
      project\-type: flow
      needs\-workspace: true
      dsl\-file: script.groovy

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_flow.Flow(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Folder Project
.sp
The folder Project module handles creating Jenkins folder projects.
You may specify \fBfolder\fP in the \fBproject\-type\fP attribute of
the \fI\%Job\fP definition.
.sp
Requires the Jenkins \fI\%CloudBees Folders Plugin\fP\&.
.sp
Job example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: folder_test
    project\-type: folder

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Job template example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aqfolder\-{name}\(aq
    project\-type: folder

\- project:
    name: test
    jobs:
    \- \(aqfolder\-{name}\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_folder.Folder(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Freestyle Project
.sp
The Freestyle Project module handles creating freestyle Jenkins
projects (i.e., those that do not use Maven).  You may specify
\fBfreestyle\fP in the \fBproject\-type\fP attribute to the \fI\%Job\fP
definition if you wish, though it is the default, so you may omit
\fBproject\-type\fP altogether if you are creating a freestyle project.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job:
  name: test_job
  project\-type: freestyle
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_freestyle.Freestyle(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS GitHub Organization Project
.sp
The Github Organization project module handles creating Jenkins Github
Organization jobs, which are made up of multibranch pipelines for all
repositories containing the specified Jenkinsfile(s).
You may specify \fBgithuborg\fP in the \fBproject\-type\fP attribute of
the \fI\%Job\fP definition.
.sp
Plugins required:
.INDENT 0.0
.IP \(bu 2
\fI\%GitHub Branch Source Plugin\fP
.UNINDENT
.INDENT 0.0
.TP
.B Job Parameters
.INDENT 7.0
.IP \(bu 2
\fBgithub\-org\fP (\fIdict\fP): Refer to
\fI\%github_org\fP for documentation.
.IP \(bu 2
\fBperiodic\-folder\-trigger\fP (\fIstr\fP): How often to scan for new branches
or pull/change requests. Valid values: 1m, 2m, 5m, 10m, 15m, 20m, 25m,
30m, 1h, 2h, 4h, 8h, 12h, 1d, 2d, 1w, 2w, 4w. (default none)
.IP \(bu 2
\fBprune\-dead\-branches\fP (\fIbool\fP): If dead branches upon check should
result in their job being dropped. (default true)
.IP \(bu 2
\fBnumber\-to\-keep\fP (\fIint\fP): How many builds should be kept.
(default \(aq\-1, all\(aq)
.IP \(bu 2
\fBdays\-to\-keep\fP (\fIint\fP): For how many days should a build be kept.
(default \(aq\-1, forever\(aq)
.IP \(bu 2
\fBscript\-path\fP (\fIstr\fP): Path to Jenkinsfile, relative to workspace.
(default \(aqJenkinsfile\(aq)
.UNINDENT
.UNINDENT
.sp
Job examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: github\-org\-minimal
project\-type: githuborg
project: example\-project
github\-org:
    repo\-owner: example\-owner

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: githuborg\-job\-full
project\-type: githuborg
project: example\-project

periodic\-folder\-trigger: 2h
prune\-dead\-branches: false
number\-to\-keep: 10
days\-to\-keep: 90
script\-path: some.Jenkinsfile

github\-org:
    repo\-owner: example\-owner

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_githuborg.GithubOrganization(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B project_githuborg.github_org(xml_parent, data)
Configure GitHub Organization and SCM settings.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrepo\-owner\fP (\fIstr\fP) \-\- Specify the name of the GitHub Organization or
GitHub User Account. (required)
.IP \(bu 2
\fBapi\-uri\fP (\fIstr\fP) \-\- The GitHub API uri for hosted / on\-site GitHub. Must
first be configured in Global Configuration. (default GitHub)
.IP \(bu 2
\fBbranch\-discovery\fP (\fIstr\fP) \-\- Discovers branches on the repository.
Valid options: no\-pr, only\-pr, all, false. (default \(aqno\-pr\(aq)
.IP \(bu 2
\fBbuild\-strategies\fP (\fIlist\fP) \-\- Provides control over whether to build a branch
(or branch like things such as change requests and tags) whenever it is
discovered initially or a change from the previous revision has been
detected. (optional)
Refer to \fI\%~build_strategies\fP\&.
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- Credentials used to scan branches and pull
requests, check out sources and mark commit statuses. (optional)
.IP \(bu 2
\fBdiscover\-pr\-forks\-strategy\fP (\fIstr\fP) \-\- Fork strategy. Valid options:
merge\-current, current, both, false. (default \(aqmerge\-current\(aq)
.IP \(bu 2
\fBdiscover\-pr\-forks\-trust\fP (\fIstr\fP) \-\- Discovers pull requests where the origin
repository is a fork of the target repository.
Valid options: contributors, everyone, permission or nobody.
(default \(aqcontributors\(aq)
.IP \(bu 2
\fBdiscover\-pr\-origin\fP (\fIstr\fP) \-\- Discovers pull requests where the origin
repository is the same as the target repository.
Valid options: merge\-current, current, both, false.  (default \(aqmerge\-current\(aq)
.IP \(bu 2
\fBdiscover\-tags\fP (\fIbool\fP) \-\- Discovers tags on the repository.
(default false)
.IP \(bu 2
\fBhead\-pr\-filter\-behaviors\fP (\fIlist\fP) \-\- Definition of Filter Branch PR behaviors.
Requires the \fI\%SCM Filter Branch PR Plugin\fP\&. Refer to
\fI\%~add_filter_branch_pr_behaviors\fP\&.
.IP \(bu 2
\fBnotification\-context\fP (\fIstr\fP) \-\- Change the default GitHub check notification
context from \(dqcontinuous\-integration/jenkins/SUFFIX\(dq to a custom text,
Requires the \fI\%Github Custom Notification Context SCM
Behaviour\fP\&.
.IP \(bu 2
\fBproperty\-strategies\fP (\fIdict\fP) \-\- Provides control over how to build a branch
(like to disable SCM triggering or to override the pipeline durability)
(optional)
Refer to \fI\%~property_strategies\fP\&.
.IP \(bu 2
\fBssh\-checkout\fP (\fIbool\fP) \-\- 
.sp
Checkout over SSH.
.INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBcredentials\fP (\(aqstr\(aq): Credentials to use for
checkout of the repo over ssh.
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Extensions
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBclean\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBafter\fP (\fIbool\fP) \- Clean the workspace after checkout
.IP \(bu 2
\fBbefore\fP (\fIbool\fP) \- Clean the workspace before checkout
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBdepth\fP (\fIint\fP) \- Set shallow clone depth (default 1)
.IP \(bu 2
.INDENT 2.0
.TP
\fBdisable\-pr\-notifications\fP (\fIbool\fP) \- Disable default github status
notifications on pull requests (default false) (Requires the
\fI\%GitHub Branch Source Plugin\fP\&.)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBdo\-not\-fetch\-tags\fP (\fIbool\fP) \- Perform a clone without tags
(default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBlfs\-pull\fP (\fIbool\fP) \- Call git lfs pull after checkout
(default false)
.UNINDENT
.IP \(bu 2
\fBprune\fP (\fIbool\fP) \- Prune remote branches (default false)
.IP \(bu 2
\fBrefspecs\fP (\fIlist(str)\fP): Which refspecs to fetch.
.IP \(bu 2
\fBshallow\-clone\fP (\fIbool\fP) \- Perform shallow clone (default false)
.IP \(bu 2
.INDENT 2.0
.TP
\fBsparse\-checkout\fP (dict)
.INDENT 7.0
.IP \(bu 2
\fBpaths\fP (list) \- List of paths to sparse checkout. (optional)
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBsubmodule\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBdisable\fP (\fIbool\fP) \- By disabling support for submodules you
can still keep using basic git plugin functionality and just have
Jenkins to ignore submodules completely as if they didn\(aqt exist.
.IP \(bu 2
\fBrecursive\fP (\fIbool\fP) \- Retrieve all submodules recursively
(uses \(aq\-\-recursive\(aq option which requires git>=1.6.5)
.IP \(bu 2
\fBtracking\fP (\fIbool\fP) \- Retrieve the tip of the configured
branch in .gitmodules (Uses \(aq\-\-remote\(aq option which requires
git>=1.8.2)
.IP \(bu 2
\fBparent\-credentials\fP (\fIbool\fP) \- Use credentials from default
remote of parent repository (default false).
.IP \(bu 2
\fBreference\-repo\fP (\fIstr\fP) \- Path of the reference repo to use
during clone (optional)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \- Specify a timeout (in minutes) for
submodules operations (default 10).
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBtimeout\fP (\fIstr\fP) \- Timeout for git commands in minutes (optional)
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-author\fP (\fIbool\fP): Use author rather than committer in Jenkin\(aqs
build changeset (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBwipe\-workspace\fP (\fIbool\fP) \- Wipe out workspace before build
(default true)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Job examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: github\-org\-minimal
project\-type: githuborg
project: example\-project
github\-org:
    repo\-owner: example\-owner

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: github\-org\-full
project\-type: githuborg
github\-org:
        api\-uri: http://example.org/github
        ssh\-checkout:
            credentials: \(aqssh_secret\(aq
        repo\-owner: example\-owner
        credentials\-id: example\-credential
        branch\-discovery: all
        head\-filter\-regex: \(dq(.*/master|.*/release/.*)\(dq
        head\-pr\-filter\-behaviors:
            head\-pr\-destined\-regex:
                branch\-regexp: \(dqfoo/.*\(dq
                tag\-regexp: \(dq20\e\e..*\(dq
            head\-pr\-destined\-wildcard:
                branch\-includes: \(dqfoo*\(dq
                tag\-includes: \(dqqaz*\(dq
                branch\-excludes: \(dqbar*\(dq
                tag\-excludes: \(dq*baz\(dq
            head\-pr\-originated\-regex:
                branch\-regexp: \(dq(foo/.*|bar/.*)\(dq
                tag\-regexp: \(dq1\e\e..*\(dq
            head\-pr\-originated\-wildcard:
                branch\-includes: \(dqqaz*\(dq
                tag\-includes: \(dqbar*\(dq
                branch\-excludes: \(dqbaz*\(dq
                tag\-excludes: \(dq*qaz\(dq
        discover\-pr\-forks\-strategy: both
        discover\-pr\-forks\-trust: everyone
        discover\-pr\-origin: both
        discover\-tags: true
        notification\-context: \(aqjenkins.example.com/my_context\(aq
        property\-strategies:
            all\-branches:
                \- suppress\-scm\-triggering: true
                \- pipeline\-branch\-durability\-override: max\-survivability
                \- trigger\-build\-on\-pr\-comment: \(dqCi build!\(dq
                \- trigger\-build\-on\-pr\-review: true
                \- trigger\-build\-on\-pr\-update: true
        build\-strategies:
            \- all\-strategies\-match:
                strategies:
                  \- regular\-branches: true
                  \- skip\-initial\-build: true
            \- any\-strategies\-match:
                strategies:
                  \- change\-request: {}
                  \- tags: {}
            \- tags:
                ignore\-tags\-newer\-than: 1
                ignore\-tags\-older\-than: 7
            \- tags: {}
            \- change\-request:
                ignore\-target\-only\-changes: true
            \- change\-request: {}
            \- regular\-branches: true
            \- skip\-initial\-build: true
            \- named\-branches:
                \- exact\-name:
                    name: \(aqtest\(aq
                    case\-sensitive: true
                \- regex\-name:
                    regex: \(aqtest.*$\(aq
                    case\-sensitive: true
                \- wildcards\-name:
                    excludes: \(aqtestexclude\(aq
                    includes: \(aqtestinclude\(aq
            \- named\-branches:
                \- exact\-name: {}
                \- regex\-name: {}
                \- wildcards\-name: {}
        clean:
            after: true
            before: true
        committer:
            user: CI System
            email: no\-reply@ci.example.com
        prune: true
        local\-branch: true
        sparse\-checkout:
            paths:
                \- \(dqpath1\(dq
                \- \(dqpath2\(dq
                \- \(dqpath3\(dq
        shallow\-clone: true
        depth: 3
        do\-not\-fetch\-tags: true
        disable\-pr\-notifications: true
        refspecs:
          \- \(aq+refs/heads/*:refs/remotes/@{remote}/*\(aq
        submodule:
            disable: false
            recursive: true
            parent\-credentials: true
            timeout: 100
            threads: 1
        timeout: \(dq100\(dq
        skip\-notifications: true
        use\-author: true
        wipe\-workspace: true
        lfs\-pull: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Matrix Project
.sp
The matrix project module handles creating Jenkins matrix
projects. To create a matrix project specify \fBmatrix\fP in the
\fBproject\-type\fP attribute to the \fI\%Job\fP definition.
Currently it supports four axes which share the same
internal YAML structure:
.INDENT 0.0
.IP \(bu 2
label expressions (\fBlabel\-expression\fP)
.IP \(bu 2
user\-defined values (\fBuser\-defined\fP)
.IP \(bu 2
slave name or label (\fBslave\fP)
.IP \(bu 2
JDK name (\fBjdk\fP)
.UNINDENT
.sp
Requires the Jenkins \fI\%Matrix Project Plugin\fP\&.
.sp
The module also supports additional, plugin\-defined axes:
.INDENT 0.0
.IP \(bu 2
DynamicAxis (\fBdynamic\fP), requires the Jenkins
\fI\%DynamicAxis Plugin\fP
.IP \(bu 2
GroovyAxis (\fBgroovy\fP), requires the Jenkins
\fI\%GroovyAxis Plugin\fP
.IP \(bu 2
YamlAxis (\fByaml\fP), requires the Jenkins
\fI\%Yaml Axis Plugin\fP
.UNINDENT
.sp
To tie the parent job to a specific node, you should use \fBnode\fP parameter.
On a matrix project, this will tie \fIonly\fP the parent job.  To restrict axes
jobs, you can define a single value \fBslave\fP axis.
.INDENT 0.0
.TP
.B Job Parameters
.
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You can only pick one of the strategies.
.UNINDENT
.UNINDENT
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBexecution\-strategy\fP (optional, built in Jenkins):
.INDENT 7.0
.IP \(bu 2
\fBcombination\-filter\fP (\fIstr\fP): axes selection filter
.IP \(bu 2
\fBsequential\fP (\fIbool\fP): run builds sequentially (default false)
.IP \(bu 2
.INDENT 2.0
.TP
\fBtouchstone\fP (optional):
.INDENT 7.0
.IP \(bu 2
\fBexpr\fP (\fIstr\fP) \-\- selection filter for the touchstone build
.IP \(bu 2
\fBresult\fP (\fIstr\fP) \-\- required result of the job:             stable (default) or unstable
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fByaml\-strategy\fP (optional, requires
\fI\%Yaml Axis Plugin\fP):
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBexclude\-key\fP (\fIstr\fP) \-\- top key containing exclusion rules
.IP \(bu 2
Either one of:
.IP \(bu 2
\fBfilename\fP (\fIstr\fP) \-\- Yaml file containing exclusions
.IP \(bu 2
\fBtext\fP (\fIstr\fP) \-\- Inlined Yaml. Should be literal
\fBtext: | exclude:...\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBaxes\fP (\fIlist\fP):
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBaxis\fP:
.INDENT 7.0
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- axis type, must be either type defined by
\fI\%Matrix Project Plugin\fP
(\fBlabel\-expression\fP, \fBuser\-defined\fP, \fBslave\fP or \fBjdk\fP) or
a type defined by a plugin (see top of this document for a list
of supported plugins).
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- name of the axis
.IP \(bu 2
\fBvalues\fP (\fIlist\fP) \-\- values of the axis
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The module supports also ShiningPanda axes:
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: matrix\-test003
project\-type: matrix
axes:
    \- axis:
        type: python
        values:
        \- python\-2.6
        \- python\-2.7
        \- python\-3.4
    \- axis:
        type: tox
        values:
        \- py26
        \- py27
        \- py34

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Requires the Jenkins \fI\%ShiningPanda Plugin\fP\&.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: matrix\-test
    project\-type: matrix
    execution\-strategy:
      combination\-filter: |
        !(os==\(dqfedora11\(dq && arch==\(dqamd64\(dq)
      sequential: true
      touchstone:
        expr: \(aqos == \(dqfedora11\(dq\(aq
        result: unstable
    axes:
      \- axis:
         type: label\-expression
         name: os
         values:
          \- ubuntu12.04
          \- fedora11
      \- axis:
         type: label\-expression
         name: arch
         values:
          \- amd64
          \- i386
      \- axis:
         type: slave
         name: nodes
         values:
          \- node1
          \- node2
      \- axis:
         type: dynamic
         name: config
         values:
          \- config_list
      \- axis:
         type: user\-defined
         name: database
         values:
          \- mysql
          \- postgresql
          \- sqlite
      \- axis:
         type: groovy
         name: foo
         command: return [one,two,three]
    builders:
      \- shell: make && make check

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Examples for yaml axis:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: matrix\-with\-yaml\-axis
project\-type: matrix
axes:
    \- axis:
        type: yaml
        filename: config.yaml
        name: python
    \- axis:
        type: yaml
        filename: config.yaml
        name: database

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: matrix\-with\-yaml\-strategy\-and\-exclude\-in\-file
project\-type: matrix
yaml\-strategy:
    exclude\-key: \(aqexclude\(aq
    filename: \(aqexclude.yaml\(aq
axes:
    \- axis:
        type: yaml
        filename: \(aqconfig.yaml\(aq
        name: python
    \- axis:
        type: yaml
        filename: \(aqconfig.yaml\(aq
        name: database

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: matrix\-with\-yaml\-strategy\-and\-inlined\-exclude
project\-type: matrix
yaml\-strategy:
    exclude\-key: \(aqexclude\(aq
    text: |
        exclude:
            \- database: postgre
              python: py27
            \- python: py35
              database: mysql
axes:
    \- axis:
        type: yaml
        filename: config.yaml
        name: python
    \- axis:
        type: yaml
        filename: config.yaml
        name: database

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_matrix.Matrix(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Maven Project
.sp
The Maven Project module handles creating Maven Jenkins projects.
.sp
To create a Maven project, specify \fBmaven\fP in the \fBproject\-type\fP
attribute to the \fI\%Job\fP definition. It also requires a \fBmaven\fP section
in the \fI\%Job\fP definition.
.INDENT 0.0
.TP
.B Job Parameters
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBroot\-module\fP:
.INDENT 7.0
.IP \(bu 2
\fBgroup\-id\fP (\fIstr\fP): GroupId.
.IP \(bu 2
\fBartifact\-id\fP (\fIstr\fP): ArtifactId.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBroot\-pom\fP (\fIstr\fP): The path to the pom.xml file. (default \(aqpom.xml\(aq)
.IP \(bu 2
\fBgoals\fP (\fIstr\fP): Goals to execute. (required)
.IP \(bu 2
\fBmaven\-opts\fP (\fIstr\fP): Java options to pass to maven (aka MAVEN_OPTS)
.IP \(bu 2
\fBmaven\-name\fP (\fIstr\fP): Installation of maven which should be used.
Not setting \fBmaven\-name\fP appears to use the first maven install
defined in the global jenkins config.
.IP \(bu 2
\fBprivate\-repository\fP (\(aqstr\(aq): Whether to use a private maven repository
Possible values are \fIdefault\fP, \fIlocal\-to\-workspace\fP and
\fIlocal\-to\-executor\fP\&.
.IP \(bu 2
\fBignore\-upstream\-changes\fP (\fIbool\fP): Do not start a build whenever
a SNAPSHOT dependency is built or not. (default true)
.IP \(bu 2
\fBincremental\-build\fP (\fIbool\fP): Activate incremental build \- only build
changed modules (default false).
.IP \(bu 2
\fBautomatic\-archiving\fP (\fIbool\fP): Activate automatic artifact archiving
(default true).
.IP \(bu 2
\fBautomatic\-site\-archiving\fP (\fIbool\fP): Activate automatic site
documentation artifact archiving (default true).
.IP \(bu 2
\fBautomatic\-fingerprinting\fP (\fIbool\fP): Activate automatic fingerprinting
of consumed and produced artifacts (default true).
.IP \(bu 2
\fBper\-module\-email\fP (\fIbool\fP): Send an e\-mail for each failed module
(default true).
.IP \(bu 2
\fBparallel\-build\-modules\fP (\fIbool\fP): Build modules in parallel
(default false)
.IP \(bu 2
\fBresolve\-dependencies\fP (\fIbool\fP): Resolve Dependencies during Pom
parsing (default false).
.IP \(bu 2
\fBrun\-headless\fP (\fIbool\fP): Run headless (default false).
.IP \(bu 2
\fBdisable\-downstream\fP (\fIbool\fP): Disable triggering of downstream
projects (default false).
.IP \(bu 2
\fBprocess\-plugins\fP (\fIbool\fP): Process Plugins during Pom parsing
(default false).
.IP \(bu 2
\fBcustom\-workspace\fP (\fIstr\fP): Path to the custom workspace. If no path is
provided, custom workspace is not used. (optional)
.IP \(bu 2
\fBsettings\fP (\fIstr\fP): Path to custom maven settings file. If settings
type is \(aqfile\(aq then this is a Path. Otherwise it is the id for
ConfigFileProvider. (optional)
.IP \(bu 2
\fBsettings\-type\fP (\fIstr\fP): Type of settings file file|cfp.
(default file)
.IP \(bu 2
\fBglobal\-settings\fP (\fIstr\fP): Path to custom maven global settings file.
If settings type is \(aqfile\(aq then this is a Path. Otherwise it is the id
for ConfigFileProvider. (optional)
.IP \(bu 2
\fBglobal\-settings\-type\fP (\fIstr\fP): Type of settings file file|cfp.
(default file)
.IP \(bu 2
\fBpost\-step\-run\-condition\fP (\fIstr\fP): Run the post\-build steps only if the
build succeeds (\(aqSUCCESS\(aq), build succeeds or is unstable (\(aqUNSTABLE\(aq),
regardless of build result (\(aqFAILURE\(aq). (default \(aqFAILURE\(aq).
.UNINDENT
.UNINDENT
.sp
Requires the Jenkins \fI\%Config File Provider Plugin\fP
for the Config File Provider \(dqsettings\(dq and \(dqglobal\-settings\(dq config.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
project\-type: maven
maven:
  root\-pom: pom.xml
  goals: deploy
  root\-module:
    group\-id: gabba.gabba
    artifact\-id: hey
  settings: test
  global\-settings: test
  incremental\-build: true
  automatic\-archiving: false
  automatic\-site\-archiving: false
  parallel\-build\-modules: true
  resolve\-dependencies: true
  process\-plugins: true
  run\-headless: true
  disable\-downstream: true
  custom\-workspace: path/to/some/repository

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
CFP Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
project\-type: maven
maven:
  root\-pom: pom.xml
  goals: deploy
  settings: org.jenkinsci.plugins.configfiles.maven.MavenSettingsConfig0123456789012
  global\-settings: org.jenkinsci.plugins.configfiles.maven.GlobalMavenSettingsConfig0123456789012
  post\-step\-run\-condition: SUCCESS

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_maven.Maven(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS MultiJob Project
.sp
The MultiJob Project module handles creating MultiJob Jenkins projects.
You may specify \fBmultijob\fP in the \fBproject\-type\fP attribute of
the \fI\%Job\fP definition.
.sp
This project type may use \fBjenkins_jobs.modules.builders.multijob()\fP builders.
.sp
Requires the Jenkins \fI\%Multijob Plugin\fP\&.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job:
  name: test_job
  project\-type: multijob
  builders:
    \- multijob:
        name: PhaseOne
        condition: SUCCESSFUL
        projects:
          \- name: PhaseOneJobA
            current\-parameters: true
            git\-revision: true
          \- name: PhaseOneJobB
            current\-parameters: true
            property\-file: build.props
    \- multijob:
        name: PhaseTwo
        condition: UNSTABLE
        projects:
          \- name: PhaseTwoJobA
            current\-parameters: true
            predefined\-parameters: foo=bar
          \- name: PhaseTwoJobB
            current\-parameters: false
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_multijob.MultiJob(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Pipeline Project
.sp
The Pipeline Project module handles creating Jenkins Pipeline projects
(formerly known as the Workflow projects).
You may specify \fBpipeline\fP in the \fBproject\-type\fP attribute of
the \fI\%Job\fP definition.
.sp
Requires the Jenkins \fI\%Pipeline Plugin\fP\&.
.sp
In order to write an inline script within a job\-template you have to escape the
curly braces by doubling them in the DSL: { \-> {{ , otherwise it will be
interpreted by the python str.format() command.
.INDENT 0.0
.TP
.B Job Parameters
.INDENT 7.0
.IP \(bu 2
\fBsandbox\fP (\fIbool\fP): If the script should run in a sandbox (default
false)
.IP \(bu 2
\fBdsl\fP (\fIstr\fP): The DSL content or,
.IP \(bu 2
\fBpipeline\-scm\fP (\fIstr\fP): in case \(dqPipeline as code\(dq feature is used.
Then you should specify:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBscm\fP: single \fBscm\fP component (or a reference) describing the
source code repository
.IP \(bu 2
\fBscript\-path\fP: path to the Groovy file containing the job\(aqs steps
(optional, default: \fBJenkinsfile\fP)
.IP \(bu 2
\fBlightweight\-checkout\fP (\fIbool\fP): If selected, try to obtain the
Pipeline script contents directly from the SCM without performing a
full checkout. (optional, default: \fBfalse\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Note that \fBdsl\fP and \fBpipeline\-scm\fP parameters are mutually exclusive.
.sp
Inline DSL job example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: test_job
    project\-type: pipeline
    dsl: |
      build job: \(dqjob1\(dq
      parallel [
        2a: build job: \(dqjob2a\(dq,
        2b: node \(dqdummynode\(dq {
          sh \(dqecho I\(aqm alive!\(dq
        }
      ]

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Inline DSL job template example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{name}\-unit\-tests\(aq
    project\-type: pipeline
    dsl: |
        build job: \(dqjob1\(dq
        parallel [
          2a: build job: \(dqjob2a\(dq,
          2b: node \(dqdummynode\(dq {{
            sh \(dqecho {isay}\(dq
          }}
        ]

\- job\-group:
    name: \(aq{name}\-tests\(aq
    jobs:
      \- \(aq{name}\-unit\-tests\(aq:
          isay: \(aqhello\(aq

\- project:
    name: project\-name
    jobs:
    \- \(aq{name}\-tests\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\(dqPipeline as code\(dq example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: test\-job
    project\-type: pipeline
    sandbox: true
    pipeline\-scm:
      scm:
        \- hg:
            url: http://hg.example.org/test_job
            clean: true
      script\-path: Jenkinsfile.groovy
      lightweight\-checkout: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\(dqPipeline as code\(dq example using templates:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- scm:
    name: project\-scm
    scm:
      \- hg:
         url: http://hg.example.org/project
         clean: true

\- job\-template:
    name: \(aq{name}\-unit\-tests\(aq
    project\-type: pipeline
    pipeline\-scm:
      scm:
        \- project\-scm
    sandbox: true
    description: \(aqmaintainer: {maintainer}\(aq

\- job\-template:
    name: \(aq{name}\-perf\-tests\(aq
    project\-type: pipeline
    pipeline\-scm:
      scm:
        \- project\-scm
    sandbox: false
    description: \(aqmaintainer: {maintainer}\(aq

\- job\-group:
    name: \(aq{name}\-tests\(aq
    jobs:
      \- \(aq{name}\-unit\-tests\(aq:
          maintainer: dev@example.org
      \- \(aq{name}\-perf\-tests\(aq:
          maintainer: qa@example.org

\- project:
    name: project\-name
    jobs:
    \- \(aq{name}\-tests\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\(dqPipeline as nested stage\(dq example :
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{name}\-unit\-tests\(aq
    project\-type: pipeline
    dsl: |
      stage(\(aqBuild another job\(aq) {{
        build(job: \(dq{isay}\(dq)
      }}

\- job\-group:
    name: \(aq{name}\-tests\(aq
    jobs:
      \- \(aq{name}\-unit\-tests\(aq:
          isay: \(aqhello\(aq

\- project:
    name: project\-name
    jobs:
    \- \(aq{name}\-tests\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_pipeline.Pipeline(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Workflow Project
.sp
Deprecated: please use \fI\%Pipeline Project\fP instead.
.sp
The workflow Project module handles creating Jenkins workflow projects.
You may specify \fBworkflow\fP in the \fBproject\-type\fP attribute of
the \fI\%Job\fP definition.
For now only inline scripts are supported.
.sp
Requires the Jenkins \fI\%Workflow Plugin\fP\&.
.sp
In order to use it for job\-template you have to escape the curly braces by
doubling them in the DSL: { \-> {{ , otherwise it will be interpreted by the
python str.format() command.
.INDENT 0.0
.TP
.B Job Parameters
.INDENT 7.0
.IP \(bu 2
\fBdsl\fP (\fIstr\fP): The DSL content.
.IP \(bu 2
\fBsandbox\fP (\fIbool\fP): If the script should run in a sandbox (default
false)
.UNINDENT
.UNINDENT
.sp
Job example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: test_job
    project\-type: workflow
    dsl: |
      build job: \(dqjob1\(dq
      parallel [
        2a: build job: \(dqjob2a\(dq,
        2b: node \(dqdummynode\(dq {
          sh \(dqecho I\(aqm alive!\(dq
        }
      ]

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Job template example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\- job\-template:
    name: \(aq{name}\-unit\-tests\(aq
    project\-type: workflow
    dsl: |
        build job: \(dqjob1\(dq
        parallel [
          2a: build job: \(dqjob2a\(dq,
          2b: node \(dqdummynode\(dq {{
            sh \(dqecho {isay}\(dq
          }}
        ]

\- job\-group:
    name: \(aq{name}\-tests\(aq
    jobs:
      \- \(aq{name}\-unit\-tests\(aq:
          isay: \(aqhello\(aq

\- project:
    name: project\-name
    jobs:
    \- \(aq{name}\-tests\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_workflow.Workflow(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Multibranch Pipeline Project
.sp
The Multibranch Pipeline project module handles creating Jenkins workflow
projects.
You may specify \fBmultibranch\fP in the \fBproject\-type\fP attribute of
the \fI\%Job\fP definition.
.sp
Multibranch Pipeline implementantion in JJB is marked as \fBexperimental\fP
which means that there is no guarantee that its behavior (or configuration)
will not change, even between minor releases.
.sp
Plugins required:
.INDENT 0.0
.IP \(bu 2
\fI\%Workflow Plugin\fP\&.
.IP \(bu 2
\fI\%Pipeline Multibranch Defaults Plugin\fP (optional)
.IP \(bu 2
\fI\%Basic Branch Build Strategies Plugin\fP (optional)
.UNINDENT
.INDENT 0.0
.TP
.B Job Parameters
.INDENT 7.0
.IP \(bu 2
\fBscm\fP (\fIlist\fP): The SCM definition.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBbitbucket\fP (\fIdict\fP): Refer to
\fI\%~bitbucket_scm\fP for documentation.
.IP \(bu 2
\fBgerrit\fP (\fIdict\fP): Refer to
\fI\%~gerrit_scm\fP for documentation.
.IP \(bu 2
\fBgit\fP (\fIdict\fP): Refer to
\fI\%~git_scm\fP for documentation.
.IP \(bu 2
\fBgithub\fP (\fIdict\fP): Refer to
\fI\%~github_scm\fP for documentation.
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBperiodic\-folder\-trigger\fP (\fIstr\fP): How often to scan for new branches
or pull/change requests. Valid values: 1m, 2m, 5m, 10m, 15m, 20m, 25m,
30m, 1h, 2h, 4h, 8h, 12h, 1d, 2d, 1w, 2w, 4w. (default none)
.IP \(bu 2
\fBprune\-dead\-branches\fP (\fIbool\fP): If dead branches upon check should
result in their job being dropped. (default true)
.IP \(bu 2
\fBnumber\-to\-keep\fP (\fIint\fP): How many builds should be kept.
(default \(aq\-1, all\(aq)
.IP \(bu 2
\fBdays\-to\-keep\fP (\fIint\fP): For how many days should a build be kept.
(default \(aq\-1, forever\(aq)
.IP \(bu 2
\fBscript\-path\fP (\fIstr\fP): Path to Jenkinsfile, relative to workspace.
(default \(aqJenkinsfile\(aq)
.IP \(bu 2
\fBscript\-id\fP (\fIstr\fP): Script id from the global Jenkins script store
provided by the config\-file provider plugin. Mutually exclusive with
\fBscript\-path\fP option.
.IP \(bu 2
\fBsandbox\fP (\fIbool\fP): This option is strongly recommended if the
Jenkinsfile is using load to evaluate a groovy source file from an
SCM repository. Usable only with \fBscript\-id\fP option. (default \(aqfalse\(aq)
.UNINDENT
.UNINDENT
.sp
Job examples:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-defaults\(aq
project\-type: multibranch\-defaults
script\-id: my\-pipeline
sandbox: true
scm:
    \- github:
        repo: \(aqfoo\(aq
        repo\-owner: \(aqjohndoe\(aq
        credentials\-id: \(aqsecret\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-defaults\(aq
project\-type: multibranch\-defaults
scm:
    \- github:
        repo: \(aqfoo\(aq
        repo\-owner: \(aqjohndoe\(aq
        credentials\-id: \(aqsecret\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-multi\-scm\-full\(aq
description: \(aqWorkflow demo\(aq

project\-type: multibranch

periodic\-folder\-trigger: 1d
prune\-dead\-branches: True
number\-to\-keep: \(aq10\(aq
days\-to\-keep: \(aq10\(aq
script\-path: \(aqsome.Jenkinsfile\(aq
scm:
    \- bitbucket:
        repo\-owner: \(aqSANDBOX\(aq
        repo: \(aqtest\(aq
        credentials\-id: \(aqsecret\(aq
    \- git:
        url: \(aqhttps://example.com/jonhndoe/keep\-frontend.git\(aq
        credentials\-id: \(aqsecret\(aq
    \- github:
        repo: \(aqfoo\(aq
        repo\-owner: \(aqjohndoe\(aq
        credentials\-id: \(aqsecret\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_multibranch.WorkflowMultiBranch(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  project_multibranch.WorkflowMultiBranchDefaults(registry)
.UNINDENT
.INDENT 0.0
.TP
.B project_multibranch.add_filter_branch_pr_behaviors(traits, data)
Configure Filter Branch PR behaviors
.sp
Requires the \fI\%SCM Filter Branch PR Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBhead\-pr\-filter\-behaviors\fP (\fIlist\fP) \-\- 
.sp
Definition of filters.
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBhead\-pr\-destined\-regex\fP (dict): Filter by name incl. PR destined to
this branch with regexp
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBbranch\-regexp\fP (str) Regular expression to filter branches and
PRs (optional, default \(dq.*\(dq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtag\-regexp\fP (str) Regular expression to filter tags
(optional, default \(dq(?!.*)\(dq)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBhead\-pr\-destined\-wildcard\fP (dict): Filter by name incl. PR
destined to this branch with wildcard
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBbranch\-includes\fP (str) Wildcard expression to include branches
and PRs (optional, default \(dq*\(dq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtag\-includes\fP (str) Wildcard expression to include tags
(optional, default \(dq\(dq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBbranch\-excludes\fP (str) Wildcard expression to exclude branches
and PRs (optional, default \(dq\(dq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtag\-excludes\fP (str) Wildcard expression to exclude tags
(optional, default \(dq*\(dq)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBhead\-pr\-originated\-regex\fP (dict): Filter by name incl. PR destined
to this branch with regexp
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBbranch\-regexp\fP (str) Regular expression to filter branches
and PRs (optional, default \(dq.*\(dq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtag\-regexp\fP (str) Regular expression to filter tags
(optional, default \(dq(?!.*)\(dq)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBhead\-pr\-originated\-wildcard\fP (dict): Filter by name incl. PR
destined to this branch with wildcard
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBbranch\-includes\fP (str) Wildcard expression to include branches
and PRs (optional, default \(dq*\(dq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtag\-includes\fP (str) Wildcard expression to include tags
(optional, default \(dq\(dq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBbranch\-excludes\fP (str) Wildcard expression to exclude branches
and PRs (optional, default \(dq\(dq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtag\-excludes\fP (str) Wildcard expression to exclude tags
(optional, default \(dq*\(dq)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B project_multibranch.add_filter_by_name_wildcard_behaviors(traits, data)
Configure branch filtering behaviors.
.INDENT 7.0
.TP
.B Parameters
\fBfilter\-by\-name\-wildcard\fP (\fIdict\fP) \-\- 
.sp
Enable filter by name with wildcards.
Requires the \fI\%SCM API Plugin\fP\&.
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBincludes\fP (\(aqstr\(aq): Space\-separated list
of name patterns to consider. You may use * as a wildcard;
for example: \fImaster release*\fP
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBexcludes\fP (\(aqstr\(aq): Name patterns to
ignore even if matched by the includes list.
For example: \fIrelease*\fP
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B project_multibranch.bitbucket_scm(xml_parent, data)
Configure BitBucket scm
.sp
Requires the \fI\%Bitbucket Branch Source Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- The credential to use to scan BitBucket.
(required)
.IP \(bu 2
\fBrepo\-owner\fP (\fIstr\fP) \-\- Specify the name of the Bitbucket Team or Bitbucket
User Account. (required)
.IP \(bu 2
\fBrepo\fP (\fIstr\fP) \-\- The BitBucket repo. (required)
.IP \(bu 2
\fBdiscover\-tags\fP (\fIbool\fP) \-\- Discovers tags on the repository.
(default false)
.IP \(bu 2
\fBlfs\fP (\fIbool\fP) \-\- Git LFS pull after checkout.
(default false)
.IP \(bu 2
\fBserver\-url\fP (\fIstr\fP) \-\- The address of the bitbucket server. (optional)
.IP \(bu 2
\fBhead\-filter\-regex\fP (\fIstr\fP) \-\- A regular expression for filtering
discovered source branches. Requires the \fI\%SCM API
Plugin\fP\&.
.IP \(bu 2
\fBhead\-pr\-filter\-behaviors\fP (\fIlist\fP) \-\- Definition of Filter Branch PR behaviors.
Requires the \fI\%SCM Filter Branch PR Plugin\fP\&.
Refer to \fI\%~add_filter_branch_pr_behaviors\fP\&.
.IP \(bu 2
\fBdiscover\-branch\fP (\fIstr\fP) \-\- Discovers branches on the repository.
Valid options: ex\-pr, only\-pr, all.
Value is not specified by default.
.IP \(bu 2
\fBdiscover\-pr\-origin\fP (\fIstr\fP) \-\- Discovers pull requests where the origin
repository is the same as the target repository.
Valid options: mergeOnly, headOnly, mergeAndHead.
Value is not specified by default.
.IP \(bu 2
\fBdiscover\-pr\-forks\-strategy\fP (\fIstr\fP) \-\- Fork strategy. Valid options:
merge\-current, current, both, false. (default \(aqmerge\-current\(aq)
.IP \(bu 2
\fBdiscover\-pr\-forks\-trust\fP (\fIstr\fP) \-\- Discovers pull requests where the origin
repository is a fork of the target repository.
Valid options: contributors, everyone, permission or nobody.
(default \(aqcontributors\(aq)
.IP \(bu 2
\fBbuild\-strategies\fP (\fIlist\fP) \-\- Provides control over whether to build a branch
(or branch like things such as change requests and tags) whenever it is
discovered initially or a change from the previous revision has been
detected. (optional)
Refer to \fI\%~build_strategies\fP\&.
.IP \(bu 2
\fBproperty\-strategies\fP (\fIdict\fP) \-\- Provides control over how to build a branch
(like to disable SCM triggering or to override the pipeline durability)
(optional)
Refer to \fI\%~property_strategies\fP\&.
.IP \(bu 2
\fBlocal\-branch\fP (\fIbool\fP) \-\- Check out to matching local branch
If given, checkout the revision to build as HEAD on this branch.
If selected, then the branch name is computed from the remote branch
without the origin. In that case, a remote branch origin/master will
be checked out to a local branch named master, and a remote branch
origin/develop/new\-feature will be checked out to a local branch
named develop/newfeature.
Requires the \fI\%Git Plugin\fP\&.
.IP \(bu 2
\fBrefspecs\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- Which refspecs to look for.
.IP \(bu 2
\fBcheckout\-over\-ssh\fP (\fIdict\fP) \-\- 
.sp
Checkout repo over ssh.
.INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBcredentials\fP (\(aqstr\(aq): Credentials to use for
checkout of the repo over ssh.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfilter\-by\-name\-wildcard\fP (\fIdict\fP) \-\- 
.sp
Enable filter by name with wildcards.
Requires the \fI\%SCM API Plugin\fP\&.
.INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBincludes\fP (\(aqstr\(aq): Space\-separated list
of name patterns to consider. You may use * as a wildcard;
for example: \fImaster release*\fP
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBexcludes\fP (\(aqstr\(aq): Name patterns to
ignore even if matched by the includes list.
For example: \fIrelease*\fP
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Extensions
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBclean\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBafter\fP (\fIbool\fP) \- Clean the workspace after checkout
.IP \(bu 2
\fBbefore\fP (\fIbool\fP) \- Clean the workspace before checkout
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBprune\fP (\fIbool\fP) \- Prune remote branches (default false)
.IP \(bu 2
\fBshallow\-clone\fP (\fIbool\fP) \- Perform shallow clone (default false)
.IP \(bu 2
.INDENT 2.0
.TP
\fBsparse\-checkout\fP (dict)
.INDENT 7.0
.IP \(bu 2
\fBpaths\fP (list) \- List of paths to sparse checkout. (optional)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBdepth\fP (\fIint\fP) \- Set shallow clone depth (default 1)
.IP \(bu 2
.INDENT 2.0
.TP
\fBdo\-not\-fetch\-tags\fP (\fIbool\fP) \- Perform a clone without tags
(default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBsubmodule\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBdisable\fP (\fIbool\fP) \- By disabling support for submodules you
can still keep using basic git plugin functionality and just have
Jenkins to ignore submodules completely as if they didn\(aqt exist.
.IP \(bu 2
\fBrecursive\fP (\fIbool\fP) \- Retrieve all submodules recursively
(uses \(aq\-\-recursive\(aq option which requires git>=1.6.5)
.IP \(bu 2
\fBtracking\fP (\fIbool\fP) \- Retrieve the tip of the configured
branch in .gitmodules (Uses \(aq\-\-remote\(aq option which requires
git>=1.8.2)
.IP \(bu 2
\fBparent\-credentials\fP (\fIbool\fP) \- Use credentials from default
remote of parent repository (default false).
.IP \(bu 2
\fBreference\-repo\fP (\fIstr\fP) \- Path of the reference repo to use
during clone (optional)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \- Specify a timeout (in minutes) for
submodules operations (default 10).
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBtimeout\fP (\fIstr\fP) \- Timeout for git commands in minutes (optional)
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-author\fP (\fIbool\fP): Use author rather than committer in Jenkin\(aqs
build changeset (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBwipe\-workspace\fP (\fIbool\fP) \- Wipe out workspace before build
(default true)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBlfs\-pull\fP (\fIbool\fP) \- Call git lfs pull after checkout
(default false)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-bitbucket\-min\(aq
project\-type: multibranch
scm:
    \- bitbucket:
        repo\-owner: \(aqSANDBOX\(aq
        repo: \(aqtest\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-bitbucket\-min\(aq
project\-type: multibranch
script\-path: \(aqsome.Jenkinsfile\(aq
scm:
    \- bitbucket:
        credentials\-id: \(aqsecret\(aq
        repo\-owner: \(aqSANDBOX\(aq
        repo: \(aqtest\(aq
        server\-url: https://bitbucket.example.com:8080
        discover\-tags: true
        lfs: true
        head\-filter\-regex: \(aqmaster|\ed+\e.\ed+\(aq
        head\-pr\-filter\-behaviors:
            head\-pr\-destined\-regex:
                branch\-regexp: \(dqfoo/.*\(dq
                tag\-regexp: \(dq20\e\e..*\(dq
            head\-pr\-destined\-wildcard:
                branch\-includes: \(dqfoo*\(dq
                tag\-includes: \(dqqaz*\(dq
                branch\-excludes: \(dqbar*\(dq
                tag\-excludes: \(dq*baz\(dq
            head\-pr\-originated\-regex:
                branch\-regexp: \(dq(foo/.*|bar/.*)\(dq
                tag\-regexp: \(dq1\e\e..*\(dq
            head\-pr\-originated\-wildcard:
                branch\-includes: \(dqqaz*\(dq
                tag\-includes: \(dqbar*\(dq
                branch\-excludes: \(dqbaz*\(dq
                tag\-excludes: \(dq*qaz\(dq
        discover\-pr\-origin: headOnly
        discover\-branch: all
        discover\-pr\-forks\-strategy: current
        discover\-pr\-forks\-trust: everyone
        local\-branch: true
        checkout\-over\-ssh:
            credentials: \(aqssh_secret\(aq
        filter\-by\-name\-wildcard:
            includes: \(aq*\(aq
            excludes: \(aqmaster\(aq
        property\-strategies:
            all\-branches:
                \- suppress\-scm\-triggering: true
                \- pipeline\-branch\-durability\-override: max\-survivability
        refspecs:
            \- \(aq+refs/heads/*:refs/remotes/@{remote}/*\(aq
            \- \(aq+refs/tags/*:refs/remotes/@{remote}/*\(aq
        build\-strategies:
            \- all\-strategies\-match:
                strategies:
                  \- regular\-branches: true
                  \- skip\-initial\-build: true
            \- any\-strategies\-match:
                strategies:
                  \- change\-request: {}
                  \- tags: {}
            \- tags:
                ignore\-tags\-newer\-than: 1
                ignore\-tags\-older\-than: 7
            \- tags: {}
            \- change\-request:
                ignore\-target\-only\-changes: true
            \- change\-request: {}
            \- regular\-branches: true
            \- skip\-initial\-build: true
            \- named\-branches:
                \- exact\-name:
                    name: \(aqtest\(aq
                    case\-sensitive: true
                \- regex\-name:
                    regex: \(aqtest.*$\(aq
                    case\-sensitive: true
                \- wildcards\-name:
                    excludes: \(aqtestexclude\(aq
                    includes: \(aqtestinclude\(aq
            \- named\-branches:
                \- exact\-name: {}
                \- regex\-name: {}
                \- wildcards\-name: {}
        clean:
            after: true
            before: true
        committer:
            user: CI System
            email: no\-reply@ci.example.com
        prune: true
        sparse\-checkout:
            paths:
                \- \(dqpath1\(dq
                \- \(dqpath2\(dq
                \- \(dqpath3\(dq
        shallow\-clone: true
        depth: 3
        do\-not\-fetch\-tags: true
        submodule:
            disable: false
            recursive: true
            parent\-credentials: true
            timeout: 100
            threads: 1
        timeout: \(dq100\(dq
        skip\-notifications: true
        use\-author: true
        wipe\-workspace: true
        lfs\-pull: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B project_multibranch.build_strategies(xml_parent, data)
Configure Basic Branch Build Strategies.
.sp
Requires the \fI\%Basic Branch Build Strategies Plugin\fP\&.
.sp
Other build strategies can be configured via raw XML injection.
.INDENT 7.0
.TP
.B Parameters
\fBbuild\-strategies\fP (\fIlist\fP) \-\- 
.sp
Definition of build strategies.
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBall\-strategies\-match\fP (dict): All sub strategies must match for
this strategy to match.
* \fBstrategies\fP (list): Sub strategies
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBany\-strategies\-match\fP (dict): Builds whenever any of the sub
strategies match.
* \fBstrategies\fP (list): Sub strategies
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtags\fP (dict): Builds tags
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBignore\-tags\-newer\-than\fP (int) The number of days since the tag
was created before it is eligible for automatic building.
(optional, default \-1)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBignore\-tags\-older\-than\fP (int) The number of days since the tag
was created after which it is no longer eligible for automatic
building. (optional, default \-1)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBchange\-request\fP (dict): Builds change requests / pull requests
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBignore\-target\-only\-changes\fP (bool) Ignore rebuilding merge
branches when only the target branch changed.
(optional, default false)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBregular\-branches\fP (bool): Builds regular branches whenever a
change is detected. (optional, default None)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBskip\-initial\-build\fP (bool): Skip initial build on first branch
indexing. (optional, default None)
.UNINDENT
.IP \(bu 2
\fBnamed\-branches\fP (list): Builds named branches whenever a change
is detected.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBexact\-name\fP (dict) Matches the name verbatim.
.INDENT 7.0
.IP \(bu 2
\fBname\fP (str) The name to match. (optional)
.IP \(bu 2
.INDENT 2.0
.TP
\fBcase\-sensitive\fP (bool) Check this box if the name should
be matched case sensitively. (default false)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBregex\-name\fP (dict) Matches the name against a regular
expression.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBregex\fP (str) A Java regular expression to restrict the
names. Names that do not match the supplied regular
expression will be ignored. (default \fI^.*$\fP)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBcase\-sensitive\fP (bool) Check this box if the name should
be matched case sensitively. (default false)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBwildcards\-name\fP (dict) Matches the name against an
include/exclude set of wildcards.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBincludes\fP (str) Space\-separated list of name patterns to
consider. You may use \fI*\fP as a wildcard;
for example: \fImaster release*\fP (default \fI*\fP)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBexcludes\fP (str) Name patterns to ignore even if matched
by the includes list. For example: release (optional)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBraw\fP (dict): Injects raw BuildStrategy XML to use other build
strategy plugins.
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B project_multibranch.gerrit_scm(xml_parent, data)
Configure Gerrit SCM
.sp
Requires the \fI\%Gerrit Code Review Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- The git url. (required)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- The credential to use to connect to the GIT URL.
.IP \(bu 2
\fBignore\-on\-push\-notifications\fP (\fIbool\fP) \-\- If a job should not trigger upon
push notifications. (default false)
.IP \(bu 2
\fBrefspecs\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- Which refspecs to look for.
(default \fB[\(aq+refs/changes/*:refs/remotes/@{remote}/*\(aq,
\(aq+refs/heads/*:refs/remotes/@{remote}/*\(aq]\fP)
.IP \(bu 2
\fBincludes\fP (\fIstr\fP) \-\- Comma\-separated list of branches to be included.
(default \(aq*\(aq)
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \-\- Comma\-separated list of branches to be excluded.
(default \(aq\(aq)
.IP \(bu 2
\fBbuild\-strategies\fP (\fIlist\fP) \-\- Provides control over whether to build a branch
(or branch like things such as change requests and tags) whenever it is
discovered initially or a change from the previous revision has been
detected. (optional)
Refer to \fI\%~build_strategies\fP\&.
.IP \(bu 2
\fBproperty\-strategies\fP (\fIdict\fP) \-\- Provides control over how to build a branch
(like to disable SCM triggering or to override the pipeline durability)
(optional)
Refer to \fI\%~property_strategies\fP\&.
.IP \(bu 2
\fBfilter\-checks\fP (\fIdict\fP) \-\- Enable the filtering by pending checks, allowing to
discover the changes that need validation only. This feature is using
the gerrit checks plugin.
(optional)
query\-operator: Name of the query operator, supported values are:
\(aqSCHEME\(aq or \(aqID\(aq.
query\-string: Value of the query operator.
.UNINDENT
.TP
.B Extensions
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBclean\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBafter\fP (\fIbool\fP) \- Clean the workspace after checkout
.IP \(bu 2
\fBbefore\fP (\fIbool\fP) \- Clean the workspace before checkout
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBprune\fP (\fIbool\fP) \- Prune remote branches (default false)
.IP \(bu 2
\fBshallow\-clone\fP (\fIbool\fP) \- Perform shallow clone (default false)
.IP \(bu 2
.INDENT 2.0
.TP
\fBsparse\-checkout\fP (dict)
.INDENT 7.0
.IP \(bu 2
\fBpaths\fP (list) \- List of paths to sparse checkout. (optional)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBdepth\fP (\fIint\fP) \- Set shallow clone depth (default 1)
.IP \(bu 2
.INDENT 2.0
.TP
\fBdo\-not\-fetch\-tags\fP (\fIbool\fP) \- Perform a clone without tags
(default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBsubmodule\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBdisable\fP (\fIbool\fP) \- By disabling support for submodules you
can still keep using basic git plugin functionality and just have
Jenkins to ignore submodules completely as if they didn\(aqt exist.
.IP \(bu 2
\fBrecursive\fP (\fIbool\fP) \- Retrieve all submodules recursively
(uses \(aq\-\-recursive\(aq option which requires git>=1.6.5)
.IP \(bu 2
\fBtracking\fP (\fIbool\fP) \- Retrieve the tip of the configured
branch in .gitmodules (Uses \(aq\-\-remote\(aq option which requires
git>=1.8.2)
.IP \(bu 2
\fBparent\-credentials\fP (\fIbool\fP) \- Use credentials from default
remote of parent repository (default false).
.IP \(bu 2
\fBreference\-repo\fP (\fIstr\fP) \- Path of the reference repo to use
during clone (optional)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \- Specify a timeout (in minutes) for
submodules operations (default 10).
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBtimeout\fP (\fIstr\fP) \- Timeout for git commands in minutes (optional)
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-author\fP (\fIbool\fP): Use author rather than committer in Jenkin\(aqs
build changeset (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBwipe\-workspace\fP (\fIbool\fP) \- Wipe out workspace before build
(default true)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBlfs\-pull\fP (\fIbool\fP) \- Call git lfs pull after checkout
(default false)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-gerrit\-min\(aq
project\-type: multibranch
scm:
    \- gerrit:
        url: \(aqhttps://review.gerrithub.io/johndoe/foo\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-gerrit\-min\(aq
project\-type: multibranch
script\-path: some.Jenkinsfile
scm:
    \- gerrit:
        url: \(aqhttps://review.gerrithub.io/johndoe/foo\(aq
        credentials\-id: secret
        ignore\-on\-push\-notifications: true
        refspecs: \(aqrefs/heads/*\(aq
        property\-strategies:
            all\-branches:
                \- suppress\-scm\-triggering: true
                \- pipeline\-branch\-durability\-override: max\-survivability
        filter\-checks:
            query\-operator: \(aqSCHEME\(aq
            query\-string: \(aqjenkins\(aq
        build\-strategies:
            \- all\-strategies\-match:
                strategies:
                  \- regular\-branches: true
                  \- skip\-initial\-build: true
            \- any\-strategies\-match:
                strategies:
                  \- change\-request: {}
                  \- tags: {}
            \- tags:
                ignore\-tags\-newer\-than: 1
                ignore\-tags\-older\-than: 7
            \- tags: {}
            \- change\-request:
                ignore\-target\-only\-changes: true
            \- change\-request: {}
            \- regular\-branches: true
            \- skip\-initial\-build: true
            \- named\-branches:
                \- exact\-name:
                    name: \(aqtest\(aq
                    case\-sensitive: true
                \- regex\-name:
                    regex: \(aqtest.*$\(aq
                    case\-sensitive: true
                \- wildcards\-name:
                    excludes: \(aqtestexclude\(aq
                    includes: \(aqtestinclude\(aq
            \- named\-branches:
                \- exact\-name: {}
                \- regex\-name: {}
                \- wildcards\-name: {}
        clean:
            after: true
            before: true
        prune: true
        local\-branch: true
        sparse\-checkout:
            paths:
                \- \(dqpath1\(dq
                \- \(dqpath2\(dq
                \- \(dqpath3\(dq
        shallow\-clone: true
        depth: 3
        do\-not\-fetch\-tags: true
        submodule:
            disable: false
            recursive: true
            parent\-credentials: true
            timeout: 100
            threads: 1
        timeout: \(dq100\(dq
        use\-author: true
        wipe\-workspace: true
        lfs\-pull: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B project_multibranch.git_scm(xml_parent, data)
Configure Git SCM
.sp
Requires the \fI\%Git Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- The git repo url. (required)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- The credential to use to connect to the GIT repo.
(default \(aq\(aq)
.IP \(bu 2
\fBdiscover\-branches\fP (\fIbool\fP) \-\- Discovers branches on the repository.
(default true)
.IP \(bu 2
\fBdiscover\-tags\fP (\fIbool\fP) \-\- Discovers tags on the repository.
(default false)
.IP \(bu 2
\fBignore\-on\-push\-notifications\fP (\fIbool\fP) \-\- If a job should not trigger upon
push notifications. (default false)
.IP \(bu 2
\fBhead\-filter\-regex\fP (\fIstr\fP) \-\- A regular expression for filtering
discovered source branches. Requires the \fI\%SCM API
Plugin\fP\&.
.IP \(bu 2
\fBhead\-pr\-filter\-behaviors\fP (\fIlist\fP) \-\- Definition of Filter Branch PR behaviors.
Requires the \fI\%SCM Filter Branch PR Plugin\fP\&.
Refer to \fI\%~add_filter_branch_pr_behaviors\fP\&.
.IP \(bu 2
\fBbuild\-strategies\fP (\fIlist\fP) \-\- Provides control over whether to build a branch
(or branch like things such as change requests and tags) whenever it is
discovered initially or a change from the previous revision has been
detected. (optional)
Refer to \fI\%~build_strategies\fP\&.
.IP \(bu 2
\fBproperty\-strategies\fP (\fIdict\fP) \-\- Provides control over how to build a branch
(like to disable SCM triggering or to override the pipeline durability)
(optional)
Refer to \fI\%~property_strategies\fP\&.
.UNINDENT
.TP
.B Extensions
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBclean\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBafter\fP (\fIbool\fP) \- Clean the workspace after checkout
.IP \(bu 2
\fBbefore\fP (\fIbool\fP) \- Clean the workspace before checkout
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBprune\fP (\fIbool\fP) \- Prune remote branches (default false)
.IP \(bu 2
\fBshallow\-clone\fP (\fIbool\fP) \- Perform shallow clone (default false)
.IP \(bu 2
.INDENT 2.0
.TP
\fBsparse\-checkout\fP (dict)
.INDENT 7.0
.IP \(bu 2
\fBpaths\fP (list) \- List of paths to sparse checkout. (optional)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBdepth\fP (\fIint\fP) \- Set shallow clone depth (default 1)
.IP \(bu 2
.INDENT 2.0
.TP
\fBdo\-not\-fetch\-tags\fP (\fIbool\fP) \- Perform a clone without tags
(default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBsubmodule\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBdisable\fP (\fIbool\fP) \- By disabling support for submodules you
can still keep using basic git plugin functionality and just have
Jenkins to ignore submodules completely as if they didn\(aqt exist.
.IP \(bu 2
\fBrecursive\fP (\fIbool\fP) \- Retrieve all submodules recursively
(uses \(aq\-\-recursive\(aq option which requires git>=1.6.5)
.IP \(bu 2
\fBtracking\fP (\fIbool\fP) \- Retrieve the tip of the configured
branch in .gitmodules (Uses \(aq\-\-remote\(aq option which requires
git>=1.8.2)
.IP \(bu 2
\fBparent\-credentials\fP (\fIbool\fP) \- Use credentials from default
remote of parent repository (default false).
.IP \(bu 2
\fBreference\-repo\fP (\fIstr\fP) \- Path of the reference repo to use
during clone (optional)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \- Specify a timeout (in minutes) for
submodules operations (default 10).
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBtimeout\fP (\fIstr\fP) \- Timeout for git commands in minutes (optional)
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-author\fP (\fIbool\fP): Use author rather than committer in Jenkin\(aqs
build changeset (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBwipe\-workspace\fP (\fIbool\fP) \- Wipe out workspace before build
(default true)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBlfs\-pull\fP (\fIbool\fP) \- Call git lfs pull after checkout
(default false)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-git\-min\(aq
project\-type: multibranch
scm:
    \- git:
        url: \(aqhttps://example.com/jonhndoe/keep\-frontend.git\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-git\-min\(aq
project\-type: multibranch
script\-path: some.Jenkinsfile
scm:
    \- git:
        url: \(aqhttps://example.com/jonhndoe/keep\-frontend.git\(aq
        credentials\-id: secret
        discover\-branches: false
        ignore\-on\-push\-notifications: true
        discover\-tags: true
        head\-filter\-regex: \(aqmaster|\ed+\e.\ed+\(aq
        head\-pr\-filter\-behaviors:
            head\-pr\-destined\-regex:
                branch\-regexp: \(dqfoo/.*\(dq
                tag\-regexp: \(dq20\e\e..*\(dq
            head\-pr\-destined\-wildcard:
                branch\-includes: \(dqfoo*\(dq
                tag\-includes: \(dqqaz*\(dq
                branch\-excludes: \(dqbar*\(dq
                tag\-excludes: \(dq*baz\(dq
            head\-pr\-originated\-regex:
                branch\-regexp: \(dq(foo/.*|bar/.*)\(dq
                tag\-regexp: \(dq1\e\e..*\(dq
            head\-pr\-originated\-wildcard:
                branch\-includes: \(dqqaz*\(dq
                tag\-includes: \(dqbar*\(dq
                branch\-excludes: \(dqbaz*\(dq
                tag\-excludes: \(dq*qaz\(dq
        property\-strategies:
            all\-branches:
                \- suppress\-scm\-triggering: true
                \- pipeline\-branch\-durability\-override: max\-survivability
        build\-strategies:
            \- all\-strategies\-match:
                strategies:
                  \- regular\-branches: true
                  \- skip\-initial\-build: true
            \- any\-strategies\-match:
                strategies:
                  \- change\-request: {}
                  \- tags: {}
            \- tags:
                ignore\-tags\-newer\-than: 1
                ignore\-tags\-older\-than: 7
            \- tags: {}
            \- change\-request:
                ignore\-target\-only\-changes: true
            \- change\-request: {}
            \- regular\-branches: true
            \- skip\-initial\-build: true
            \- named\-branches:
                \- exact\-name:
                    name: \(aqtest\(aq
                    case\-sensitive: true
                \- regex\-name:
                    regex: \(aqtest.*$\(aq
                    case\-sensitive: true
                \- wildcards\-name:
                    excludes: \(aqtestexclude\(aq
                    includes: \(aqtestinclude\(aq
            \- named\-branches:
                \- exact\-name: {}
                \- regex\-name: {}
                \- wildcards\-name: {}
            \- raw:
                xml: |
                  <com.igalg.jenkins.plugins.multibranch.buildstrategy.IncludeRegionBranchBuildStrategy plugin=\(dqmultibranch\-build\-strategy\-extension\(dq>
                    <includedRegions>my/cool/project/*.cpp</includedRegions>
                  </com.igalg.jenkins.plugins.multibranch.buildstrategy.IncludeRegionBranchBuildStrategy>
        clean:
            after: true
            before: true
        prune: true
        local\-branch: true
        sparse\-checkout:
            paths:
                \- \(dqpath1\(dq
                \- \(dqpath2\(dq
                \- \(dqpath3\(dq
        shallow\-clone: true
        depth: 3
        do\-not\-fetch\-tags: true
        submodule:
            disable: false
            recursive: true
            parent\-credentials: true
            timeout: 100
            threads: 1
        timeout: \(dq100\(dq
        use\-author: true
        wipe\-workspace: true
        lfs\-pull: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B project_multibranch.github_scm(xml_parent, data)
Configure GitHub SCM
.sp
Requires the \fI\%GitHub Branch Source Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-uri\fP (\fIstr\fP) \-\- The GitHub API uri for hosted / on\-site GitHub. Must
first be configured in Global Configuration. (default GitHub)
.IP \(bu 2
\fBssh\-checkout\fP (\fIbool\fP) \-\- 
.sp
Checkout over SSH.
.INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBcredentials\fP (\(aqstr\(aq): Credentials to use for
checkout of the repo over ssh.
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- Credentials used to scan branches and pull
requests, check out sources and mark commit statuses. (optional)
.IP \(bu 2
\fBrepo\-owner\fP (\fIstr\fP) \-\- Specify the name of the GitHub Organization or
GitHub User Account. (required)
.IP \(bu 2
\fBrepo\fP (\fIstr\fP) \-\- The GitHub repo. (required)
.IP \(bu 2
\fBbranch\-discovery\fP (\fIstr\fP) \-\- Discovers branches on the repository.
Valid options: no\-pr, only\-pr, all, false. (default \(aqno\-pr\(aq)
.IP \(bu 2
\fBdiscover\-pr\-forks\-strategy\fP (\fIstr\fP) \-\- Fork strategy. Valid options:
merge\-current, current, both, false. (default \(aqmerge\-current\(aq)
.IP \(bu 2
\fBdiscover\-pr\-forks\-trust\fP (\fIstr\fP) \-\- Discovers pull requests where the origin
repository is a fork of the target repository.
Valid options: contributors, everyone, permission or nobody.
(default \(aqcontributors\(aq)
.IP \(bu 2
\fBdiscover\-pr\-origin\fP (\fIstr\fP) \-\- Discovers pull requests where the origin
repository is the same as the target repository.
Valid options: merge\-current, current, both, false.  (default \(aqmerge\-current\(aq)
.IP \(bu 2
\fBdiscover\-tags\fP (\fIbool\fP) \-\- Discovers tags on the repository.
(default false)
.IP \(bu 2
\fBhead\-pr\-filter\-behaviors\fP (\fIlist\fP) \-\- Definition of Filter Branch PR behaviors.
Requires the \fI\%SCM Filter Branch PR Plugin\fP\&.
Refer to \fI\%~add_filter_branch_pr_behaviors\fP\&.
.IP \(bu 2
\fBbuild\-strategies\fP (\fIlist\fP) \-\- Provides control over whether to build a branch
(or branch like things such as change requests and tags) whenever it is
discovered initially or a change from the previous revision has been
detected. (optional)
Refer to \fI\%~build_strategies\fP\&.
.IP \(bu 2
\fBnotification\-context\fP (\fIstr\fP) \-\- Change the default GitHub check notification
context from \(dqcontinuous\-integration/jenkins/SUFFIX\(dq to a custom text,
Requires the \fI\%Github Custom Notification Context SCM
Behaviour\fP\&.
.IP \(bu 2
\fBproperty\-strategies\fP (\fIdict\fP) \-\- Provides control over how to build a branch
(like to disable SCM triggering or to override the pipeline durability)
(optional)
Refer to \fI\%~property_strategies\fP\&.
.IP \(bu 2
\fBfilter\-by\-name\-wildcard\fP (\fIdict\fP) \-\- 
.sp
Enable filter by name with wildcards.
Requires the \fI\%SCM API Plugin\fP\&.
.INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBincludes\fP (\(aqstr\(aq): Space\-separated list
of name patterns to consider. You may use * as a wildcard;
for example: \fImaster release*\fP
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBexcludes\fP (\(aqstr\(aq): Name patterns to
ignore even if matched by the includes list.
For example: \fIrelease*\fP
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Extensions
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBclean\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBafter\fP (\fIbool\fP) \- Clean the workspace after checkout
.IP \(bu 2
\fBbefore\fP (\fIbool\fP) \- Clean the workspace before checkout
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBprune\fP (\fIbool\fP) \- Prune remote branches (default false)
.IP \(bu 2
\fBshallow\-clone\fP (\fIbool\fP) \- Perform shallow clone (default false)
.IP \(bu 2
.INDENT 2.0
.TP
\fBsparse\-checkout\fP (dict)
.INDENT 7.0
.IP \(bu 2
\fBpaths\fP (list) \- List of paths to sparse checkout. (optional)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBdepth\fP (\fIint\fP) \- Set shallow clone depth (default 1)
.IP \(bu 2
.INDENT 2.0
.TP
\fBdo\-not\-fetch\-tags\fP (\fIbool\fP) \- Perform a clone without tags
(default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBdisable\-pr\-notifications\fP (\fIbool\fP) \- Disable default github status
notifications on pull requests (default false) (Requires the
\fI\%GitHub Branch Source Plugin\fP\&.)
.UNINDENT
.IP \(bu 2
\fBrefspecs\fP (\fIlist(str)\fP): Which refspecs to fetch.
.IP \(bu 2
.INDENT 2.0
.TP
\fBsubmodule\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBdisable\fP (\fIbool\fP) \- By disabling support for submodules you
can still keep using basic git plugin functionality and just have
Jenkins to ignore submodules completely as if they didn\(aqt exist.
.IP \(bu 2
\fBrecursive\fP (\fIbool\fP) \- Retrieve all submodules recursively
(uses \(aq\-\-recursive\(aq option which requires git>=1.6.5)
.IP \(bu 2
\fBtracking\fP (\fIbool\fP) \- Retrieve the tip of the configured
branch in .gitmodules (Uses \(aq\-\-remote\(aq option which requires
git>=1.8.2)
.IP \(bu 2
\fBparent\-credentials\fP (\fIbool\fP) \- Use credentials from default
remote of parent repository (default false).
.IP \(bu 2
\fBreference\-repo\fP (\fIstr\fP) \- Path of the reference repo to use
during clone (optional)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \- Specify a timeout (in minutes) for
submodules operations (default 10).
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBtimeout\fP (\fIstr\fP) \- Timeout for git commands in minutes (optional)
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-author\fP (\fIbool\fP): Use author rather than committer in Jenkin\(aqs
build changeset (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBwipe\-workspace\fP (\fIbool\fP) \- Wipe out workspace before build
(default true)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBlfs\-pull\fP (\fIbool\fP) \- Call git lfs pull after checkout
(default false)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: \(aqdemo\-multibranch\-github\-min\(aq
project\-type: multibranch
scm:
    \- github:
        repo: \(aqfoo\(aq
        repo\-owner: \(aqjohndoe\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
name: scm\-github\-full
project\-type: multibranch
script\-path: some.Jenkinsfile
scm:
    \- github:
        api\-uri: http://example.org/github
        ssh\-checkout:
            credentials: \(aqssh_secret\(aq
        repo: example\-repo
        repo\-owner: example\-owner
        credentials\-id: example\-credential
        branch\-discovery: all
        head\-filter\-regex: \(dq(.*/master|.*/release/.*)\(dq
        head\-pr\-filter\-behaviors:
            head\-pr\-destined\-regex:
                branch\-regexp: \(dqfoo/.*\(dq
                tag\-regexp: \(dq20\e\e..*\(dq
            head\-pr\-destined\-wildcard:
                branch\-includes: \(dqfoo*\(dq
                tag\-includes: \(dqqaz*\(dq
                branch\-excludes: \(dqbar*\(dq
                tag\-excludes: \(dq*baz\(dq
            head\-pr\-originated\-regex:
                branch\-regexp: \(dq(foo/.*|bar/.*)\(dq
                tag\-regexp: \(dq1\e\e..*\(dq
            head\-pr\-originated\-wildcard:
                branch\-includes: \(dqqaz*\(dq
                tag\-includes: \(dqbar*\(dq
                branch\-excludes: \(dqbaz*\(dq
                tag\-excludes: \(dq*qaz\(dq
        discover\-pr\-forks\-strategy: both
        discover\-pr\-forks\-trust: everyone
        discover\-pr\-origin: both
        discover\-tags: true
        notification\-context: \(aqjenkins.example.com/my_context\(aq
        property\-strategies:
            all\-branches:
                \- suppress\-scm\-triggering: true
                \- pipeline\-branch\-durability\-override: max\-survivability
                \- trigger\-build\-on\-pr\-comment: \(dqCi build!\(dq
                \- trigger\-build\-on\-pr\-review: true
                \- trigger\-build\-on\-pr\-update: true
        build\-strategies:
            \- all\-strategies\-match:
                strategies:
                  \- regular\-branches: true
                  \- skip\-initial\-build: true
            \- any\-strategies\-match:
                strategies:
                  \- change\-request: {}
                  \- tags: {}
            \- tags:
                ignore\-tags\-newer\-than: 1
                ignore\-tags\-older\-than: 7
            \- tags: {}
            \- change\-request:
                ignore\-target\-only\-changes: true
            \- change\-request: {}
            \- regular\-branches: true
            \- skip\-initial\-build: true
            \- named\-branches:
                \- exact\-name:
                    name: \(aqtest\(aq
                    case\-sensitive: true
                \- regex\-name:
                    regex: \(aqtest.*$\(aq
                    case\-sensitive: true
                \- wildcards\-name:
                    excludes: \(aqtestexclude\(aq
                    includes: \(aqtestinclude\(aq
            \- named\-branches:
                \- exact\-name: {}
                \- regex\-name: {}
                \- wildcards\-name: {}
        clean:
            after: true
            before: true
        committer:
            user: CI System
            email: no\-reply@ci.example.com
        prune: true
        local\-branch: true
        sparse\-checkout:
            paths:
                \- \(dqpath1\(dq
                \- \(dqpath2\(dq
                \- \(dqpath3\(dq
        shallow\-clone: true
        depth: 3
        do\-not\-fetch\-tags: true
        disable\-pr\-notifications: true
        refspecs:
          \- \(aq+refs/heads/*:refs/remotes/@{remote}/*\(aq
        submodule:
            disable: false
            recursive: true
            parent\-credentials: true
            timeout: 100
            threads: 1
        timeout: \(dq100\(dq
        skip\-notifications: true
        use\-author: true
        wipe\-workspace: true
        lfs\-pull: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B project_multibranch.property_strategies(xml_parent, data)
Configure Basic Branch Property Strategies.
.sp
Requires the \fI\%Branch API Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBproperty\-strategies\fP (\fIdict\fP) \-\- 
.sp
Definition of property strategies.  Either
\fInamed\-branches\fP or \fIall\-branches\fP may be specified, but not both.
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBall\-branches\fP (list): A list of property strategy definitions
for use with all branches.
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBsuppress\-scm\-triggering\fP (bool): Suppresses automatic SCM
triggering (optional)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBpipeline\-branch\-durability\-override\fP (str): Set a custom
branch speed/durability level. Valid values:
performance\-optimized, survivable\-nonatomic, or
max\-survivability (optional)
Requires the \fI\%Pipeline Multibranch Plugin\fP
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtrigger\-build\-on\-pr\-comment\fP (str): The comment body to
trigger a new build for a PR job when it is received. This
is compiled as a case insensitive regular expression, so
use \fB\(dq.*\(dq\fP to trigger a build on any comment whatsoever.
(optional)
Requires the \fI\%GitHub PR Comment Build Plugin\fP
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtrigger\-build\-on\-pr\-review\fP (bool): This property will
cause a job for a pull request \fB(PR\-*)\fP to be triggered
immediately when a review is made on the PR in GitHub.
This has no effect on jobs that are not for pull requests.
(optional)
Requires the \fI\%GitHub PR Comment Build Plugin\fP
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtrigger\-build\-on\-pr\-update\fP (bool): This property will
cause a job for a pull request \fB(PR\-*)\fP to be triggered
immediately when the PR title or description is edited in
GitHub. This has no effect on jobs that are not for pull
requests. (optional)
Requires the \fI\%GitHub PR Comment Build Plugin\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnamed\-branches\fP (dict): Named branches get different properties.
Comprised of a list of defaults and a list of property strategy
exceptions for use with specific branches.
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBdefaults\fP (list): A list of property strategy definitions
to be applied by default to all branches, unless overridden
by an entry in \fIexceptions\fP
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBsuppress\-scm\-triggering\fP (bool): Suppresses automatic SCM
triggering (optional)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBpipeline\-branch\-durability\-override\fP (str): Set a custom
branch speed/durability level. Valid values:
performance\-optimized, survivable\-nonatomic, or
max\-survivability (optional)
Requires the \fI\%Pipeline Multibranch Plugin\fP
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtrigger\-build\-on\-pr\-comment\fP (str): The comment body to
trigger a new build for a PR job when it is received. This
is compiled as a case insensitive regular expression, so
use \fB\(dq.*\(dq\fP to trigger a build on any comment whatsoever.
(optional)
Requires the \fI\%GitHub PR Comment Build Plugin\fP
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtrigger\-build\-on\-pr\-review\fP (bool): This property will
cause a job for a pull request \fB(PR\-*)\fP to be triggered
immediately when a review is made on the PR in GitHub.
This has no effect on jobs that are not for pull requests.
(optional)
Requires the \fI\%GitHub PR Comment Build Plugin\fP
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtrigger\-build\-on\-pr\-update\fP (bool): This property will
cause a job for a pull request \fB(PR\-*)\fP to be triggered
immediately when the PR title or description is edited in
GitHub. This has no effect on jobs that are not for pull
requests. (optional)
Requires the \fI\%GitHub PR Comment Build Plugin\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBexceptions\fP (list): A list of branch names and the property
strategies to be used on that branch, instead of any listed
in \fIdefaults\fP\&.
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBexception\fP (dict): Defines exception
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBbranch\-name\fP (str): Name of the branch to which these
properties will be applied.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBproperties\fP (list): A list of properties to apply to
this branch.
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBsuppress\-scm\-triggering\fP (bool): Suppresses
automatic SCM triggering (optional)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBpipeline\-branch\-durability\-override\fP (str): Set a
custom branch speed/durability level. Valid values:
performance\-optimized, survivable\-nonatomic, or
max\-survivability (optional)
Requires the \fI\%Pipeline
Multibranch Plugin\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.SS Delivery Pipeline View
.sp
The view delivery pipeline module handles creation of Delivery Pipeline views.
To create a delivery pipeline view specify \fBdelivery_pipeline\fP in the
\fBview\-type\fP attribute to the \fI\%Delivery Pipeline View\fP definition.
Requires the Jenkins \fI\%Delivery Pipeline Plugin\fP\&.
.INDENT 0.0
.TP
.B View Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP): The name of the view.
.IP \(bu 2
\fBview\-type\fP (\fIstr\fP): The type of view.
.IP \(bu 2
\fBdescription\fP (\fIstr\fP): A description of the view. (optional)
.IP \(bu 2
\fBfilter\-executors\fP (\fIbool\fP): Show only executors that can
execute the included views. (default false)
.IP \(bu 2
\fBfilter\-queue\fP (\fIbool\fP): Show only included jobs in builder
queue. (default false)
.IP \(bu 2
.INDENT 2.0
.TP
\fBcomponents\fP (\fIlist\fP):
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP): Name of the pipeline, usually the name of the
component or product.
.IP \(bu 2
\fBinitial\-job\fP (\fIstr\fP): First job in the pipeline.
.IP \(bu 2
\fBfinal\-job\fP (\fIstr\fP): Final job to display in the pipeline view
regardless of its downstream jobs. (default \(aq\(aq)
.IP \(bu 2
\fBshow\-upstream\fP (\fIbool\fP): Whether to show upstream. (default false)
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBregexps\fP (\fIlist\fP):
.INDENT 7.0
.IP \(bu 2
\fBregexp\fP (\fIstr\fP): Regular expression to find initial jobs.
.IP \(bu 2
\fBshow\-upstream\fP (\fIbool\fP): Whether to show upstream. (default false)
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBaggregated\-changes\-grouping\-pattern\fP (\fIstr\fP): Group changelog by regex
pattern. (default \(aq\(aq)
.IP \(bu 2
\fBallow\-abort\fP (\fIbool\fP): Allow cancelling a running job from the
delivery pipeline view. (default false)
.IP \(bu 2
\fBallow\-manual\-triggers\fP (\fIbool\fP): Displays a button in the pipeline
view if a task is manual (Build other projects (manual step)) from Build
Pipeline Plugin. (default false)
.IP \(bu 2
\fBallow\-pipeline\-start\fP (\fIbool\fP): Allow starting a new pipeline run from
the delivery pipeline view. (default false)
.IP \(bu 2
\fBallow\-rebuild\fP (\fIbool\fP): Allow rerunning a task from the delivery
pipeline view. (default false)
.IP \(bu 2
\fBlink\-relative\fP (\fIbool\fP): Use relative links for jobs in this pipeline
view to allow for easier navigation. (default false)
.IP \(bu 2
\fBlink\-to\-console\-log\fP (\fIbool\fP): Changes behaviour of task link in
delivery pipeline view to go directly to the console log. (default false)
.IP \(bu 2
\fBmax\-number\-of\-visible\-pipelines\fP (\fIint\fP): Limits the number of
pipelines shown in the view, regardless of how many pipelines are
configured. A negative value will not enforce a limit.
.IP \(bu 2
\fBno\-of\-columns\fP (\fIint\fP): Number of columns used for showing pipelines.
Possible values are 1 (default), 2 and 3.
.IP \(bu 2
\fBno\-of\-pipelines\fP (\fIint\fP): Number of pipelines instances shown for each
pipeline. Possible values are numbers from 1 to 50 (default 3).
.IP \(bu 2
\fBpaging\-enabled\fP (\fIbool\fP): Enable pagination in normal view, to allow
navigation to older pipeline runs which are not displayed on the first
page. Not available in full screen view. (default false)
.IP \(bu 2
\fBshow\-absolute\-date\-time\fP (\fIbool\fP): Show dates and times as absolute
values instead of as relative to the current time. (default false)
.IP \(bu 2
\fBshow\-aggregated\-changes\fP (\fIbool\fP): Show an aggregated changelog
between different stages. (default false)
.IP \(bu 2
\fBshow\-aggregated\-pipeline\fP (\fIbool\fP): Show an aggregated view where each
stage shows the latest version being executed. (default false)
.IP \(bu 2
\fBshow\-avatars\fP (\fIbool\fP): Show avatars pictures instead of names of the
people involved in a pipeline instance. (default false)
.IP \(bu 2
\fBshow\-changes\fP (\fIbool\fP): Show SCM change log for the first job in the
pipeline. (default false)
.IP \(bu 2
\fBshow\-description\fP (\fIbool\fP): Show a build description connected to a
specific pipeline task. (default false)
.IP \(bu 2
\fBshow\-promotions\fP (\fIbool\fP): Show promotions from Promoted Builds
Plugin. (default false)
.IP \(bu 2
\fBshow\-static\-analysis\-results\fP (\fIbool\fP): Show different analysis
results from Analysis Collector Plugin. (default false)
.IP \(bu 2
\fBshow\-test\-results\fP (\fIbool\fP): Show test results as pass/failed/skipped.
(default false)
.IP \(bu 2
\fBshow\-total\-build\-time\fP (\fIbool\fP): Show total build time for a pipeline
run. (default false)
.IP \(bu 2
\fBsorting\fP (\fIstr\fP): How to sort the pipelines in the current view. Only
applicable when multiple pipelines are configured in the same view.
Possible values are \(aqnone\(aq (default), \(aqtitle\(aq (sort by title),
\(aqfailed_last_activity\(aq (sort by failed pipelines, then by last activity),
\(aqlast_activity\(aq (sort by last activity).
.IP \(bu 2
\fBupdate\-interval\fP (\fIint\fP): How often the pipeline view will be updated.
To be specified in seconds. (default 2)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: Test pipeline
description: Test jobs created by JJB.
view\-type: delivery_pipeline
components:
  \- name: Test
    initial\-job: Test\-A

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: Test pipeline
description: Test jobs created by JJB.
view\-type: delivery_pipeline
components:
  \- name: Test
    initial\-job: Test\-A
regexps:
  \- regexp: ^Test\-A
no\-of\-pipelines: 1
allow\-manual\-triggers: yes
show\-total\-build\-time: yes
allow\-rebuild: yes
allow\-pipeline\-start: yes
allow\-abort: yes
paging\-enabled: yes
link\-to\-console\-log: yes

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  view_delivery_pipeline.DeliveryPipeline(registry)
.UNINDENT
.SS List View
.sp
The view list module handles creating Jenkins List views.
.sp
To create a list view specify \fBlist\fP in the \fBview\-type\fP attribute
to the \fI\%List View\fP definition.
.INDENT 0.0
.TP
.B View Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP): The name of the view.
.IP \(bu 2
\fBview\-type\fP (\fIstr\fP): The type of view.
.IP \(bu 2
\fBdescription\fP (\fIstr\fP): A description of the view. (default \(aq\(aq)
.IP \(bu 2
\fBfilter\-executors\fP (\fIbool\fP): Show only executors that can
execute the included views. (default false)
.IP \(bu 2
\fBfilter\-queue\fP (\fIbool\fP): Show only included jobs in builder
queue. (default false)
.IP \(bu 2
\fBjob\-name\fP (\fIlist\fP): List of jobs to be included.
.IP \(bu 2
\fBjob\-filters\fP (\fIdict\fP): Job filters to be included. Requires
\fI\%View Job Filters\fP
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBmost\-recent\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B most\-recent
.INDENT 7.0
.IP \(bu 2
\fBmax\-to\-include\fP (\fIint\fP): Maximum number of jobs
to include. (default 0)
.IP \(bu 2
\fBcheck\-start\-time\fP (\fIbool\fP): Check job start
time. (default false)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBbuild\-duration\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B build\-duration
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter
to include. (default includeMatched)
.IP \(bu 2
\fBbuild\-duration\-type\fP (\(aqstr\(aq): Duration of the
build. (default Latest)
.IP \(bu 2
\fBamount\-type\fP: (\(aqstr\(aq): Duration in hours,
days or builds. (default Hours)
.IP \(bu 2
\fBamount\fP: (\(aqint\(aq): How far back to check.
(default 0)
.IP \(bu 2
\fBless\-than\fP: (\(aqbool\(aq): Check build duration
less than or more than. (default True)
.IP \(bu 2
\fBbuild\-duration\-minutes\fP: (\(aqint\(aq): Build
duration minutes. (default 0)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBbuild\-trend\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B build\-trend
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter
to include. (default includeMatched)
.IP \(bu 2
\fBbuild\-trend\-type\fP (\(aqstr\(aq): Duration of the
build. (default Latest)
.IP \(bu 2
\fBamount\-type\fP: (\(aqstr\(aq): Duration in hours,
days or builds. (default Hours)
.IP \(bu 2
\fBamount\fP: (\(aqint\(aq): How far back to check.
(default 0)
.IP \(bu 2
\fBstatus\fP: (\(aqstr\(aq): Job status.
(default Completed)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBjob\-status\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B job\-status
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter
to include. (default includeMatched)
.IP \(bu 2
\fBunstable\fP (\(aqbool\(aq): Jobs with status
unstable. (default False)
.IP \(bu 2
\fBfailed\fP (\(aqbool\(aq): Jobs with status
failed. (default False)
.IP \(bu 2
\fBaborted\fP (\(aqbool\(aq): Jobs with status
aborted. (default False)
.IP \(bu 2
\fBdisabled\fP (\(aqbool\(aq): Jobs with status
disabled. (default False)
.IP \(bu 2
\fBstable\fP (\(aqbool\(aq): Jobs with status
stable. (default False)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfallback\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B fallback
.INDENT 7.0
.IP \(bu 2
\fBfallback\-type\fP (\(aqstr\(aq): Fallback type to include/exclude
for all jobs in a view, if no jobs have been included by
previous filters. (default REMOVE_ALL_IF_ALL_INCLUDED)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBbuild\-status\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B build\-status
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter
to include. (default includeMatched)
.IP \(bu 2
\fBnever\-built\fP (\(aqbool\(aq): Jobs that are never
built. (default False)
.IP \(bu 2
\fBbuilding\fP (\(aqbool\(aq): Jobs that are being
built. (default False)
.IP \(bu 2
\fBin\-build\-queue\fP (\(aqbool\(aq): Jobs that are in
the build queue. (default False)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBuser\-relevence\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B user\-relevence
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter
to include. (default includeMatched)
.IP \(bu 2
\fBbuild\-count\fP (\(aqstr\(aq): Count of builds.
(default AtLeastOne)
.IP \(bu 2
\fBamount\-type\fP: (\(aqstr\(aq): Duration in hours,
days or builds. (default Hours)
.IP \(bu 2
\fBamount\fP: (\(aqint\(aq): How far back to check.
(default 0)
.IP \(bu 2
\fBmatch\-user\-id\fP (\(aqbool\(aq): Jobs matching
user\-id. (default False)
.IP \(bu 2
\fBmatch\-user\-fullname\fP (\(aqbool\(aq): Jobs
matching user fullname. (default False)
.IP \(bu 2
\fBignore\-case\fP (\(aqbool\(aq): Ignore case.
(default False)
.IP \(bu 2
\fBignore\-whitespace\fP (\(aqbool\(aq): Ignore
whitespace. (default False)
.IP \(bu 2
\fBignore\-non\-alphaNumeric\fP (\(aqbool\(aq): Ignore
non\-alphaNumeric. (default False)
.IP \(bu 2
\fBmatch\-builder\fP (\(aqbool\(aq): Jobs matching
builder. (default False)
.IP \(bu 2
\fBmatch\-email\fP (\(aqbool\(aq): Jobs matching
email. (default False)
.IP \(bu 2
\fBmatch\-scm\-changes\fP (\(aqbool\(aq): Jobs matching
scm changes. (default False)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBregex\-job\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B regex\-job
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter
to include. (default includeMatched)
.IP \(bu 2
\fBregex\-name\fP (\(aqstr\(aq): Regular expression name.
(default \(aq\(aq)
.IP \(bu 2
\fBregex\fP (\(aqstr\(aq): Regular expression. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBjob\-tpye\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B job\-type
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter to include.
(default includeMatched)
.IP \(bu 2
\fBjob\-type\fP (\(aqstr\(aq): Type of Job.
(default hudson.model.FreeStyleProject)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBparameter\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B parameter
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter to include.
(default includeMatched)
.IP \(bu 2
\fBname\fP (\(aqstr\(aq): Job name to match. (default \(aq\(aq)
.IP \(bu 2
\fBvalue\fP (\(aqstr\(aq): Value to match. (default \(aq\(aq)
.IP \(bu 2
\fBdesc\fP (\(aqstr\(aq): Description to match. (default \(aq\(aq)
.IP \(bu 2
\fBuse\-default\-value\fP (\(aqbool\(aq): Use default value.
(default False)
.IP \(bu 2
\fBmatch\-builds\-in\-progress\fP (\(aqbool\(aq): Match build in
progress. (default False)
.IP \(bu 2
\fBmatch\-all\-builds\fP (\(aqbool\(aq): Match all builds.
(default False)
.IP \(bu 2
\fBmax\-builds\-to\-match\fP (\(aqint\(aq): Maximum builds to match.
(default 0)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBother\-views\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B other\-views
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter
to include. (default includeMatched)
.IP \(bu 2
\fBview\-name\fP (\(aqstr\(aq): View name.
(default select a view other than this one)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBscm\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B scm
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter to include.
(default includeMatched)
.IP \(bu 2
\fBscm\-type\fP (\(aqstr\(aq): Type of SCM.
(default hudson.scm.NullSCM)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBsecured\-job\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B secured\-job
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter
to include. (default includeMatched)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBuser\-permissions\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B user\-permissions
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter to include.
(default includeMatched)
.IP \(bu 2
\fBconfigure\fP (\(aqbool\(aq): User with configure permissions.
(default false)
.IP \(bu 2
\fBamount\-type\fP: (\(aqbool\(aq): User with build permissions.
(default false)
.IP \(bu 2
\fBamount\fP: (\(aqbool\(aq): User with workspace permissions.
(default false)
.IP \(bu 2
\fBpermission\-check\fP: (\(aqstr\(aq): Match user permissions.
(default MustMatchAll)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBupstream\-downstream\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B upstream\-downstream
.INDENT 7.0
.IP \(bu 2
\fBinclude\-upstream\fP (\(aqbool\(aq): Jobs that match upstream.
(default False)
.IP \(bu 2
\fBinclude\-downstream\fP (\(aqbool\(aq): Jobs that match downstream.
(default False)
.IP \(bu 2
\fBrecursive\fP (\(aqbool\(aq): Jobs that are recursive.
(default False)
.IP \(bu 2
\fBexclude\-originals\fP (\(aqbool\(aq): Jobs that are originals.
(default False)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBunclassified\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unclassified
.INDENT 7.0
.IP \(bu 2
\fBmatch\-type\fP (\(aqstr\(aq): Jobs that match a filter to include.
(default includeMatched)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBcolumns\fP (\fIlist\fP): List of columns to be shown in view.
.IP \(bu 2
\fBregex\fP (\fIstr\fP): . Regular expression for selecting jobs
(optional)
.IP \(bu 2
\fBrecurse\fP (\fIbool\fP): Recurse in subfolders.(default false)
.IP \(bu 2
\fBstatus\-filter\fP (\fIbool\fP): Filter job list by enabled/disabled
status. (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: list\-view\-name01
view\-type: list
description: \(aqSample description\(aq
filter\-executors: true
filter\-queue: true
job\-name:
    \- job\-name\-1
    \- job\-name\-3
    \- job\-name\-2
    \- Job\-name\-4
columns:
    \- status
    \- weather
    \- job
    \- last\-success
    \- last\-failure
    \- last\-duration
    \- build\-button
    \- last\-stable
    \- robot\-list
    \- find\-bugs
    \- jacoco
    \- git\-branch
    \- favorite
    \- schedule\-build
    \- priority\-sorter
    \- build\-filter
    \- desc
    \- policy\-violations
    \- member\-graph\-view
    \- built\-on
    \- extra\-tests\-total
    \- extra\-tests\-failed
    \- extra\-tests\-passed
    \- extra\-tests\-skipped
    \- extra\-tests\-format\-0
    \- extra\-tests\-format\-1
    \- extra\-build\-parameters
    \- extra\-build\-description
    \- extra\-last\-user\-name
    \- extra\-workspace\-link
    \- extra\-configure\-button
    \- extra\-last\-output
recurse: true
status\-filter: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: regex\-example
view\-type: list
description: \(aqdescription\(aq
columns:
    \- status
    \- weather
    \- job
    \- last\-success
    \- last\-failure
    \- last\-duration
    \- extra\-build\-parameter: MY_PARAMETER
regex: (?!test.*).*

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  view_list.List(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Nested View
.sp
The view nested module handles creating Jenkins Nested views.
.sp
To create a nested view specify \fBnested\fP in the \fBview\-type\fP attribute
to the \fI\%Nested View\fP definition.
.INDENT 0.0
.TP
.B View Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP): The name of the view.
.IP \(bu 2
\fBview\-type\fP (\fIstr\fP): The type of view.
.IP \(bu 2
\fBdescription\fP (\fIstr\fP): A description of the view. (default \(aq\(aq)
.IP \(bu 2
\fBfilter\-executors\fP (\fIbool\fP): Show only executors that can
execute the included views. (default false)
.IP \(bu 2
\fBfilter\-queue\fP (\fIbool\fP): Show only included jobs in builder
queue. (default false)
.IP \(bu 2
\fBviews\fP (\fIlist\fP): The views to nest.
.IP \(bu 2
\fBdefault\-view\fP (\fIstr\fP): Name of the view to use as the default from the
nested ones. (the first one by default)
.IP \(bu 2
\fBcolumns\fP (\fIlist\fP): List of columns to be shown in view. (default empty
list)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: NestedViewTest
view\-type: nested
views:
  \- name: All
    view\-type: all
columns:
  \- status
  \- weather

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  view_nested.Nested(registry)
.UNINDENT
.SS Pipeline View
.sp
The view pipeline module handles creating Jenkins Build Pipeline views.
To create a pipeline view specify \fBpipeline\fP in the \fBview\-type\fP attribute
to the \fI\%Pipeline View\fP definition.
.sp
Requires the Jenkins \fI\%Build Pipeline Plugin\fP\&.
.INDENT 0.0
.TP
.B View Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP): The name of the view.
.IP \(bu 2
\fBview\-type\fP (\fIstr\fP): The type of view.
.IP \(bu 2
\fBdescription\fP (\fIstr\fP): A description of the view. (optional)
.IP \(bu 2
\fBfilter\-executors\fP (\fIbool\fP): Show only executors that can
execute the included views. (default false)
.IP \(bu 2
\fBfilter\-queue\fP (\fIbool\fP): Show only included jobs in builder
queue. (default false)
.IP \(bu 2
\fBfirst\-job\fP (\fIstr\fP): Parent Job in the view.
.IP \(bu 2
\fBno\-of\-displayed\-builds\fP (\fIstr\fP): Number of builds to display.
(default 1)
.IP \(bu 2
\fBtitle\fP (\fIstr\fP): Build view title. (optional)
.IP \(bu 2
\fBlinkStyle\fP (\fIstr\fP): Console output link style. Can be
\(aqLightbox\(aq, \(aqNew Window\(aq, or \(aqThis Window\(aq. (default Lightbox)
.IP \(bu 2
\fBcss\-Url\fP (\fIstr\fP): Url for Custom CSS files (optional)
.IP \(bu 2
\fBlatest\-job\-only\fP (\fIbool\fP) Trigger only latest job.
(default false)
.IP \(bu 2
\fBmanual\-trigger\fP (\fIbool\fP) Always allow manual trigger.
(default false)
.IP \(bu 2
\fBshow\-parameters\fP (\fIbool\fP) Show pipeline parameters.
(default false)
.IP \(bu 2
\fBparameters\-in\-headers\fP (\fIbool\fP) Show pipeline parameters in
headers. (default false)
.IP \(bu 2
\fBstarts\-with\-parameters\fP (\fIbool\fP) Use Starts with parameters.
(default false)
.IP \(bu 2
\fBrefresh\-frequency\fP (\fIstr\fP) Frequency to refresh in seconds.
(default \(aq3\(aq)
.IP \(bu 2
\fBdefinition\-header\fP (\fIbool\fP) Show pipeline definition header.
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: testBPview
view\-type: pipeline
description: \(aqThis is a description\(aq
filter\-executors: false
filter\-queue: false
first\-job: job\-one
no\-of\-displayed\-builds: 5
title: Title
link\-style: New Window
css\-Url: fake.urlfor.css
latest\-job\-only: true
manual\-trigger: true
show\-parameters: true
parameters\-in\-headers: true
start\-with\-parameters: true
refresh\-frequency: 3
definition\-header: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name: testBPview
view\-type: pipeline
first\-job: job\-one

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  view_pipeline.Pipeline(registry)
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Builders
.sp
Builders define actions that the Jenkins job should execute.  Examples
include shell scripts or maven targets.  The \fBbuilders\fP attribute in
the \fI\%Job\fP definition accepts a list of builders to invoke.  They
may be components defined below, locally defined macros (using the top
level definition of \fBbuilder:\fP, or locally defined components found
via the \fBjenkins_jobs.builders\fP entry point.
.INDENT 0.0
.TP
\fBComponent\fP: builders
.INDENT 7.0
.TP
.B Macro
builder
.TP
.B Entry Point
jenkins_jobs.builders
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job:
  name: test_job

  builders:
    \- shell: \(dqmake test\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  builders.Builders(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqbuilders\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqbuilder\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  60
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ansible\-playbook()
This plugin allows you to execute Ansible tasks as a job build step.
.sp
Requires the Jenkins \fI\%Ansible Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBplaybook\fP (\fIstr\fP) \-\- Path to the ansible playbook file. The path can be
absolute or relative to the job workspace. (required)
.IP \(bu 2
\fBinventory\-type\fP (\fIstr\fP) \-\- 
.sp
The inventory file form (default \fIpath\fP)
.INDENT 2.0
.TP
.B inventory\-type values
.INDENT 7.0
.IP \(bu 2
\fBpath\fP
.IP \(bu 2
\fBcontent\fP
.IP \(bu 2
\fBdo\-not\-specify\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBinventory\fP (\fIdict\fP) \-\- 
.sp
Inventory data, depends on inventory\-type
.INDENT 2.0
.TP
.B inventory\-type == path
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fIstr\fP) \-\- Path to inventory file.
.UNINDENT
.TP
.B inventory\-type == content
.INDENT 7.0
.IP \(bu 2
\fBcontent\fP (\fIstr\fP) \-\- Content of inventory file.
.IP \(bu 2
\fBdynamic\fP (\fIbool\fP) \-\- Dynamic inventory is used (default false)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBhosts\fP (\fIstr\fP) \-\- Further limit selected hosts to an additional pattern
(default \(aq\(aq)
.IP \(bu 2
\fBtags\-to\-run\fP (\fIstr\fP) \-\- Only run plays and tasks tagged with these values
(default \(aq\(aq)
.IP \(bu 2
\fBtags\-to\-skip\fP (\fIstr\fP) \-\- Only run plays and tasks whose tags do not match
these values (default \(aq\(aq)
.IP \(bu 2
\fBtask\-to\-start\-at\fP (\fIstr\fP) \-\- Start the playbook at the task matching this
name (default \(aq\(aq)
.IP \(bu 2
\fBworkers\fP (\fIint\fP) \-\- Specify number of parallel processes to use (default 5)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- The ID of credentials for the SSH connections.
Only private key authentication is supported (default \(aq\(aq)
.IP \(bu 2
\fBvault\-credentials\-id\fP (\fIstr\fP) \-\- The ID of credentials for the vault
decryption (default \(aq\(aq)
.IP \(bu 2
\fBsudo\fP (\fIbool\fP) \-\- Run operations with sudo. It works only when the remote
user is sudoer with nopasswd option (default false)
.IP \(bu 2
\fBsudo\-user\fP (\fIstr\fP) \-\- Desired sudo user. \(dqroot\(dq is used when this field is
empty. (default \(aq\(aq)
.IP \(bu 2
\fBunbuffered\-output\fP (\fIbool\fP) \-\- Skip standard output buffering for the ansible
process. The ansible output is directly rendered into the Jenkins
console. This option can be useful for long running operations.
(default true)
.IP \(bu 2
\fBcolorized\-output\fP (\fIbool\fP) \-\- Check this box to allow ansible to render ANSI
color codes in the Jenkins console. (default false)
.IP \(bu 2
\fBdisable\-host\-key\-checking\fP (\fIbool\fP) \-\- Check this box to disable the
validation of the hosts SSH server keys. (>= 1.0) (default false)
.IP \(bu 2
\fBadditional\-parameters\fP (\fIstr\fP) \-\- Any additional parameters to pass to the
ansible command. (default \(aq\(aq)
.IP \(bu 2
\fBvariables\fP (\fIlist\fP) \-\- 
.sp
List of extra variables to be passed to ansible.
(optional)
.INDENT 2.0
.TP
.B variable item
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of variable (required)
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) \-\- Desired value (default \(aq\(aq)
.IP \(bu 2
\fBhidden\fP (\fIbool\fP) \-\- Hide variable in build log (default false)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Outdated Options for versions >= 1.0 of plugin:
.INDENT 7.0
.TP
.B Parameters
\fBhost\-key\-checking\fP (\fIbool\fP) \-\- Outdated, replaced with disable\-host\-key\-checking.
Check this box to enforce the validation of the hosts SSH server keys.
(< 1.0) (default true)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-
builders:
  \- ansible\-playbook:
      playbook: \(dqpath/to/playbook.yml\(dq
      inventory\-type: \(dqpath\(dq
      inventory:
        path: \(dqpath/to/inventory\-file\(dq
      variables:
        \- name: \(dqmy_variable\(dq
          value: \(dqmy_value\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
OR
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-
builders:
  \- ansible\-playbook:
      playbook: \(dqpath/to/playbook.yml\(dq
      inventory\-type: \(dqcontent\(dq
      inventory:
        content: |
          [all]
          machine01.example.com
          machine02.example.com
      hosts: \(dqmasters\(dq
      tags\-to\-run: \(dqose\(dq
      tags\-to\-skip: \(dqovirt\(dq
      task\-to\-start\-at: \(dqDeploy application\(dq
      workers: 2
      credentials\-id: \(dq0891c950\-487b\-4749\-aa69\-d87425e14459\(dq
      vault\-credentials\-id: \(dq0421b950\-487b\-4749\-aa69\-d87425e14459\(dq
      sudo: true
      sudo\-user: \(dqcloud\-user\(dq
      unbuffered\-output: false
      colorized\-output: true
      additional\-parameters: \(dq\-vvv\(dq
      variables:
        \- name: \(dqcomplete_var\(dq
          value: \(dqcomplete value\(dq
          hidden: false
        \- name: \(dqempty_var\(dq
        \- name: \(dqhidden_var\(dq
          value: \(dqDo not appear in console\(dq
          hidden: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example(s) versions < 1.0:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-
builders:
  \- ansible\-playbook:
      playbook: \(dqpath/to/playbook.yml\(dq
      inventory\-type: \(dqdo\-not\-specify\(dq
      become: \(dqyes\(dq
      become\-user: \(dqcloud\-user\(dq
      host\-key\-checking: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ant()
Execute an ant target. Requires the Jenkins \fI\%Ant Plugin\fP\&.
.sp
To setup this builder you can either reference the list of targets
or use named parameters. Below is a description of both forms:
.sp
\fI1) Listing targets:\fP
.sp
After the ant directive, simply pass as argument a space separated list
of targets to build.
.INDENT 7.0
.TP
.B Parameter
space separated list of Ant targets
.UNINDENT
.sp
Example to call two Ant targets:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- ant: \(dqtarget1 target2\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The build file would be whatever the Jenkins Ant Plugin is set to use
per default (i.e build.xml in the workspace root).
.sp
\fI2) Using named parameters:\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtargets\fP (\fIstr\fP) \-\- the space separated list of ANT targets.
.IP \(bu 2
\fBbuildfile\fP (\fIstr\fP) \-\- the path to the ANT build file.
.IP \(bu 2
\fBproperties\fP (\fIlist\fP) \-\- Passed to ant script using \-Dkey=value (optional)
.IP \(bu 2
\fBant\-name\fP (\fIstr\fP) \-\- the name of the ant installation,
(default \(aqdefault\(aq) (optional)
.IP \(bu 2
\fBjava\-opts\fP (\fIstr\fP) \-\- java options for ant, can have multiples,
must be in quotes (optional)
.UNINDENT
.UNINDENT
.sp
Example specifying the build file too and several targets:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- ant:
     targets: \(dqdebug test install\(dq
     buildfile: \(dqbuild.xml\(dq
     properties:
        builddir: \(dq/tmp/\(dq
        failonerror: true
     java\-opts:
        \- \(dq\-ea\(dq
        \- \(dq\-Xmx512m\(dq
     ant\-name: \(dqStandard Ant\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B artifact\-resolver()
Allows one to resolve artifacts from a maven repository like nexus
(without having maven installed)
.sp
Requires the Jenkins \fI\%Repository Connector Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfail\-on\-error\fP (\fIbool\fP) \-\- Whether to fail the build on error (default false)
.IP \(bu 2
\fBrepository\-logging\fP (\fIbool\fP) \-\- Enable repository logging (default false)
.IP \(bu 2
\fBtarget\-directory\fP (\fIstr\fP) \-\- Where to resolve artifacts to (required)
.IP \(bu 2
\fBartifacts\fP (\fIlist\fP) \-\- 
.sp
list of artifacts to resolve
.INDENT 2.0
.TP
.B Artifact
.INDENT 7.0
.IP \(bu 2
\fBgroup\-id\fP (\fIstr\fP) \-\- Group ID of the artifact (required)
.IP \(bu 2
\fBartifact\-id\fP (\fIstr\fP) \-\- Artifact ID of the artifact (required)
.IP \(bu 2
\fBversion\fP (\fIstr\fP) \-\- Version of the artifact (required)
.IP \(bu 2
\fBclassifier\fP (\fIstr\fP) \-\- Classifier of the artifact (default \(aq\(aq)
.IP \(bu 2
\fBextension\fP (\fIstr\fP) \-\- Extension of the artifact
(default \(aqjar\(aq)
.IP \(bu 2
\fBtarget\-file\-name\fP (\fIstr\fP) \-\- What to name the artifact
(default \(aq\(aq)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- artifact\-resolver:
      target\-directory: foo
      artifacts:
        \- group\-id: commons\-logging
          artifact\-id: commons\-logging
          version: \(dq1.1\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- artifact\-resolver:
      fail\-on\-error: true
      repository\-logging: true
      target\-directory: foo
      artifacts:
        \- group\-id: commons\-logging
          artifact\-id: commons\-logging
          version: \(dq1.1\(dq
          classifier: src
          extension: jar
          target\-file\-name: comm\-log.jar
        \- group\-id: commons\-lang
          artifact\-id: commons\-lang
          version: \(dq1.2\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B batch()
Execute a batch command.
.INDENT 7.0
.TP
.B Parameter
the batch command to execute
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- batch: \(dqfoo/foo.bat\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B beaker()
Execute a beaker build step.
.sp
Requires the Jenkins \fI\%Beaker Builder Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcontent\fP (\fIstr\fP) \-\- Run job from string
(Alternative: you can choose a path instead)
.IP \(bu 2
\fBpath\fP (\fIstr\fP) \-\- Run job from file
(Alternative: you can choose a content instead)
.IP \(bu 2
\fBdownload\-logs\fP (\fIbool\fP) \-\- Download Beaker log files (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- beaker:
        path: \(aqtest.xml\(aq
        download\-logs: true

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- beaker:
        content: |
            <job group=\(aqproduct\-QA\(aq>
                <whiteboard>
                    Apache 2.2 test
                </whiteboard>
            </job>

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B build\-name\-setter()
Define Build Name Setter options which allows your build name to be
updated during the build process.
.sp
Requires the Jenkins \fI\%Build Name Setter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Filename to use for Build Name Setter, only used if
file bool is true. (default \(aqversion.txt\(aq)
.IP \(bu 2
\fBtemplate\fP (\fIstr\fP) \-\- Macro Template string, only used if macro
bool is true. (default \(aq#${BUILD_NUMBER}\(aq)
.IP \(bu 2
\fBfile\fP (\fIbool\fP) \-\- Read from named file (default false)
.IP \(bu 2
\fBmacro\fP (\fIbool\fP) \-\- Read from macro template (default false)
.IP \(bu 2
\fBmacro\-first\fP (\fIbool\fP) \-\- Insert macro first (default false)
.UNINDENT
.UNINDENT
.sp
File Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
      \- build\-name\-setter:
          name: \(aqversion.txt\(aq
          file: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Macro Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
      \- build\-name\-setter:
          template: \(aq#${BUILD_NUMBER}\(aq
          macro: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B build\-publish\-docker\-image()
Provides the ability to build projects with a Dockerfile and publish the
resultant tagged image (repo) to the docker registry.
.sp
Requires the Jenkins \fI\%CloudBees Docker Build and Publish
plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdocker\-registry\-url\fP (\fIstr\fP) \-\- URL to the Docker registry you are
using (default \(aq\(aq)
.IP \(bu 2
\fBimage\fP (\fIstr\fP) \-\- Repository name to be applied to the resulting image
in case of success (default \(aq\(aq)
.IP \(bu 2
\fBdocker\-file\-directory\fP (\fIstr\fP) \-\- Build step that sends a Dockerfile for
building to docker host that used for this build run (default \(aq\(aq)
.IP \(bu 2
\fBpush\-on\-success\fP (\fIbool\fP) \-\- Resulting docker image will be pushed to
the registry (or registries) specified within the
\(dqImage\(dq field (default false)
.IP \(bu 2
\fBpush\-credentials\-id\fP (\fIstr\fP) \-\- Credentials to push to a private
registry (default \(aq\(aq)
.IP \(bu 2
\fBclean\-images\fP (\fIbool\fP) \-\- Option to clean local images (default false)
.IP \(bu 2
\fBjenkins\-job\-delete\fP (\fIbool\fP) \-\- Attempt to remove images when jenkins
deletes the run (default false)
.IP \(bu 2
\fBcloud\fP (\fIstr\fP) \-\- Cloud to use to build image (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- build\-publish\-docker\-image

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- build\-publish\-docker\-image:
      docker\-registry\-url: Docker registry URL
      image: Image string
      docker\-file\-directory: Directory for Dockerfile
      push\-on\-success: true
      push\-credentials\-id: 71e4f29c\-162b\-40d0\-85d9\-3ddfba2911a0
      clean\-images: true
      jenkins\-job\-delete: true
      cloud: cloud

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B builders\-from()
Use builders from another project.
.sp
Requires the Jenkins \fI\%Template Project Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBprojectName\fP (\fIstr\fP) \-\- the name of the other project
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- builders\-from: \(dqbase\-build\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B change\-assembly\-version()
Change the assembly version.
Requires the Jenkins \fI\%Change Assembly Version\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBversion\fP (\fIstr\fP) \-\- Set the new version number for replace (default 1.0.0)
.IP \(bu 2
\fBassemblyFile\fP (\fIstr\fP) \-\- The file name to search (default AssemblyInfo.cs)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- change\-assembly\-version

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- change\-assembly\-version:
        version: \(dq1.2.3\(dq
        assembly\-file: \(dqAFile\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cloudformation()
Create cloudformation stacks before running a build and optionally
delete them at the end.
.sp
Requires the Jenkins \fI\%AWS Cloudformation Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIlist\fP) \-\- The names of the stacks to create (required)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Description of the stack (optional)
.IP \(bu 2
\fBrecipe\fP (\fIstr\fP) \-\- The cloudformation recipe file (required)
.IP \(bu 2
\fBparameters\fP (\fIlist\fP) \-\- List of key/value pairs to pass
into the recipe, will be joined together into a comma separated
string (optional)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \-\- Number of seconds to wait before giving up creating
a stack (default 0)
.IP \(bu 2
\fBaccess\-key\fP (\fIstr\fP) \-\- The Amazon API Access Key (required)
.IP \(bu 2
\fBsecret\-key\fP (\fIstr\fP) \-\- The Amazon API Secret Key (required)
.IP \(bu 2
\fBsleep\fP (\fIint\fP) \-\- Number of seconds to wait before continuing to the
next step (default 0)
.IP \(bu 2
\fBregion\fP (\fIstr\fP) \-\- 
.sp
The region to run cloudformation in (required)
.INDENT 2.0
.TP
.B region values
.INDENT 7.0
.IP \(bu 2
\fBus\-east\-1\fP
.IP \(bu 2
\fBus\-west\-1\fP
.IP \(bu 2
\fBus\-west\-2\fP
.IP \(bu 2
\fBeu\-central\-1\fP
.IP \(bu 2
\fBeu\-west\-1\fP
.IP \(bu 2
\fBap\-southeast\-1\fP
.IP \(bu 2
\fBap\-southeast\-2\fP
.IP \(bu 2
\fBap\-northeast\-1\fP
.IP \(bu 2
\fBsa\-east\-1\fP
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- cloudformation:
    \- name: \(dqfoo\(dq
      description: \(dqBuild the foo stack\(dq
      recipe: \(dqfoo.json\(dq
      parameters:
        \- \(dqKey1=foo\(dq
        \- \(dqKey2=fuu\(dq
      timeout: 3600
      access\-key: \(dq$AWS_ACCESS_KEY\(dq
      secret\-key: \(dq$AWS_SECRET_KEY\(dq
      region: us\-west\-2
      sleep: 5
    \- name: \(dqbar\(dq
      description: \(dqBuild the bar stack\(dq
      recipe: \(dqbar.json\(dq
      parameters:
        \- \(dqKey1=bar\(dq
        \- \(dqKey2=baa\(dq
      timeout: 3600
      access\-key: \(dq$AWS_ACCESS_KEY\(dq
      secret\-key: \(dq$AWS_SECRET_KEY\(dq
      region: us\-west\-1

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cmake()
Execute a CMake target.
.sp
Requires the Jenkins \fI\%CMake Plugin\fP\&.
.sp
This builder is compatible with both versions 2.x and 1.x of the
plugin. When specifying paramenters from both versions only the ones from
the installed version in Jenkins will be used, and the rest will be
ignored.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsource\-dir\fP (\fIstr\fP) \-\- the source code directory relative to the workspace
directory. (required)
.IP \(bu 2
\fBbuild\-type\fP (\fIstr\fP) \-\- Sets the \(dqbuild type\(dq option for CMake (default
\(dqDebug\(dq).
.IP \(bu 2
\fBpreload\-script\fP (\fIstr\fP) \-\- Path to a CMake preload script file. (optional)
.IP \(bu 2
\fBother\-arguments\fP (\fIstr\fP) \-\- Other arguments to be added to the CMake
call. (optional)
.IP \(bu 2
\fBclean\-build\-dir\fP (\fIbool\fP) \-\- If true, delete the build directory before each
build (default false).
.IP \(bu 2
\fBgenerator\fP (\fIlist\fP) \-\- 
.sp
The makefile generator (default \(dqUnix Makefiles\(dq).
.INDENT 2.0
.TP
.B type Possible generators
.INDENT 7.0
.IP \(bu 2
\fBBorland Makefiles\fP
.IP \(bu 2
\fBCodeBlocks \- MinGW Makefiles\fP
.IP \(bu 2
\fBCodeBlocks \- Unix Makefiles\fP
.IP \(bu 2
\fBEclipse CDT4 \- MinGW Makefiles\fP
.IP \(bu 2
\fBEclipse CDT4 \- NMake Makefiles\fP
.IP \(bu 2
\fBEclipse CDT4 \- Unix Makefiles\fP
.IP \(bu 2
\fBMSYS Makefiles\fP
.IP \(bu 2
\fBMinGW Makefiles\fP
.IP \(bu 2
\fBNMake Makefiles\fP
.IP \(bu 2
\fBUnix Makefiles\fP
.IP \(bu 2
\fBVisual Studio 6\fP
.IP \(bu 2
\fBVisual Studio 7 .NET 2003\fP
.IP \(bu 2
\fBVisual Studio 8 2005\fP
.IP \(bu 2
\fBVisual Studio 8 2005 Win64\fP
.IP \(bu 2
\fBVisual Studio 9 2008\fP
.IP \(bu 2
\fBVisual Studio 9 2008 Win64\fP
.IP \(bu 2
\fBWatcom WMake\fP
.UNINDENT
.UNINDENT

.UNINDENT
.TP
.B Version 2.x
Parameters that available only to versions 2.x of the plugin
.INDENT 7.0
.IP \(bu 2
\fBworking\-dir\fP (\fIstr\fP): The directory where the project will be
built in. Relative to the workspace directory. (optional)
.IP \(bu 2
\fBinstallation\-name\fP (\fIstr\fP): The CMake installation to be used on
this builder. Use one defined in your Jenkins global configuration
page (default \(dqInSearchPath\(dq).
.IP \(bu 2
\fBbuild\-tool\-invocations\fP (\fIlist\fP): list of build tool invocations
that will happen during the build:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Build tool invocations
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-cmake\fP (\fIstr\fP) \-\- Whether to run the actual build tool
directly (by expanding \fB$CMAKE_BUILD_TOOL\fP) or to have
cmake run the build tool (by invoking \fBcmake \-\-build
<dir>\fP) (default false).
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBarguments\fP (\fIstr\fP) \-\- Specify arguments to pass to the
build tool or cmake (separated by spaces). Arguments may
contain spaces if they are enclosed in double
quotes. (optional)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBenvironment\-variables\fP (\fIstr\fP) \-\- Specify extra
environment variables to pass to the build tool as
key\-value pairs here. Each entry must be on its own line,
for example:
.INDENT 7.0
.INDENT 3.5
\fBDESTDIR=${WORKSPACE}/artifacts/dir\fP
.sp
\fBKEY=VALUE\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B Version 1.x
Parameters available only to versions 1.x of the plugin
.INDENT 7.0
.IP \(bu 2
\fBbuild\-dir\fP (\fIstr\fP): The directory where the project will be built
in.  Relative to the workspace directory. (optional)
.IP \(bu 2
\fBinstall\-dir\fP (\fIstr\fP): The directory where the project will be
installed in, relative to the workspace directory. (optional)
.IP \(bu 2
\fBbuild\-type\fP (\fIlist\fP): Sets the \(dqbuild type\(dq option. A custom type
different than the default ones specified on the CMake plugin can
also be set, which will be automatically used in the \(dqOther Build
Type\(dq option of the plugin. (default \(dqDebug\(dq)
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Default types present in the CMake plugin
.INDENT 7.0
.IP \(bu 2
\fBDebug\fP
.IP \(bu 2
\fBRelease\fP
.IP \(bu 2
\fBRelWithDebInfo\fP
.IP \(bu 2
\fBMinSizeRel\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBmake\-command\fP (\fIstr\fP): The make command (default \(dqmake\(dq).
.IP \(bu 2
\fBinstall\-command\fP (\fIarg\fP): The install command (default \(dqmake
install\(dq).
.IP \(bu 2
\fBcustom\-cmake\-path\fP (\fIstr\fP): Path to cmake executable. (optional)
.IP \(bu 2
\fBclean\-install\-dir\fP (\fIbool\fP): If true, delete the install dir
before each build (default false).
.UNINDENT
.UNINDENT
.sp
Example (Versions 2.x):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- cmake:
      source\-dir: \(aqpath/to/source\(aq
      working\-dir: \(aqpath/to/build\(aq
      install\-dir: \(aqpath/to/install\(aq
      build\-type: \(aqCustomReleaseType\(aq
      generator: \(aqNMake Makefiles\(aq
      installation\-name: \(aqCMake custom install\(aq
      preload\-script: \(aqpath/to/source/cmake.preload\(aq
      other\-arguments: \(aq\-DCMAKE_FIND_ROOT_PATH=\(dqpath/to/something/else\(dq\(aq
      clean\-build\-dir: true
      build\-tool\-invocations:
        \- use\-cmake: true
          arguments: \(aqclean\(aq
          environment\-variables: |
            DESTDIR=${WORKSPACE}/artifacts/dir
            URL=http://www.example.org/
        \- use\-cmake: false
          arguments: \(aqtest\(aq
          environment\-variables: |
            RESTRICT=\(dqTRUE\(dq
            TARGET=\(dqNONE\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example (Versions 1.x):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- cmake:
      source\-dir: \(aqpath/to/source\(aq
      build\-dir: \(aqpath/to/build\(aq
      install\-dir: \(aqpath/to/install\(aq
      build\-type: \(aqCustomReleaseType\(aq
      generator: \(aqNMake Makefiles\(aq
      make\-command: \(aq/usr/bin/make\(aq
      install\-command: \(aqmake new\-install\(aq
      preload\-script: \(aqpath/to/source/cmake.preload\(aq
      other\-arguments: \(aq\-DCMAKE_FIND_ROOT_PATH=\(dqpath/to/something/else\(dq\(aq
      custom\-cmake\-path: \(aq/usr/bin/cmake\(aq
      clean\-build\-dir: true
      clean\-install\-dir: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B conditional\-step()
Conditionally execute some build steps.
.sp
Requires the Jenkins \fI\%Conditional BuildStep Plugin\fP\&.
.sp
Depending on the number of declared steps, a \fIConditional step (single)\fP
or a \fIConditional steps (multiple)\fP is created in Jenkins.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcondition\-kind\fP (\fIstr\fP) \-\- Condition kind that must be verified before the
steps are executed. Valid values and their additional attributes are
described in the \fI\%conditions\fP table.
.IP \(bu 2
\fBon\-evaluation\-failure\fP (\fIstr\fP) \-\- What should be the outcome of the build
if the evaluation of the condition fails. Possible values are \fIfail\fP,
\fImark\-unstable\fP, \fIrun\-and\-mark\-unstable\fP, \fIrun\fP and \fIdont\-run\fP\&.
(default \(aqfail\(aq).
.IP \(bu 2
\fBsteps\fP (\fIlist\fP) \-\- List of steps to run if the condition is verified. Items
in the list can be any builder known by Jenkins Job Builder.
.UNINDENT
.UNINDENT
.TS
center;
|l|l|.
_
T{
Condition kind
T}	T{
Description
T}
_
T{
always
T}	T{
Condition is always verified
T}
_
T{
never
T}	T{
Condition is never verified
T}
_
T{
boolean\-expression
T}	T{
Run the step if the expression expends to a
representation of true
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-expression
Expression to expand (required)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
build\-cause
T}	T{
Run if the current build has a specific cause
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B cause
The cause why the build was triggered.
Following causes are supported \-
.INDENT 7.0
.TP
.B USER_CAUSE
build was triggered by a manual
interaction. (default)
.TP
.B SCM_CAUSE
build was triggered by a SCM change.
.TP
.B TIMER_CAUSE
build was triggered by a timer.
.TP
.B CLI_CAUSE
build was triggered by via CLI interface
.TP
.B REMOTE_CAUSE
build was triggered via remote
interface.
.TP
.B UPSTREAM_CAUSE
build was triggered by an upstream
project.
.UNINDENT
.sp
Following supported if XTrigger plugin installed:
.INDENT 7.0
.TP
.B FS_CAUSE
build was triggered by a file system
change (FSTrigger Plugin).
.TP
.B URL_CAUSE
build was triggered by a URL change
(URLTrigger Plugin)
.TP
.B IVY_CAUSE
build triggered by an Ivy dependency
version has change (IvyTrigger Plugin)
.TP
.B SCRIPT_CAUSE
build was triggered by a script
(ScriptTrigger Plugin)
.TP
.B BUILDRESULT_CAUSE
build was triggered by a
result of another job (BuildResultTrigger Plugin)
.UNINDENT
.TP
.B exclusive\-cause
(bool) There might by multiple
causes causing a build to be triggered, with
this true, the cause must be the only one
causing this build this build to be triggered.
(default false)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
day\-of\-week
T}	T{
Only run on specific days of the week.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B day\-selector
Days you want the build to run on.
Following values are supported \-
.INDENT 7.0
.TP
.B weekend
Saturday and Sunday (default).
.TP
.B weekday
Monday \- Friday.
.TP
.B select\-days
Selected days, defined by \(aqdays\(aq
below.
.TP
.B days
True for days for which the build should
run. Definition needed only for \(aqselect\-days\(aq
day\-selector, at the same level as day\-selector.
Define the days to run under this.
.INDENT 7.0
.TP
.B SUN
Run on Sunday (default false)
.TP
.B MON
Run on Monday (default false)
.TP
.B TUES
Run on Tuesday (default false)
.TP
.B WED
Run on Wednesday (default false)
.TP
.B THURS
Run on Thursday (default false)
.TP
.B FRI
Run on Friday (default false)
.TP
.B SAT
Run on Saturday (default false)
.UNINDENT
.UNINDENT
.TP
.B use\-build\-time
(bool) Use the build time instead of
the the time that the condition is evaluated.
(default false)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
execution\-node
T}	T{
Run only on selected nodes.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B nodes
(list) List of nodes to execute on. (required)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
strings\-match
T}	T{
Run the step if two strings match
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-string1
First string (optional)
.TP
.B condition\-string2
Second string (optional)
.TP
.B condition\-case\-insensitive
Case insensitive
(default false)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
current\-status
T}	T{
Run the build step if the current build status is
within the configured range
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-worst
Accepted values are SUCCESS,
UNSTABLE, FAILURE, NOT_BUILD, ABORTED
(default SUCCESS)
.TP
.B condition\-best
Accepted values are SUCCESS,
UNSTABLE, FAILURE, NOT_BUILD, ABORTED
(default SUCCESS)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
shell
T}	T{
Run the step if the shell command succeed
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-command
Shell command to execute
(optional)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
windows\-shell
T}	T{
Similar to shell, except that commands will be
executed by cmd, under Windows
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-command
Command to execute (optional)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
file\-exists
T}	T{
Run the step if a file exists
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-filename
Check existence of this file
(required)
.TP
.B condition\-basedir
If condition\-filename is
relative, it will be considered relative to
either \fIworkspace\fP, \fIartifact\-directory\fP,
or \fIjenkins\-home\fP\&. (default \(aqworkspace\(aq)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
files\-match
T}	T{
Run if one or more files match the selectors.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B include\-pattern
(list str) List of Includes
Patterns. Since the separator in the patterns is
hardcoded as \(aq,\(aq, any use of \(aq,\(aq would need
escaping. (optional)
.TP
.B exclude\-pattern
(list str) List of Excludes
Patterns. Since the separator in the patterns is
hardcoded as \(aq,\(aq, any use of \(aq,\(aq would need
escaping. (optional)
.TP
.B condition\-basedir
Accepted values are \fIworkspace\fP,
\fIartifact\-directory\fP, or \fIjenkins\-home\fP\&.
(default \(aqworkspace\(aq)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
num\-comp
T}	T{
Run if the numerical comparison is true.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B lhs
Left Hand Side. Must evaluate to a number.
(required)
.TP
.B rhs
Right Hand Side. Must evaluate to a number.
(required)
.TP
.B comparator
Accepted values are \fIless\-than\fP,
\fIgreater\-than\fP, \fIequal\fP, \fInot\-equal\fP,
\fIless\-than\-equal\fP, \fIgreater\-than\-equal\fP\&.
(default \(aqless\-than\(aq)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
regex\-match
T}	T{
Run if the Expression matches the Label.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B regex
The regular expression used to match the label
(optional)
.TP
.B label
The label that will be tested by the regular
expression. (optional)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
time
T}	T{
Only run during a certain period of the day.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B earliest\-hour
Starting hour (default \(dq09\(dq)
.TP
.B earliest\-min
Starting min (default \(dq00\(dq)
.TP
.B latest\-hour
Ending hour (default \(dq17\(dq)
.TP
.B latest\-min
Ending min (default \(dq30\(dq)
.TP
.B use\-build\-time
(bool) Use the build time instead of
the the time that the condition is evaluated.
(default false)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
not
T}	T{
Run the step if the inverse of the condition\-operand
is true
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-operand
Condition to evaluate.  Can be
any supported conditional\-step condition. (required)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
and
T}	T{
Run the step if logical and of all conditional\-operands
is true
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-operands
(list) Conditions to evaluate.
Can be any supported conditional\-step condition.
(required)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
or
T}	T{
Run the step if logical or of all conditional\-operands
is true
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-operands
(list) Conditions to evaluate.
Can be any supported conditional\-step condition.
(required)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- conditional\-step:
        condition\-kind: always
        steps:
            \- shell: \(aqfirst command\(aq
            \- shell: \(aqsecond command\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
      \- conditional\-step:
          condition\-kind: current\-status
          condition\-worst: SUCCESS
          condition\-best: FAILURE
          steps:
              \- shell: \(dqsl\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
      \- conditional\-step:
          condition\-kind: not
          condition\-operand:
              condition\-kind: file\-exists
              condition\-filename: mytestfile
              condition\-basedir: workspace
          steps:
              \- shell: \(dqtouch $WORKSPACE/mytestfile\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
      \- conditional\-step:
          condition\-kind: day\-of\-week
          day\-selector: weekday
          use\-build\-time: true
          steps:
              \- shell: \(dqsl\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
      \- conditional\-step:
          condition\-kind: day\-of\-week
          day\-selector: select\-days
          days:
              MON: true
              FRI: true
          use\-build\-time: true
          steps:
              \- shell: \(dqsl\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- conditional\-step:
        condition\-kind: time
        earliest\-hour: \(dq4\(dq
        earliest\-min: \(dq15\(dq
        latest\-hour: \(dq20\(dq
        latest\-min: \(dq30\(dq
        steps:
            \- shell: \(dqsl\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- conditional\-step:
        condition\-kind: regex\-match
        regex: a*b
        label: cadaaab
        steps:
            \- shell: \(dqsl\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
      \- conditional\-step:
          condition\-kind: or
          condition\-operands:
              \- condition\-kind: num\-comp
                lhs: \(dq2 + 5\(dq
                rhs: \(dq1 + 6\(dq
                comparator: equal
                condition\-basedir: \(dqjenkins\-home\(dq
              \- condition\-kind: files\-match
                include\-pattern:
                    \- \(dqinc_pattern1\(dq
                    \- \(dqinc_pattern2\(dq
                exclude\-pattern:
                    \- \(dqexc_pattern1\(dq
                    \- \(dqexc_pattern2\(dq
                condition\-basedir: \(dqjenkins\-home\(dq
          steps:
              \- shell: \(dqsl\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
      \- conditional\-step:
          condition\-kind: and
          condition\-operands:
              \- condition\-kind: regex\-match
                regex: \(dq*abc*\(dq
                label: \(dqdabcddabc\(dq
              \- condition\-kind: time
                earliest\-hour: \(dq2\(dq
                earliest\-min: \(dq0\(dq
                latest\-hour: \(dq23\(dq
                latest\-min: \(dq40\(dq
                use\-build\-time: true
          steps:
              \- shell: \(dqsl\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B config\-file\-provider()
Provide configuration files (i.e., settings.xml for maven etc.)
which will be copied to the job\(aqs workspace.
.sp
Requires the Jenkins \fI\%Config File Provider Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBfiles\fP (\fIlist\fP) \-\- 
.sp
List of managed config files made up of three
parameters
.INDENT 7.0
.TP
.B files
.INDENT 7.0
.IP \(bu 2
\fBfile\-id\fP (\fIstr\fP) \-\- The identifier for the managed config
file
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- Define where the file should be created
(default \(aq\(aq)
.IP \(bu 2
\fBvariable\fP (\fIstr\fP) \-\- Define an environment variable to be
used (default \(aq\(aq)
.IP \(bu 2
\fBreplace\-tokens\fP (\fIbool\fP) \-\- Replace tokens in config file. For
example \(dqpassword: ${PYPI_JENKINS_PASS}\(dq will be replaced with
the global variable configured in Jenkins.
.UNINDENT
.UNINDENT

.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- config\-file\-provider:
        files:
            \- file\-id: org.jenkinsci.plugins.configfiles.maven.MavenSettingsConfig0123456789012
              target: target
              variable: variable
              replace\-tokens: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- config\-file\-provider:
        files:
            \- file\-id: org.jenkinsci.plugins.configfiles.maven.MavenSettingsConfig0123456789012

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B copyartifact()
Copy artifact from another project. Requires the \fI\%Copy
Artifact plugin\fP\&.
.sp
Please note using the multijob\-build for which\-build argument requires
the \fI\%Multijob plugin\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproject\fP (\fIstr\fP) \-\- Project to copy from
.IP \(bu 2
\fBfilter\fP (\fIstr\fP) \-\- what files to copy
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- Target base directory for copy, blank means use workspace
.IP \(bu 2
\fBflatten\fP (\fIbool\fP) \-\- Flatten directories (default false)
.IP \(bu 2
\fBoptional\fP (\fIbool\fP) \-\- If the artifact is missing (for any reason) and
optional is true, the build won\(aqt fail because of this builder
(default false)
.IP \(bu 2
\fBdo\-not\-fingerprint\fP (\fIbool\fP) \-\- Disable automatic fingerprinting of copied
artifacts (default false)
.IP \(bu 2
\fBwhich\-build\fP (\fIstr\fP) \-\- 
.sp
which build to get artifacts from
(optional, default last\-successful)
.INDENT 2.0
.TP
.B which\-build values
.INDENT 7.0
.IP \(bu 2
\fBlast\-successful\fP
.IP \(bu 2
\fBlast\-completed\fP
.IP \(bu 2
\fBspecific\-build\fP
.IP \(bu 2
\fBlast\-saved\fP
.IP \(bu 2
\fBupstream\-build\fP
.IP \(bu 2
\fBpermalink\fP
.IP \(bu 2
\fBworkspace\-latest\fP
.IP \(bu 2
\fBbuild\-param\fP
.IP \(bu 2
\fBdownstream\-build\fP
.IP \(bu 2
\fBmultijob\-build\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbuild\-number\fP (\fIstr\fP) \-\- specifies the build number to get when
when specific\-build is specified as which\-build
.IP \(bu 2
\fBpermalink\fP (\fIstr\fP) \-\- 
.sp
specifies the permalink to get when
permalink is specified as which\-build
.INDENT 2.0
.TP
.B permalink values
.INDENT 7.0
.IP \(bu 2
\fBlast\fP
.IP \(bu 2
\fBlast\-stable\fP
.IP \(bu 2
\fBlast\-successful\fP
.IP \(bu 2
\fBlast\-failed\fP
.IP \(bu 2
\fBlast\-unstable\fP
.IP \(bu 2
\fBlast\-unsuccessful\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBstable\fP (\fIbool\fP) \-\- specifies to get only last stable build when
last\-successful is specified as which\-build
.IP \(bu 2
\fBfallback\-to\-last\-successful\fP (\fIbool\fP) \-\- specifies to fallback to
last successful build when upstream\-build is specified as which\-build
.IP \(bu 2
\fBparam\fP (\fIstr\fP) \-\- specifies to use a build parameter to get the build when
build\-param is specified as which\-build
.IP \(bu 2
\fBupstream\-project\-name\fP (\fIstr\fP) \-\- specifies the project name of downstream
when downstream\-build is specified as which\-build
.IP \(bu 2
\fBupstream\-build\-number\fP (\fIstr\fP) \-\- specifies the number of the build to
find its downstream build when downstream\-build is specified as
which\-build
.IP \(bu 2
\fBparameter\-filters\fP (\fIstr\fP) \-\- Filter matching jobs based on these
parameters (optional)
.IP \(bu 2
\fBexclude\fP (\fIstr\fP) \-\- Specify paths or patterns of artifacts to
exclude, even if specified in \(dqArtifacts to copy\(dq. (default \(aq\(aq)
.IP \(bu 2
\fBresult\-var\-suffix\fP (\fIstr\fP) \-\- The build number of the selected build
will be recorded into the variable named
COPYARTIFACT_BUILD_NUMBER_(SUFFIX)
for later build steps to reference. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- copyartifact:
      project: foo
      filter: \(dq*.tar.gz\(dq
      target: /home/foo
      which\-build: specific\-build
      build\-number: \(dq123\(dq
      optional: true
      flatten: true
      do\-not\-fingerprint: true
      parameter\-filters: PUBLISH=true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multijob Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- copyartifact:
      project: foo
      filter: \(dq*.json\(dq
      target: /home/foo
      which\-build: multijob\-build
      optional: true
      flatten: true
      parameter\-filters: PUBLISH=true
      exclude: \(dq*.txt\(dq
      result\-var\-suffix: \(dqPROJECT_ABC\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B critical\-block\-end()
Designate the end of a critical block. Must be used in conjunction with
critical\-block\-start.
.sp
Must also add a build wrapper (exclusion), specifying the resources that
control the critical block. Otherwise, this will have no effect.
.sp
Requires the Jenkins \fI\%Exclusion Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- wrapper:
    name: critical\-block\-exclusion
    wrappers:
      \- exclusion:
          resources:
            \- myresource1

\- job:
    name: critical\-block\-example
    project\-type: freestyle
    wrappers:
      \- critical\-block\-exclusion
    builders:
      \- critical\-block\-start
      \- shell:
          #!/bin/bash \-ex
          rollback\-my\-data\-base
      \- critical\-block\-end

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B critical\-block\-start()
Designate the start of a critical block. Must be used in conjunction with
critical\-block\-end.
.sp
Must also add a build wrapper (exclusion), specifying the resources that
control the critical block. Otherwise, this will have no effect.
.sp
Requires the Jenkins \fI\%Exclusion Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- wrapper:
    name: critical\-block\-exclusion
    wrappers:
      \- exclusion:
          resources:
            \- myresource1

\- job:
    name: critical\-block\-example
    project\-type: freestyle
    wrappers:
      \- critical\-block\-exclusion
    builders:
      \- critical\-block\-start
      \- shell:
          #!/bin/bash \-ex
          rollback\-my\-data\-base
      \- critical\-block\-end

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B description\-setter()
This plugin sets the description for each build,
based upon a RegEx test of the build log file.
.sp
Requires the Jenkins \fI\%Description Setter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBregexp\fP (\fIstr\fP) \-\- A RegEx which is used to scan the build log file
(default \(aq\(aq)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- The description to set on the build (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- description\-setter:
      regexp: \(dq.*(<a href=.*a>)\(dq
      description: \(dqsome description\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B docker\-build\-publish()
Provides the ability to build projects with a Dockerfile, and publish the
resultant tagged image (repo) to the docker registry.
.sp
Requires the Jenkins \fI\%Docker build publish Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrepo\-name\fP (\fIstr\fP) \-\- Name of repository to push to.
.IP \(bu 2
\fBrepo\-tag\fP (\fIstr\fP) \-\- Tag for image. (default \(aq\(aq)
.IP \(bu 2
\fBserver\fP (\fIdict\fP) \-\- 
.sp
The docker daemon (optional)
.INDENT 2.0
.IP \(bu 2
\fBuri\fP (str): Define the docker server to use. (optional)
.IP \(bu 2
\fBcredentials\-id\fP (str): ID of credentials to use to connect
(optional)
.UNINDENT

.IP \(bu 2
\fBregistry\fP (\fIdict\fP) \-\- 
.sp
Registry to push to
.INDENT 2.0
.IP \(bu 2
\fBurl\fP (str) repository url to use (optional)
.IP \(bu 2
\fBcredentials\-id\fP (str): ID of credentials to use to connect
(optional)
.UNINDENT

.IP \(bu 2
\fBno\-cache\fP (\fIbool\fP) \-\- If build should be cached. (default false)
.IP \(bu 2
\fBno\-force\-pull\fP (\fIbool\fP) \-\- Don\(aqt update the source image before building when
it exists locally. (default false)
.IP \(bu 2
\fBskip\-build\fP (\fIbool\fP) \-\- Do not build the image. (default false)
.IP \(bu 2
\fBskip\-decorate\fP (\fIbool\fP) \-\- Do not decorate the build name. (default false)
.IP \(bu 2
\fBskip\-tag\-latest\fP (\fIbool\fP) \-\- Do not tag this build as latest. (default false)
.IP \(bu 2
\fBskip\-push\fP (\fIbool\fP) \-\- Do not push. (default false)
.IP \(bu 2
\fBfile\-path\fP (\fIstr\fP) \-\- Path of the Dockerfile. (default \(aq\(aq)
.IP \(bu 2
\fBbuild\-context\fP (\fIstr\fP) \-\- Project root path for the build, defaults to the
workspace if not specified. (default \(aq\(aq)
.IP \(bu 2
\fBcreate\-fingerprint\fP (\fIbool\fP) \-\- If enabled, the plugin will create
fingerprints after the build of each image. (default false)
.IP \(bu 2
\fBbuild\-args\fP (\fIstr\fP) \-\- Additional build arguments passed to
docker build (default \(aq\(aq)
.IP \(bu 2
\fBforce\-tag\fP (\fIbool\fP) \-\- Force tag replacement when tag already
exists (default false)
.UNINDENT
.UNINDENT
.sp
Minimal example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- docker\-build\-publish:
        repo\-name: \(aqtest\(aq
        repo\-tag: \(aqtest\-tag\(aq
        no\-cache: true
        no\-force\-pull: false
        skip\-build: false
        skip\-decorate: false
        skip\-latest: false
        skip\-tag: false
        file\-path: \(aq/tmp/\(aq
        build\-context: \(aq/tmp/\(aq
        create\-fingerprint: true
        build\-args: \-\-build\-arg https_proxy=\(dqhttp://some.proxy:port\(dq
        force\-tag: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- docker\-build\-publish:
        repo\-name: \(aqtest\(aq
        repo\-tag: \(aqtest\-tag\(aq
        no\-cache: true
        no\-force\-pull: false
        skip\-build: false
        skip\-decorate: false
        skip\-latest: false
        skip\-tag: false
        file\-path: \(aq/tmp/\(aq
        build\-context: \(aq/tmp/\(aq
        create\-fingerprint: true
        build\-args: \-\-build\-arg https_proxy=\(dqhttp://some.proxy:port\(dq
        force\-tag: true
        registry:
            url: \(aqhttps://registry.example.org\(aq
            credentials\-id: \(aqregistry\-docker\(aq
        server:
            uri: \(aqunix:///var/run/docker.sock\(aq
            credentials\-id: \(aqdocker\-server\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B docker\-pull\-image()
Provides integration between Jenkins and Docker Hub, utilizing a
Docker Hub hook to trigger one (or more) Jenkins job(s).
.sp
Requires the Jenkins \fI\%CloudBees Docker Hub Notification\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBimage\fP (\fIstr\fP) \-\- Image ID on DockerHub (default \(aq\(aq)
.IP \(bu 2
\fBdocker\-registry\-url\fP (\fIstr\fP) \-\- URL to the Docker registry
you are using (default \(aq\(aq)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- Registry credentials (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- docker\-pull\-image

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- docker\-pull\-image:
      image: test\-image\-id
      docker\-registry\-url: https://index.docker.io/v1/
      credentials\-id: 71e4f29c\-162b\-40d0\-85d9\-3ddfba2911a0

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B doxygen()
Builds doxygen HTML documentation.
.sp
Requires the Jenkins \fI\%Doxygen plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdoxyfile\fP (\fIstr\fP) \-\- The doxyfile path (required)
.IP \(bu 2
\fBinstall\fP (\fIstr\fP) \-\- The doxygen installation to use (required)
.IP \(bu 2
\fBignore\-failure\fP (\fIbool\fP) \-\- Keep executing build even on doxygen generation
failure (default false)
.IP \(bu 2
\fBunstable\-warning\fP (\fIbool\fP) \-\- Mark the build as unstable if warnings are
generated (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- doxygen:
      doxyfile: Doxyfile
      install: doxygen
      ignore\-failure: true
      unstable\-warning: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dsl()
Process Job DSL
.sp
Requires the Jenkins \fI\%Job DSL plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBscript\-text\fP (\fIstr\fP) \-\- dsl script which is Groovy code (Required if targets
is not specified)
.IP \(bu 2
\fBtargets\fP (\fIstr\fP) \-\- Newline separated list of DSL scripts, located in the
Workspace. Can use wildcards like \(aqjobs/*/*/*.groovy\(aq (Required
if script\-text is not specified)
.IP \(bu 2
\fBignore\-existing\fP (\fIstr\fP) \-\- Ignore previously generated jobs and views
.IP \(bu 2
\fBremoved\-job\-action\fP (\fIstr\fP) \-\- Specifies what to do when a previously
generated job is not referenced anymore, can be \(aqIGNORE\(aq, \(aqDISABLE\(aq,
or \(aqDELETE\(aq (default \(aqIGNORE\(aq)
.IP \(bu 2
\fBremoved\-view\-action\fP (\fIstr\fP) \-\- Specifies what to do when a previously
generated view is not referenced anymore, can be \(aqIGNORE\(aq or \(aqDELETE\(aq.
(default \(aqIGNORE\(aq)
.IP \(bu 2
\fBlookup\-strategy\fP (\fIstr\fP) \-\- Determines how relative job names in DSL
scripts are interpreted, can be \(aqJENKINS_ROOT\(aq or \(aqSEED_JOB\(aq.
(default \(aqJENKINS_ROOT\(aq)
.IP \(bu 2
\fBadditional\-classpath\fP (\fIstr\fP) \-\- Newline separated list of additional
classpath entries for the Job DSL scripts. All entries must be
relative to the workspace root, e.g. build/classes/main. (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- dsl:
      script\-text: \(dqjob { name \(aqdsljob\(aq }\(dq
      ignore\-existing: \(dqtrue\(dq
      removed\-job\-action: \(dqDISABLE\(dq
      removed\-view\-action: \(dqDELETE\(dq
      lookup\-strategy: \(dqSEED_JOB\(dq
      additional\-classpath: \(dq*.jar\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- dsl:
      target: \(dqjobs/**/*.groovy\(dq
      ignore\-existing: \(dqtrue\(dq
      removed\-job\-action: \(dqDISABLE\(dq
      removed\-view\-action: \(dqDELETE\(dq
      lookup\-strategy: \(dqSEED_JOB\(dq
      additional\-classpath: \(dq*.jar\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B fingerprint()
Adds the ability to generate fingerprints as build steps instead of waiting
for a build to complete.
.sp
Requires the Jenkins \fI\%Fingerprint Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBtargets\fP (\fIstr\fP) \-\- Files to fingerprint (default \(aq\(aq)
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- fingerprint:
      targets: module/dist/**/*.zip

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- fingerprint

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B github\-notifier()
Set pending build status on Github commit.
.sp
Requires the Jenkins \fI\%Github Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- github\-notifier

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gradle()
Execute gradle tasks.
.sp
Requires the Jenkins \fI\%Gradle Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtasks\fP (\fIstr\fP) \-\- List of tasks to execute
.IP \(bu 2
\fBgradle\-name\fP (\fIstr\fP) \-\- Use a custom gradle name (default \(aq\(aq)
.IP \(bu 2
\fBwrapper\fP (\fIbool\fP) \-\- use gradle wrapper (default false)
.IP \(bu 2
\fBexecutable\fP (\fIbool\fP) \-\- make gradlew executable (default false)
.IP \(bu 2
\fBswitches\fP (\fIlist\fP) \-\- Switches for gradle, can have multiples
.IP \(bu 2
\fBuse\-root\-dir\fP (\fIbool\fP) \-\- Whether to run the gradle script from the
top level directory or from a different location (default false)
.IP \(bu 2
\fBroot\-build\-script\-dir\fP (\fIstr\fP) \-\- If your workspace has the
top\-level build.gradle in somewhere other than the module
root directory, specify the path (relative to the module
root) here, such as ${workspace}/parent/ instead of just
${workspace}.
.IP \(bu 2
\fBbuild\-file\fP (\fIstr\fP) \-\- name of gradle build script (default \(aqbuild.gradle\(aq)
.IP \(bu 2
\fBpass\-system\-properties\fP (\fIbool\fP) \-\- Pass all parameters as
System properties (default false)
.IP \(bu 2
\fBpass\-project\-properties\fP (\fIbool\fP) \-\- Pass all parameters as
Project properties (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- gradle:
      build\-file: \(dqbuild.gradle\(dq
      gradle\-name: \(dqgradle\-1.2\(dq
      wrapper: true
      executable: true
      use\-root\-dir: true
      root\-build\-script\-dir: ${workspace}/tests
      pass\-system\-properties: true
      pass\-project\-properties: true
      switches:
        \- \(dq\-g /foo/bar/.gradle\(dq
        \- \(dq\-PmavenUserName=foobar\(dq
      tasks: |
             init
             build
             tests

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B grails()
Execute a grails build step.
.sp
Requires the \fI\%Jenkins Grails Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuse\-wrapper\fP (\fIbool\fP) \-\- Use a grails wrapper (default false)
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Select a grails installation to use (default \(aq(Default)\(aq)
.IP \(bu 2
\fBforce\-upgrade\fP (\fIbool\fP) \-\- Run \(aqgrails upgrade \-\-non\-interactive\(aq
first (default false)
.IP \(bu 2
\fBnon\-interactive\fP (\fIbool\fP) \-\- append \-\-non\-interactive to all build targets
(default false)
.IP \(bu 2
\fBtargets\fP (\fIstr\fP) \-\- Specify target(s) to run separated by spaces (required)
.IP \(bu 2
\fBserver\-port\fP (\fIstr\fP) \-\- Specify a value for the server.port system
property (default \(aq\(aq)
.IP \(bu 2
\fBwork\-dir\fP (\fIstr\fP) \-\- Specify a value for the grails.work.dir system
property (default \(aq\(aq)
.IP \(bu 2
\fBproject\-dir\fP (\fIstr\fP) \-\- Specify a value for the grails.project.work.dir
system property (default \(aq\(aq)
.IP \(bu 2
\fBbase\-dir\fP (\fIstr\fP) \-\- Specify a path to the root of the Grails
project (default \(aq\(aq)
.IP \(bu 2
\fBproperties\fP (\fIstr\fP) \-\- Additional system properties to set (default \(aq\(aq)
.IP \(bu 2
\fBplain\-output\fP (\fIbool\fP) \-\- append \-\-plain\-output to all build targets
(default false)
.IP \(bu 2
\fBstack\-trace\fP (\fIbool\fP) \-\- append \-\-stack\-trace to all build targets
(default false)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- append \-\-verbose to all build targets
(default false)
.IP \(bu 2
\fBrefresh\-dependencies\fP (\fIbool\fP) \-\- append \-\-refresh\-dependencies to all
build targets (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- grails:
      use\-wrapper: true
      name: grails\-2.2.2
      force\-upgrade: true
      non\-interactive: true
      targets: war ear
      server\-port: 8003
      work\-dir: ./grails\-work
      project\-dir: ./project\-work
      base\-dir: ./grails/project
      properties: program.name=foo
      plain\-output: true
      stack\-trace: true
      verbose: true
      refresh\-dependencies: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- grails:
      targets: foo

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B groovy()
Execute a groovy script or command.
.sp
Requires the Jenkins \fI\%Groovy Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfile\fP (\fIstr\fP) \-\- Groovy file to run. (Alternative: you can chose a command
instead)
.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- Groovy command to run. (Alternative: you can chose a
script file instead)
.IP \(bu 2
\fBversion\fP (\fIstr\fP) \-\- Groovy version to use. (default \(aq(Default)\(aq)
.IP \(bu 2
\fBparameters\fP (\fIstr\fP) \-\- Parameters for the Groovy executable. (default \(aq\(aq)
.IP \(bu 2
\fBscript\-parameters\fP (\fIstr\fP) \-\- These parameters will be passed to the script.
(default \(aq\(aq)
.IP \(bu 2
\fBproperties\fP (\fIstr\fP) \-\- Instead of passing properties using the \-D parameter
you can define them here. (default \(aq\(aq)
.IP \(bu 2
\fBjava\-opts\fP (\fIstr\fP) \-\- Direct access to JAVA_OPTS. Properties allows only
\-D properties, while sometimes also other properties like \-XX need to
be setup. It can be done here. This line is appended at the end of
JAVA_OPTS string. (default \(aq\(aq)
.IP \(bu 2
\fBclass\-path\fP (\fIstr\fP) \-\- Specify script classpath here. Each line is one
class path item. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- groovy:
      command: \(dqprintln Hello\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- groovy:
      command: \(dqSome command\(dq
      version: \(dqGroovy 1.2\(dq
      parameters: \(dqparameters\(dq
      script\-parameters: \(dqscript parameters\(dq
      properties: \(dqproperties\(dq
      java\-opts: \(dqjava opts\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B http\-request()
This plugin sends a http request to an url with some parameters.
.sp
Requires the Jenkins \fI\%HTTP Request Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- Specify an URL to be requested (required)
.IP \(bu 2
\fBmode\fP (\fIstr\fP) \-\- 
.sp
The http mode of the request (default GET)
.INDENT 2.0
.TP
.B mode values
.INDENT 7.0
.IP \(bu 2
\fBGET\fP
.IP \(bu 2
\fBPOST\fP
.IP \(bu 2
\fBPUT\fP
.IP \(bu 2
\fBDELETE\fP
.IP \(bu 2
\fBHEAD\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBcontent\-type\fP (\fIstr\fP) \-\- Add \(aqContent\-type: foo\(aq HTTP request headers
where foo is the http content\-type the request is using.
(default NOT_SET)
.IP \(bu 2
\fBaccept\-type\fP (\fIstr\fP) \-\- 
.sp
Add \(aqAccept: foo\(aq HTTP request headers
where foo is the http content\-type to accept (default NOT_SET)
.INDENT 2.0
.TP
.B content\-type and accept\-type values
.INDENT 7.0
.IP \(bu 2
\fBNOT_SET\fP
.IP \(bu 2
\fBTEXT_HTML\fP
.IP \(bu 2
\fBAPPLICATION_JSON\fP
.IP \(bu 2
\fBAPPLICATION_TAR\fP
.IP \(bu 2
\fBAPPLICATION_ZIP\fP
.IP \(bu 2
\fBAPPLICATION_OCTETSTREAM\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBoutput\-file\fP (\fIstr\fP) \-\- Name of the file in which to write response data
(default \(aq\(aq)
.IP \(bu 2
\fBtime\-out\fP (\fIint\fP) \-\- Specify a timeout value in seconds (default 0)
.IP \(bu 2
\fBconsole\-log\fP (\fIbool\fP) \-\- This allows you to turn off writing the response
body to the log (default false)
.IP \(bu 2
\fBpass\-build\fP (\fIbool\fP) \-\- Should build parameters be passed to the URL
being called (default false)
.IP \(bu 2
\fBvalid\-response\-codes\fP (\fIstr\fP) \-\- Configure response code to mark an
execution as success. You can configure simple code such as \(dq200\(dq
or multiple codes separated by comma(\(aq,\(aq) e.g. \(dq200,404,500\(dq
Interval of codes should be in format From:To e.g. \(dq100:399\(dq.
The default (as if empty) is to fail to 4xx and 5xx.
That means success from 100 to 399 \(dq100:399\(dq
To ignore any response code use \(dq100:599\(dq. (default \(aq\(aq)
.IP \(bu 2
\fBvalid\-response\-content\fP (\fIstr\fP) \-\- If set response must contain this string
to mark an execution as success (default \(aq\(aq)
.IP \(bu 2
\fBauthentication\-key\fP (\fIstr\fP) \-\- Authentication that will be used before this
request. Authentications are created in global configuration under a
key name that is selected here.
.IP \(bu 2
\fBcustom\-headers\fP (\fIlist\fP) \-\- 
.sp
list of header parameters
.INDENT 2.0
.TP
.B custom\-header
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of the header
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) \-\- Value of the header
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- http\-request:
      url: http://example.com/jenkinsTest

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- http\-request:
      url: http://example.com/jenkinsTest
      mode: POST
      pass\-build: true
      content\-type: TEXT_HTML
      accept\-type: TEXT_HTML
      output\-file: response_file.txt
      authentication\-key: authenticationkey
      console\-log: true
      time\-out: 10
      valid\-response\-codes: 100:399
      valid\-response\-content: foo
      custom\-headers:
        \- name: header
          value: value
        \- name: header2
          value: value2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B inject()
Inject an environment for the job.
.sp
Requires the Jenkins \fI\%EnvInject Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproperties\-file\fP (\fIstr\fP) \-\- the name of the property file (optional)
.IP \(bu 2
\fBproperties\-content\fP (\fIstr\fP) \-\- the properties content (optional)
.IP \(bu 2
\fBscript\-file\fP (\fIstr\fP) \-\- the name of a script file to run (optional)
.IP \(bu 2
\fBscript\-content\fP (\fIstr\fP) \-\- the script content (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- inject:
      properties\-file: example.prop
      properties\-content: EXAMPLE=foo\-bar
      script\-file: script.sh
      script\-content: script content

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jenkins\-jira\-issue\-updater()
Updates issues in Atlassian JIRA as part of a Jenkins job.
.sp
Requires the Jenkins \fI\%Jira Issue Updater Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbase\-url\fP (\fIstr\fP) \-\- The base url of the rest API. (default \(aq\(aq)
.IP \(bu 2
\fBusername\fP (\fIstr\fP) \-\- The Jira username (required)
.IP \(bu 2
\fBpassword\fP (\fIstr\fP) \-\- The Jira password (required)
.IP \(bu 2
\fBjql\fP (\fIstr\fP) \-\- The JQL used to select the issues to update. (required)
.IP \(bu 2
\fBworkflow\fP (\fIstr\fP) \-\- The Name of the workflow action to be executed.
(default \(aq\(aq)
.IP \(bu 2
\fBcomment\fP (\fIstr\fP) \-\- The Jira comment to be added. (default \(aq\(aq)
.IP \(bu 2
\fBcustom\-Id\fP (\fIstr\fP) \-\- The Jira custom field to be edited. (default \(aq\(aq)
.IP \(bu 2
\fBcustom\-value\fP (\fIstr\fP) \-\- Jira custom field value. (default \(aq\(aq)
.IP \(bu 2
\fBfail\-if\-error\fP (\fIbool\fP) \-\- Fail this build if JQL returns error.
((default false)
.IP \(bu 2
\fBfail\-if\-no\-match\fP (\fIbool\fP) \-\- Fail this build if no issues are matched.
(default false)
.IP \(bu 2
\fBfail\-if\-no\-connection\fP (\fIbool\fP) \-\- Fail this build if can\(aqt connect to Jira.
(default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- jenkins\-jira\-issue\-updater:
      username: \(aqUsername\(aq
      password: \(aqPassword\(aq
      jql: \(aqjql\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- jenkins\-jira\-issue\-updater:
      base\-url: url
      username: your\-username
      password: your\-password
      jql: project\-key
      workflow: workflow\-name
      comment: comment
      custom\-Id: ID
      custom\-value: value
      fail\-if\-error: true
      fail\-if\-no\-match: true
      fail\-if\-no\-connection: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jms\-messaging()
.INDENT 7.0
.TP
.B The JMS Messaging Plugin provides the following functionality:
.INDENT 7.0
.IP \(bu 2
A build trigger to submit jenkins jobs upon receipt
of a matching message.
.IP \(bu 2
A builder that may be used to submit a message to the topic
upon the completion of a job
.IP \(bu 2
A post\-build action that may be used to submit a message to the topic
upon the completion of a job
.UNINDENT
.TP
.B JMS Messaging provider types supported:
.INDENT 7.0
.IP \(bu 2
ActiveMQ
.IP \(bu 2
FedMsg
.UNINDENT
.UNINDENT
.sp
Requires the Jenkins \fI\%JMS Messaging Plugin Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBoverride\-topic\fP (\fIstr\fP) \-\- If you need to override the default topic.
(default \(aq\(aq)
.IP \(bu 2
\fBprovider\-name\fP (\fIstr\fP) \-\- Name of message provider setup in the
global config. (default \(aq\(aq)
.IP \(bu 2
\fBmsg\-type\fP (\fIstr\fP) \-\- A message type
(default \(aqCodeQualityChecksDone\(aq)
.IP \(bu 2
\fBmsg\-props\fP (\fIstr\fP) \-\- Message header to publish. (default \(aq\(aq)
.IP \(bu 2
\fBmsg\-content\fP (\fIstr\fP) \-\- Message body to publish. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- jms\-messaging:
      override\-topic: org.centos.stage.ci.pipeline.compose.complete
      provider\-name: fedmsg
      msg\-type: Custom
      msg\-props: |
        topic=org.centos.prod.ci.pipeline.compose.complete
        username=fedora\-atomic
      msg\-content: |
        {
          \(dqbuild_url\(dq: \(dq${BUILD_URL}\(dq,
          \(dqcompose_url\(dq: \(dq<full\-url\-to\-compose>\(dq,
          \(dqbuild_id\(dq: \(dq${BUILD_ID}\(dq,
          \(dqref\(dq: \(dqfedora/rawhide/${basearch}/atomic\-host\(dq,
          \(dqrev\(dq: \(dq<sha of the commit from dist\-git>\(dq,
          \(dqnamespace\(dq: \(dqrpms\(dq,
          \(dqrepo\(dq: \(dqphp\-simplepie\(dq,
          \(dqstatus\(dq: \(dq<success/failure/aborted>\(dq,
          \(dqtest_guidance\(dq: \(dq<comma\-separated\-list\-of\-test\-suites\-to\-run>\(dq
        }

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- jms\-messaging:
      provider\-name: fedmsg
      msg\-type: CodeQualityChecksDone
      msg\-props: test
      msg\-content: test

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B kmap()
Publish mobile applications to your Keivox KMAP Private Mobile App Store.
.sp
Requires the Jenkins \fI\%Keivox KMAP Private Mobile App Store
Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusername\fP (\fIstr\fP) \-\- KMAP\(aqs user email with permissions to upload/publish
applications to KMAP (required)
.IP \(bu 2
\fBpassword\fP (\fIstr\fP) \-\- Password for the KMAP user uploading/publishing
applications (required)
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- KMAP\(aqs url. This url must always end with \(dq/kmap\-client/\(dq.
For example: \fI\%http://testing.example.org/kmap\-client/\fP (required)
.IP \(bu 2
\fBcategories\fP (\fIstr\fP) \-\- Categories\(aq names. If you want to add the application
to more than one category, write the categories between commas.
(required)
.IP \(bu 2
\fBfile\-path\fP (\fIstr\fP) \-\- Path to the application\(aqs file (required)
.IP \(bu 2
\fBapp\-name\fP (\fIstr\fP) \-\- KMAP\(aqs application name (required)
.IP \(bu 2
\fBbundle\fP (\fIstr\fP) \-\- Bundle indentifier (default \(aq\(aq)
.IP \(bu 2
\fBversion\fP (\fIstr\fP) \-\- Application\(aqs version (required)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Application\(aqs description (default \(aq\(aq)
.IP \(bu 2
\fBicon\-path\fP (\fIstr\fP) \-\- Path to the application\(aqs icon (default \(aq\(aq)
.IP \(bu 2
\fBpublish\-optional\fP (\fIbool\fP) \-\- 
.sp
Publish application after it has been uploaded
to KMAP (default false)
.INDENT 2.0
.TP
.B publish\-optional
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBgroups\fP (\(aqstr\(aq) \-\- groups\(aq names to publish the application
(default \(aq\(aq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBusers\fP (\(aqstr\(aq) \-\- users\(aq names to publish the application
(default \(aq\(aq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnotify\-users\fP (\(aqbool\(aq) \-\- Send notifications to the users and
groups when publishing the application (default false)
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- kmap:
      username: user@user.com
      password: password
      url: http://foo.com/kmap\-client/
      categories: Productivity
      file\-path: ${WORKSPACE}/path/to/file.extension
      app\-name: AppName
      version: b${BUILD_NUMBER}_r${SVN_REVISION}

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- kmap:
      username: user@user.com
      password: password
      url: http://foo.com/kmap\-client/
      categories: Productivity
      file\-path: ${WORKSPACE}/path/to/file.extension
      app\-name: AppName
      bundle: foo.apk
      version: b${BUILD_NUMBER}_r${SVN_REVISION}
      description: description
      icon\-path: ${WORKSPACE}/target/application.png
      publish\-optional: true
      groups: MobileUsers
      users: user@user.com
      notify\-users: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B managed\-script()
This step allows you to reference and execute a centrally managed
script within your build.
.sp
Requires the Jenkins \fI\%Managed Scripts Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBscript\-id\fP (\fIstr\fP) \-\- Id of script to execute (required)
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- 
.sp
Type of managed file (default script)
.INDENT 2.0
.TP
.B type values
.INDENT 7.0
.IP \(bu 2
\fBbatch\fP: Execute managed windows batch
.IP \(bu 2
\fBscript\fP: Execute managed script
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBargs\fP (\fIlist\fP) \-\- Arguments to be passed to referenced script
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- managed\-script:
      script\-id: org.jenkinsci.plugins.managedscripts.ScriptConfig1401886156431
      type: script
      args:
        \- arg1
        \- arg2

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- managed\-script:
      script\-id: org.jenkinsci.plugins.managedscripts.WinBatchConfig1402391729132
      type: batch
      args:
        \- arg1
        \- arg2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maven\-builder()
Execute Maven3 builder
.sp
Allows your build jobs to deploy artifacts automatically to Artifactory.
.sp
Requires the Jenkins \fI\%Artifactory Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of maven installation from the configuration (required)
.IP \(bu 2
\fBpom\fP (\fIstr\fP) \-\- Location of pom.xml (default \(aqpom.xml\(aq)
.IP \(bu 2
\fBgoals\fP (\fIstr\fP) \-\- Goals to execute (required)
.IP \(bu 2
\fBmaven\-opts\fP (\fIstr\fP) \-\- Additional options for maven (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
      \- maven\-builder:
          name: mvn3
          pom: modules/pom.xml
          goals: clean install

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maven\-target()
Execute top\-level Maven targets.
.sp
Requires the Jenkins \fI\%Config File Provider Plugin\fP for the Config File Provider \(dqsettings\(dq
and \(dqglobal\-settings\(dq config.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgoals\fP (\fIstr\fP) \-\- Goals to execute
.IP \(bu 2
\fBproperties\fP (\fIstr\fP) \-\- Properties for maven, can have multiples
.IP \(bu 2
\fBpom\fP (\fIstr\fP) \-\- Location of pom.xml (default \(aqpom.xml\(aq)
.IP \(bu 2
\fBprivate\-repository\fP (\fIbool\fP) \-\- Use private maven repository for this
job (default false)
.IP \(bu 2
\fBmaven\-version\fP (\fIstr\fP) \-\- Installation of maven which should be used
(optional)
.IP \(bu 2
\fBjava\-opts\fP (\fIstr\fP) \-\- java options for maven, can have multiples,
must be in quotes (optional)
.IP \(bu 2
\fBsettings\fP (\fIstr\fP) \-\- Path to use as user settings.xml
It is possible to provide a ConfigFileProvider settings file, such as
see CFP Example below. (optional)
.IP \(bu 2
\fBsettings\-type\fP (\fIstr\fP) \-\- Type of settings file file|cfp. (default file)
.IP \(bu 2
\fBglobal\-settings\fP (\fIstr\fP) \-\- Path to use as global settings.xml
It is possible to provide a ConfigFileProvider settings file, such as
see CFP Example below. (optional)
.IP \(bu 2
\fBglobal\-settings\-type\fP (\fIstr\fP) \-\- Type of settings file file|cfp. (default
file)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
        \- maven\-target:
            maven\-version: Maven3
            pom: parent/pom.xml
            goals: clean
            private\-repository: true
            properties:
              \- foo=bar
              \- bar=foo
            java\-opts:
              \- \(dq\-Xms512m \-Xmx1024m\(dq
              \- \(dq\-XX:PermSize=128m \-XX:MaxPermSize=256m\(dq
            settings: mvn/settings.xml
            global\-settings: mvn/globalsettings.xml

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
CFP Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
postbuilders:
      \- maven\-target:
          maven\-version: mvn30
          goals: clean verify
          settings: org.jenkinsci.plugins.configfiles.maven.MavenSettingsConfig0123456789012
          global\-settings: org.jenkinsci.plugins.configfiles.maven.GlobalMavenSettingsConfig0123456789012

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B msbuild()
Build .NET project using msbuild.
.sp
Requires the Jenkins :jenkins\-plugins:\(aqMSBuild Plugin <msbuild>\(ga.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmsbuild\-version\fP (\fIstr\fP) \-\- which msbuild configured in Jenkins to use
(default \(aq(Default)\(aq)
.IP \(bu 2
\fBsolution\-file\fP (\fIstr\fP) \-\- location of the solution file to build (required)
.IP \(bu 2
\fBextra\-parameters\fP (\fIstr\fP) \-\- extra parameters to pass to msbuild (default \(aq\(aq)
.IP \(bu 2
\fBpass\-build\-variables\fP (\fIbool\fP) \-\- should build variables be passed
to msbuild (default true)
.IP \(bu 2
\fBcontinue\-on\-build\-failure\fP (\fIbool\fP) \-\- should the build continue if
msbuild returns an error (default false)
.IP \(bu 2
\fBunstable\-if\-warnings\fP (\fIbool\fP) \-\- If set to true and warnings on compilation,
the build will be unstable (>=1.20) (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- msbuild:
      solution\-file: \(dqMySolution.sln\(dq
      msbuild\-version: \(dqmsbuild\-4.0\(dq
      extra\-parameters: \(dq/maxcpucount:4\(dq
      pass\-build\-variables: False
      continue\-on\-build\-failure: True
      unstable\-if\-warnings: True

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- msbuild:
      solution\-file: MySolution.sln

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B multijob()
Define a multijob phase.
.sp
Requires the Jenkins \fI\%Multijob Plugin\fP\&.
.sp
This builder may only be used in
\fBjenkins_jobs.modules.project_multijob.MultiJob\fP projects.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- MultiJob phase name
.IP \(bu 2
\fBcondition\fP (\fIstr\fP) \-\- when to trigger the other job.
Can be: \(aqSUCCESSFUL\(aq, \(aqUNSTABLE\(aq, \(aqCOMPLETED\(aq, \(aqFAILURE\(aq, \(aqALWAYS\(aq.
(default \(aqSUCCESSFUL\(aq)
.IP \(bu 2
\fBexecution\-type\fP (\fIstr\fP) \-\- Define how to run jobs in a phase:
sequentially or parallel.
Can be: \(aqPARALLEL\(aq, \(aqSEQUENTIALLY\(aq
(default \(aqPARALLEL\(aq)
.IP \(bu 2
\fBprojects\fP (\fIlist\fP) \-\- 
.sp
list of projects to include in the MultiJob phase
.INDENT 2.0
.TP
.B Project
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Project name
.IP \(bu 2
\fBalias\fP (\fIstr\fP) \-\- Project alias, which will be shown
in MultiJob Overview. Helpful when working with the same
project multiple times with different configurations
.IP \(bu 2
\fBcurrent\-parameters\fP (\fIbool\fP) \-\- Pass current build
parameters to the other job (default false)
.IP \(bu 2
\fBnode\-label\-name\fP (\fIstr\fP) \-\- Define a list of nodes
on which the job should be allowed to be executed on.
Requires NodeLabel Parameter Plugin (optional)
.IP \(bu 2
\fBnode\-label\fP (\fIstr\fP) \-\- Define a label
of \(aqRestrict where this project can be run\(aq on the fly.
Requires NodeLabel Parameter Plugin (optional)
.IP \(bu 2
\fBnode\-parameters\fP (\fIbool\fP) \-\- Use the same Node for
the triggered builds that was used for this build. (optional)
.IP \(bu 2
\fBgit\-revision\fP (\fIbool\fP) \-\- Pass current git\-revision
to the other job (default false)
.IP \(bu 2
\fBproperty\-file\fP (\fIstr\fP) \-\- Pass properties from file
to the other job (optional)
.IP \(bu 2
\fBpredefined\-parameters\fP (\fIstr\fP) \-\- Pass predefined
parameters to the other job (optional)
.IP \(bu 2
\fBabort\-all\-job\fP (\fIbool\fP) \-\- Kill allsubs job and the phase job,
if this subjob is killed (default false)
.IP \(bu 2
\fBaggregate\-results\fP (\fIbool\fP) \-\- Aggregate test results.
(default false)
.IP \(bu 2
\fBenable\-condition\fP (\fIstr\fP) \-\- Condition to run the
job in groovy script format (optional)
.IP \(bu 2
\fBkill\-phase\-on\fP (\fIstr\fP) \-\- Stop the phase execution
on specific job status. Can be \(aqFAILURE\(aq, \(aqUNSTABLE\(aq,
\(aqNEVER\(aq. (optional)
.IP \(bu 2
\fBrestrict\-matrix\-project\fP (\fIstr\fP) \-\- Filter that
restricts the subset of the combinations that the
downstream project will run (optional)
.IP \(bu 2
.INDENT 2.0
.TP
\fBretry\fP (\fIdict\fP): Enable retry strategy (optional)
.INDENT 7.0
.TP
.B retry
.INDENT 7.0
.IP \(bu 2
\fBmax\-retry\fP (\fIint\fP) \-\- Max number of retries
(default 0)
.IP \(bu 2
\fBstrategy\-path\fP (\fIstr\fP) \-\- Parsing rules path
(required)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- multijob:
      name: PhaseOne
      condition: SUCCESSFUL
      execution\-type: PARALLEL
      projects:
        \- name: PhaseOneJobA
          current\-parameters: true
          node\-label\-name: \(dqvm_name\(dq
          node\-label: \(dqagent\-${BUILD_NUMBER}\(dq
          git\-revision: true
          abort\-all\-job: true
        \- name: PhaseOneJobB
          current\-parameters: true
          property\-file: build.props
  \- multijob:
      name: PhaseTwo
      condition: UNSTABLE
      execution\-type: SEQUENTIALLY
      projects:
        \- name: PhaseTwoJobA
          current\-parameters: true
          predefined\-parameters: foo=bar
          node\-parameters: true
          aggregate\-results: true
        \- name: PhaseTwoJobB
          current\-parameters: false
          kill\-phase\-on: UNSTABLE
          enable\-condition: \(dq${BUILDNUMBER} % 2 == 1\(dq
          restrict\-matrix\-project: \(aqJVM_VARIANT == \(dqserver\(dq\(aq
  \- multijob:
      name: PhaseThree
      condition: ALWAYS
      projects:
        \- name: PhaseThreeJobA
          current\-parameters: true
          kill\-phase\-on: FAILURE
  \- multijob:
      name: PhaseFour
      execution\-type: PARALLEL
      projects:
        \- name: PhaseFourJobA
          retry:
              max\-retry: 3
              strategy\-path: \(dq/PhaseFour/PhaseFourRetry.prop\(dq
  \- multijob:
      name: PhaseFive
      projects:
        \- name: PhaseFiveJobA
          alias: PhaseFiveJobRunA
        \- name: PhaseFiveJobA
          alias: PhaseFiveJobRunB

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B nexus\-artifact\-uploader()
To upload result of a build as an artifact in Nexus without the need of
Maven.
.sp
Requires the Jenkins \fI\%Nexus Artifact Uploader Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprotocol\fP (\fIstr\fP) \-\- Protocol to use to connect to Nexus (default https)
.IP \(bu 2
\fBnexus_url\fP (\fIstr\fP) \-\- Nexus url (without protocol) (default \(aq\(aq)
.IP \(bu 2
\fBnexus_user\fP (\fIstr\fP) \-\- Username to upload artifact to Nexus (default \(aq\(aq)
.IP \(bu 2
\fBnexus_password\fP (\fIstr\fP) \-\- Password to upload artifact to Nexus
(default \(aq\(aq)
.IP \(bu 2
\fBgroup_id\fP (\fIstr\fP) \-\- GroupId to set for the artifact to upload
(default \(aq\(aq)
.IP \(bu 2
\fBartifact_id\fP (\fIstr\fP) \-\- ArtifactId to set for the artifact to upload
(default \(aq\(aq)
.IP \(bu 2
\fBversion\fP (\fIstr\fP) \-\- Version to set for the artifact to upload
(default \(aq\(aq)
.IP \(bu 2
\fBpackaging\fP (\fIstr\fP) \-\- Packaging to set for the artifact to upload
(default \(aq\(aq)
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- Type to set for the artifact to upload (default \(aq\(aq)
.IP \(bu 2
\fBclassifier\fP (\fIstr\fP) \-\- Classifier to set for the artifact to upload
(default \(aq\(aq)
.IP \(bu 2
\fBrepository\fP (\fIstr\fP) \-\- In which repository to upload the artifact
(default \(aq\(aq)
.IP \(bu 2
\fBfile\fP (\fIstr\fP) \-\- File which will be the uploaded artifact (default \(aq\(aq)
.IP \(bu 2
\fBcredentials_id\fP (\fIstr\fP) \-\- Credentials to use (instead of password)
(default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
File Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- nexus\-artifact\-uploader:
      nexus_url: \(aqnexus.org\(aq
      group_id: \(aqcom.example\(aq
      artifact_id: \(aqartifact\(aq
      version: \(aq1.0\(aq
      packaging: \(aqpom\(aq
      type: \(aqzip\(aq
      repository: \(aqmy\-hosted\-repo\(aq
      file: \(aq/var/lib/jenkins/workspace/my_job/result.zip\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B nexus\-iq\-policy\-evaluator()
Integrates the Nexus Lifecycle into a Jenkins job.
This function triggers \(aqInvokes Nexus Policy Evaluation\(aq.
.sp
Requires the Jenkins \fI\%Nexus Platform Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstage\fP (\fIstr\fP) \-\- 
.sp
Controls the stage the policy evaluation will be
run against on the Nexus IQ Server (required)
.INDENT 2.0
.TP
.B stage values
.INDENT 7.0
.IP \(bu 2
\fBbuild\fP
.IP \(bu 2
\fBstage\-release\fP
.IP \(bu 2
\fBrelease\fP
.IP \(bu 2
\fBoperate\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBapplication\-type\fP (\fIdict\fP) \-\- 
.sp
Specifies an IQ Application (default manual)
.INDENT 2.0
.TP
.B application\-type values
.INDENT 7.0
.IP \(bu 2
\fBmanual\fP
.IP \(bu 2
\fBselected\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBapplication\-id\fP (\fIstr\fP) \-\- Specify the IQ Application ID (required)
.IP \(bu 2
\fBscan\-patterns\fP (\fIlist\fP) \-\- List of Ant\-style patterns relative to the
workspace root that denote files/archives to be scanned (default [])
.IP \(bu 2
\fBfail\-build\-network\-error\fP (\fIbool\fP) \-\- Controls the build outcome if there
is a failure in communicating with the Nexus IQ Server (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- nexus\-iq\-policy\-evaluator:
      stage: \(aqbuild\(aq
      application\-id: \(aqnexus\-iq\-application\-id001\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- nexus\-iq\-policy\-evaluator:
      stage: \(aqstage\-release\(aq
      application\-type: \(aqselected\(aq
      application\-id: \(aqnexus\-iq\-application\-id002\(aq
      scan\-patterns:
        \- \(aq**/target/*.war\(aq
        \- \(aq**/target/*.ear\(aq
      fail\-build\-network\-error: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B nexus\-repo\-manager()
Allows for artifacts selected in Jenkins packages to be
available in Nexus Repository Manager.
.sp
Requires the Jenkins \fI\%Nexus Platform Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinstance\-id\fP (\fIstr\fP) \-\- The ID of the Nexus Instance (required)
.IP \(bu 2
\fBrepo\-id\fP (\fIstr\fP) \-\- The ID of the Nexus Repository (required)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- nexus\-repo\-manager:
        instance\-id: Nexus\-Repo\-Instance
        repo\-id: Releases

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B nodejs()
This plugin allows you to execute NodeJS scripts as a job build step.
.sp
Requires the Jenkins \fI\%NodeJS Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- NodeJS installation name
.IP \(bu 2
\fBscript\fP (\fIstr\fP) \-\- NodeJS script (required)
.IP \(bu 2
\fBconfig\-id\fP (\fIstr\fP) \-\- ID of npmrc config file, which is the
last field (a 32\-digit hexadecimal code) of the path of URL visible
after you clicked the file under Jenkins Managed Files.
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- nodejs:
      script: \(dqconsole.log(\(aqSome output\(aq);\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- nodejs:
      name: \(dqNodeJS_8.1\(dq
      script: \(dqconsole.log(\(aqSome output\(aq);\(dq
      config\-id: \(dqe3757442\-7c21\-4a65\-a1ff\-6c70f5c6df34\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-build\-verify()
Performs the equivalent of an \(aqoc get builds\(ga command invocation for the
provided buildConfig key provided; once the list of builds are obtained,
the state of the latest build is inspected for up to a minute to see if
it has completed successfully.
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default \(aqhttps://openshift.default.svc.cluster.local\(aq)
.IP \(bu 2
\fBbld\-cfg\fP (\fIstr\fP) \-\- The value here should be whatever was the output
form \fIoc project\fP when you created the BuildConfig you
want to run a Build on (default \(aqfrontend\(aq)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default \(aqtest\(aq)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-build\-verify:
      api\-url: https://openshift.example.local.url/
      bld\-cfg: front
      namespace: test\-build
      auth\-token: ose\-key\-buildv1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-build\-verify

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-builder()
Perform builds in OpenShift for the job.
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default \(aqhttps://openshift.default.svc.cluster.local\(aq)
.IP \(bu 2
\fBbld\-cfg\fP (\fIstr\fP) \-\- The value here should be whatever was the output
form \fIoc project\fP when you created the BuildConfig you want to run a
Build on (default \(aqfrontend\(aq)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default \(aqtest\(aq)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBcommit\-ID\fP (\fIstr\fP) \-\- The value here is what you supply with the
\-\-commit option when invoking the
OpenShift \fIoc start\-build\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.IP \(bu 2
\fBbuild\-name\fP (\fIstr\fP) \-\- TThe value here is what you supply with the
\-\-from\-build option when invoking the
OpenShift \fIoc start\-build\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBshow\-build\-logs\fP (\fIbool\fP) \-\- Indicates whether the build logs get dumped
to the console of the Jenkins build. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-builder:
      api\-url: https://openshift.example.local.url/
      bld\-cfg: front
      namespace: test9
      auth\-token: ose\-builder1
      commit\-ID: ae489f7d
      verbose: true
      build\-name: ose\-test\-build
      show\-build\-logs: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-builder

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-creator()
Performs the equivalent of an oc create command invocation;
this build step takes in the provided JSON or YAML text, and if it
conforms to OpenShift schema, creates whichever
OpenShift resources are specified.
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default \(aqhttps://openshift.default.svc.cluster.local\(aq)
.IP \(bu 2
\fBjsonyaml\fP (\fIstr\fP) \-\- The JSON or YAML formatted text that conforms to
the schema for defining the various OpenShift resources. (default \(aq\(aq)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default \(aqtest\(aq)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-creator:
      api\-url: https://openshift.example.local.url/
      jsonyaml: \(aqfront: back\(aq
      namespace: test6
      auth\-token: ose\-key\-creator1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-creator

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-dep\-verify()
Determines whether the expected set of DeploymentConfig\(aqs,
ReplicationController\(aqs, and active replicas are present based on prior
use of the scaler (2) and deployer (3) steps
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default https://openshift.default.svc.cluster.local)
.IP \(bu 2
\fBdep\-cfg\fP (\fIstr\fP) \-\- The value here should be whatever was the output
form \fIoc project\fP when you created the BuildConfig you want to run a
Build on (default frontend)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default test)
.IP \(bu 2
\fBreplica\-count\fP (\fIint\fP) \-\- The value here should be whatever the number
of pods you want started for the deployment. (default 0)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-dep\-verify:
      api\-url: https://openshift.example.local.url/
      dep\-cfg: front
      namespace: test6
      replica\-count: 4
      auth\-token: ose\-key\-dep\-verify1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-dep\-verify

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-deployer()
Start a deployment in OpenShift for the job.
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default \(aqhttps://openshift.default.svc.cluster.local\(aq)
.IP \(bu 2
\fBdep\-cfg\fP (\fIstr\fP) \-\- The value here should be whatever was the output
form \fIoc project\fP when you created the BuildConfig you want to run a
Build on (default \(aqfrontend\(aq)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default \(aqtest\(aq)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-deployer:
      api\-url: https://openshift.example.local.url/
      dep\-cfg: front
      namespace: test3
      auth\-token: ose\-key\-deployer1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-deployer

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-img\-tagger()
Performs the equivalent of an oc tag command invocation in order to
manipulate tags for images in OpenShift ImageStream\(aqs
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default \(aqhttps://openshift.default.svc.cluster.local\(aq)
.IP \(bu 2
\fBtest\-tag\fP (\fIstr\fP) \-\- The equivalent to the name supplied to a
\fIoc get service\fP command line invocation.
(default \(aqorigin\-nodejs\-sample:latest\(aq)
.IP \(bu 2
\fBprod\-tag\fP (\fIstr\fP) \-\- The equivalent to the name supplied to a
\fIoc get service\fP command line invocation.
(default \(aqorigin\-nodejs\-sample:prod\(aq)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default \(aqtest\(aq)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-img\-tagger:
      api\-url: https://openshift.example.local.url/
      test\-tag: origin\-nodejs\-sample:test
      prod\-tag: origin\-nodejs\-sample:production
      namespace: test5
      auth\-token: ose\-key\-img1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-img\-tagger

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-scaler()
Scale deployments in OpenShift for the job.
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default \(aqhttps://openshift.default.svc.cluster.local\(aq)
.IP \(bu 2
\fBdep\-cfg\fP (\fIstr\fP) \-\- The value here should be whatever was the output
form \fIoc project\fP when you created the BuildConfig you want to run a
Build on (default \(aqfrontend\(aq)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default \(aqtest\(aq)
.IP \(bu 2
\fBreplica\-count\fP (\fIint\fP) \-\- The value here should be whatever the number
of pods you want started for the deployment. (default 0)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-scaler:
      api\-url: https://openshift.example.local.url/
      dep\-cfg: front
      namespace: test2
      replica\-count: 4
      auth\-token: ose\-key\-scaler1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-scaler

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-svc\-verify()
Verify a service is up in OpenShift for the job.
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default \(aqhttps://openshift.default.svc.cluster.local\(aq)
.IP \(bu 2
\fBsvc\-name\fP (\fIstr\fP) \-\- The equivalent to the name supplied to a
\fIoc get service\fP command line invocation. (default \(aqfrontend\(aq)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default \(aqtest\(aq)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-svc\-verify:
      api\-url: https://openshift.example.local.url/
      svc\-name: front
      namespace: test4
      auth\-token: ose\-key\-svc\-verify1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- openshift\-svc\-verify

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B powershell()
Execute a powershell command.
.sp
Requires the \fI\%Powershell Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameter
the powershell command to execute
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- powershell: \(dqfoo/foo.ps1\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B publish\-over\-cifs()
Upload files via CIFS.
.sp
Requires the Jenkins \fI\%Publish over CIFS Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fIstr\fP) \-\- name of the ssh site
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- destination directory
.IP \(bu 2
\fBtarget\-is\-date\-format\fP (\fIbool\fP) \-\- whether target is a date format. If true,
raw text should be quoted (default false)
.IP \(bu 2
\fBclean\-remote\fP (\fIbool\fP) \-\- should the remote directory be deleted before
transferring files (default false)
.IP \(bu 2
\fBsource\fP (\fIstr\fP) \-\- source path specifier
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \-\- excluded file pattern (optional)
.IP \(bu 2
\fBremove\-prefix\fP (\fIstr\fP) \-\- prefix to remove from uploaded file paths
(optional)
.IP \(bu 2
\fBfail\-on\-error\fP (\fIbool\fP) \-\- fail the build if an error occurs (default false)
.IP \(bu 2
\fBflatten\fP (\fIbool\fP) \-\- only create files on the server, don\(aqt create
directories (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- publish\-over\-cifs:
        site: \(aqcifs.share\(aq
        target: \(aqdest/dir\(aq
        source: \(aqbase/source/dir/**\(aq
        remove\-prefix: \(aqbase/source/dir\(aq
        excludes: \(aq**/*.excludedfiletype\(aq
        flatten: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B publish\-over\-ssh()
Send files or execute commands over SSH.
.sp
Requires the Jenkins \fI\%Publish over SSH Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fIstr\fP) \-\- name of the ssh site
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- destination directory
.IP \(bu 2
\fBtarget\-is\-date\-format\fP (\fIbool\fP) \-\- whether target is a date format. If true,
raw text should be quoted (default false)
.IP \(bu 2
\fBclean\-remote\fP (\fIbool\fP) \-\- should the remote directory be deleted before
transferring files (default false)
.IP \(bu 2
\fBsource\fP (\fIstr\fP) \-\- source path specifier
.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- a command to execute on the remote server (optional)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \-\- timeout in milliseconds for the Exec command (optional)
.IP \(bu 2
\fBuse\-pty\fP (\fIbool\fP) \-\- run the exec command in pseudo TTY (default false)
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \-\- excluded file pattern (optional)
.IP \(bu 2
\fBremove\-prefix\fP (\fIstr\fP) \-\- prefix to remove from uploaded file paths
(optional)
.IP \(bu 2
\fBfail\-on\-error\fP (\fIbool\fP) \-\- fail the build if an error occurs (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- publish\-over\-ssh:
        site: \(aqserver.example.com\(aq
        target: \(aqdest/dir\(aq
        source: \(aqbase/source/dir/**\(aq
        timeout: 1800000

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B python()
Execute a python command. Requires the Jenkins \fI\%Python plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBparameter\fP (\fIstr\fP) \-\- the python command to execute
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- python: \(aqimport foobar\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B runscope()
Execute a Runscope test.
.sp
Requires the Jenkins \fI\%Runscope Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtest\-trigger\-url\fP (\fIstr\fP) \-\- Trigger URL for test. (required)
.IP \(bu 2
\fBaccess\-token\fP (\fIstr\fP) \-\- OAuth Personal Access token. (required)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \-\- Timeout for test duration in seconds. (default 60)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- runscope:
      test\-trigger\-url: \(dqhttps://api.runscope.com/radar/xxxxxxxx\-xxxx\-xxxx\-xxxx\-xxxxxxxxxxxx/trigger\(dq
      access\-token: \(dq123456\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- runscope:
      test\-trigger\-url: \(dqhttps://api.runscope.com/radar/xxxxxxxx\-xxxx\-xxxx\-xxxx\-xxxxxxxxxxxx/trigger\(dq
      access\-token: \(dq123456\(dq
      timeout: 123

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B saltstack()
Send a message to Salt API.
.sp
Requires the Jenkins \fI\%saltstack plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBservername\fP (\fIstr\fP) \-\- Salt master server name (required)
.IP \(bu 2
\fBauthtype\fP (\fIstr\fP) \-\- Authentication type (\(aqpam\(aq or \(aqldap\(aq, default \(aqpam\(aq)
.IP \(bu 2
\fBcredentials\fP (\fIstr\fP) \-\- Credentials ID for which to authenticate to Salt
master (required)
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- Target minions (default \(aq\(aq)
.IP \(bu 2
\fBtargettype\fP (\fIstr\fP) \-\- Target type (\(aqglob\(aq, \(aqpcre\(aq, \(aqlist\(aq, \(aqgrain\(aq,
\(aqpillar\(aq, \(aqnodegroup\(aq, \(aqrange\(aq, or \(aqcompound\(aq, default \(aqglob\(aq)
.IP \(bu 2
\fBfunction\fP (\fIstr\fP) \-\- Function to execute (default \(aq\(aq)
.IP \(bu 2
\fBarguments\fP (\fIstr\fP) \-\- Salt function arguments (default \(aq\(aq)
.IP \(bu 2
\fBkwarguments\fP (\fIstr\fP) \-\- Salt keyword arguments (default \(aq\(aq)
.IP \(bu 2
\fBsaveoutput\fP (\fIbool\fP) \-\- Save Salt return data into environment variable
(default false)
.IP \(bu 2
\fBclientinterface\fP (\fIstr\fP) \-\- Client interface type (\(aqlocal\(aq, \(aqlocal\-batch\(aq,
or \(aqrunner\(aq, default \(aqlocal\(aq)
.IP \(bu 2
\fBwait\fP (\fIbool\fP) \-\- Wait for completion of command (default false)
.IP \(bu 2
\fBpolltime\fP (\fIstr\fP) \-\- Number of seconds to wait before polling job completion
status (default \(aq\(aq)
.IP \(bu 2
\fBbatchsize\fP (\fIstr\fP) \-\- Salt batch size, absolute value or %\-age (default 100%)
.IP \(bu 2
\fBmods\fP (\fIstr\fP) \-\- Mods to runner (default \(aq\(aq)
.IP \(bu 2
\fBsetpillardata\fP (\fIbool\fP) \-\- Set Pillar data (default false)
.IP \(bu 2
\fBpillarkey\fP (\fIstr\fP) \-\- Pillar key (default \(aq\(aq)
.IP \(bu 2
\fBpillarvalue\fP (\fIstr\fP) \-\- Pillar value (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- saltstack:
      servername: \(aq{{SALT_MASTER}}\(aq
      credentials: \(aqcredentials ID\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- saltstack:
      servername: \(aq{{SALT_MASTER}}\(aq
      credentials: \(aqcredentials ID\(aq
      clientinterface: runner
      mods: runner_mods
      setpillardata: true
      pillarkey: pkey
      pillarvalue: pvalue
      wait: true
      polltime: 10
      target: \(aq{{HOSTS}}\(aq
      targettype: list
      function: pkg.update
      saveoutput: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sbt()
Execute a sbt build step.
.sp
Requires the Jenkins \fI\%Sbt Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Select a sbt installation to use. If no name is
provided, the first in the list of defined SBT builders will be
used. (default to first in list)
.IP \(bu 2
\fBjvm\-flags\fP (\fIstr\fP) \-\- Parameters to pass to the JVM (default \(aq\(aq)
.IP \(bu 2
\fBactions\fP (\fIstr\fP) \-\- Select the sbt tasks to execute (default \(aq\(aq)
.IP \(bu 2
\fBsbt\-flags\fP (\fIstr\fP) \-\- Add flags to SBT launcher
(default \(aq\-Dsbt.log.noformat=true\(aq)
.IP \(bu 2
\fBsubdir\-path\fP (\fIstr\fP) \-\- Path relative to workspace to run sbt in
(default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- sbt:
      name: \(dqdefault\(dq
      actions: \(dqclean package\(dq
      jvm\-flags: \(dq\-Xmx8G\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B scan\-build()
This plugin allows you configure a build step that will execute the Clang
scan\-build static analysis tool against an XCode project.
.sp
The scan\-build report has to be generated in the directory
\fB${WORKSPACE}/clangScanBuildReports\fP for the publisher to find it.
.sp
Requires the Jenkins \fI\%Clang Scan\-Build Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- Provide the exact name of the XCode target you wish to
have compiled and analyzed (required)
.IP \(bu 2
\fBtarget\-sdk\fP (\fIstr\fP) \-\- Set the simulator version of a currently installed SDK
(default iphonesimulator)
.IP \(bu 2
\fBconfig\fP (\fIstr\fP) \-\- Provide the XCode config you wish to execute scan\-build
against (default Debug)
.IP \(bu 2
\fBclang\-install\-name\fP (\fIstr\fP) \-\- Name of clang static analyzer to use (default
\(aq\(aq)
.IP \(bu 2
\fBxcode\-sub\-path\fP (\fIstr\fP) \-\- Path of XCode project relative to the workspace
(default \(aq\(aq)
.IP \(bu 2
\fBworkspace\fP (\fIstr\fP) \-\- Name of workspace (default \(aq\(aq)
.IP \(bu 2
\fBscheme\fP (\fIstr\fP) \-\- Name of scheme (default \(aq\(aq)
.IP \(bu 2
\fBscan\-build\-args\fP (\fIstr\fP) \-\- Additional arguments to clang scan\-build
(default \-\-use\-analyzer Xcode)
.IP \(bu 2
\fBxcode\-build\-args\fP (\fIstr\fP) \-\- Additional arguments to XCode (default
\-derivedDataPath $WORKSPACE/build)
.IP \(bu 2
\fBreport\-folder\fP (\fIstr\fP) \-\- Folder where generated reports are located
(>=1.7) (default clangScanBuildReports)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- scan\-build:
      target: path/to/target
      target\-sdk: iphonesimulator
      config: Debug
      clang\-install\-name: Analyzer
      xcode\-sub\-path: myProj/subfolder
      workspace: workspace
      scheme: SchemeName
      scan\-build\-args: \-\-use\-analyzer Xcode
      xcode\-build\-args: \-derivedDataPath $WORKSPACE/build
      report\-folder: clangScanBuildReports

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- scan\-build:
      target: path/to/target

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B shell()
Execute a shell command.
.sp
There are two ways of configuring the builder, with a plain string to
execute:
.INDENT 7.0
.TP
.B Parameters
\fBparameter\fP (\fIstr\fP) \-\- the shell command to execute
.UNINDENT
.sp
Or with a mapping that allows other parameters to be passed:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- the shell command to execute
.IP \(bu 2
\fBunstable\-return\fP (\fIint\fP) \-\- the shell exit code to interpret as an unstable build result
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- shell: \(dqmake test\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- shell:
      command: \(dqmake test\(dq
      unstable\-return: 3

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B shining\-panda()
Execute a command inside various python environments.
.sp
Requires the Jenkins \fI\%ShiningPanda plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBbuild\-environment\fP (\fIstr\fP) \-\- 
.sp
Building environment to set up (required).
.INDENT 7.0
.TP
.B build\-environment values
.INDENT 7.0
.IP \(bu 2
\fBpython\fP: Use a python installation configured in Jenkins.
.IP \(bu 2
\fBcustom\fP: Use a manually installed python.
.IP \(bu 2
\fBvirtualenv\fP: Create a virtualenv
.UNINDENT
.UNINDENT

.UNINDENT
.sp
For the \fBpython\fP environment
.INDENT 7.0
.TP
.B Parameters
\fBpython\-version\fP (\fIstr\fP) \-\- Name of the python installation to use.
Must match one of the configured installations on server
configuration (default \(aqSystem\-CPython\-2.7\(aq)
.UNINDENT
.sp
For the \fBcustom\fP environment:
.INDENT 7.0
.TP
.B Parameters
\fBhome\fP (\fIstr\fP) \-\- path to the home folder of the custom installation
(required)
.UNINDENT
.sp
For the \fBvirtualenv\fP environment:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpython\-version\fP (\fIstr\fP) \-\- Name of the python installation to use.
Must match one of the configured installations on server
configuration (default \(aqSystem\-CPython\-2.7\(aq)
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of this virtualenv. Two virtualenv builders with
the same name will use the same virtualenv installation (optional)
.IP \(bu 2
\fBclear\fP (\fIbool\fP) \-\- If true, delete and recreate virtualenv on each build.
(default false)
.IP \(bu 2
\fBuse\-distribute\fP (\fIbool\fP) \-\- if true use distribute, if false use
setuptools. (default true)
.IP \(bu 2
\fBsystem\-site\-packages\fP (\fIbool\fP) \-\- if true, give access to the global
site\-packages directory to the virtualenv. (default false)
.UNINDENT
.UNINDENT
.sp
Common to all environments:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnature\fP (\fIstr\fP) \-\- 
.sp
Nature of the command field. (default shell)
.INDENT 2.0
.TP
.B nature values
.INDENT 7.0
.IP \(bu 2
\fBshell\fP: execute the Command contents with default shell
.IP \(bu 2
\fBxshell\fP: like \fBshell\fP but performs platform conversion
first
.IP \(bu 2
\fBpython\fP: execute the Command contents with the Python
executable
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- The command to execute
.IP \(bu 2
\fBignore\-exit\-code\fP (\fIbool\fP) \-\- mark the build as failure if any of the
commands exits with a non\-zero exit code. (default false)
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- shining\-panda:
        build\-environment: python
        python\-version: System\-CPython\-2.7
        nature: python
        command: setup.py build
        ignore\-exit\-code: false

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- shining\-panda:
        build\-environment: custom
        home: /usr/local/lib/custom\-python\-27
        nature: xshell
        command: |
            cd $HOME/build
            python setup.py build
        ignore\-exit\-code: true

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- shining\-panda:
        build\-environment: virtualenv
        python\-version: System\-CPython\-2.7
        nature: shell
        command: python setup.py build
        name: virtvenv1
        clear: true
        use\-distribute: true
        system\-site\-packages: true
        ignore\-exit\-code: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sonar()
Invoke standalone Sonar analysis.
.sp
Requires the Jenkins \fI\%Sonar Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsonar\-name\fP (\fIstr\fP) \-\- Name of the Sonar installation.
.IP \(bu 2
\fBsonar\-scanner\fP (\fIstr\fP) \-\- Name of the Sonar Scanner.
.IP \(bu 2
\fBtask\fP (\fIstr\fP) \-\- Task to run. (default \(aq\(aq)
.IP \(bu 2
\fBproject\fP (\fIstr\fP) \-\- Path to Sonar project properties file. (default \(aq\(aq)
.IP \(bu 2
\fBproperties\fP (\fIstr\fP) \-\- Sonar configuration properties. (default \(aq\(aq)
.IP \(bu 2
\fBjava\-opts\fP (\fIstr\fP) \-\- Java options for Sonnar Runner. (default \(aq\(aq)
.IP \(bu 2
\fBadditional\-arguments\fP (\fIstr\fP) \-\- additional command line arguments
(default \(aq\(aq)
.IP \(bu 2
\fBjdk\fP (\fIstr\fP) \-\- JDK to use (inherited from the job if omitted). (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- sonar:
      sonar\-name: Sonar
      scanner\-name: scanner\-3.x
      task: views
      project: sonar\-project.properties
      properties: sonar.views.list=myview1,myview2
      java\-opts: \-Xmx512m
      additional\-arguments: \-X

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sonatype\-clm()
Requires the Jenkins Sonatype CLM Plugin.
.sp
WARNING: This plugin appears to be deprecated. There does not seem
to be any place where it is available for download.
.sp
Try the \fI\%nexus\-artifact\-uploader\fP plugin instead.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) \-\- Select CLM application from a list of available CLM
applications or specify CLM Application ID (default list)
.IP \(bu 2
\fBapplication\-name\fP (\fIstr\fP) \-\- Determines the policy elements to associate
with this build. (required)
.IP \(bu 2
\fBusername\fP (\fIstr\fP) \-\- Username on the Sonatype CLM server. Leave empty to
use the username configured at global level. (default \(aq\(aq)
.IP \(bu 2
\fBpassword\fP (\fIstr\fP) \-\- Password on the Sonatype CLM server. Leave empty to
use the password configured at global level. (default \(aq\(aq)
.IP \(bu 2
\fBfail\-on\-clm\-server\-failure\fP (\fIbool\fP) \-\- Controls the build outcome if there
is a failure in communicating with the CLM server. (default false)
.IP \(bu 2
\fBstage\fP (\fIstr\fP) \-\- Controls the stage the policy evaluation will be run
against on the CLM server. Valid stages: build, stage\-release, release,
operate. (default \(aqbuild\(aq)
.IP \(bu 2
\fBscan\-targets\fP (\fIstr\fP) \-\- Pattern of files to include for scanning.
(default \(aq\(aq)
.IP \(bu 2
\fBmodule\-excludes\fP (\fIstr\fP) \-\- Pattern of files to exclude. (default \(aq\(aq)
.IP \(bu 2
\fBadvanced\-options\fP (\fIstr\fP) \-\- Options to be set on a case\-by\-case basis as
advised by Sonatype Support. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- sonatype\-clm:
        application\-name: jenkins\-job\-builder

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
    \- sonatype\-clm:
        value: manual
        application\-name: jenkins\-job\-builder
        fail\-on\-clm\-server\-failure: true
        stage: release
        scan\-targets: \(aq**/*.jar\(aq
        module\-excludes: \(aq**/my\-module/target/**\(aq
        advanced\-options: \(aqtest\(aq
        username: bar
        password: 06XQY39LHGACt3r3kzSULg==

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ssh\-builder()
Executes command on remote host
.sp
Requires the Jenkins \fI\%SSH plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBssh\-user\-ip\fP (\fIstr\fP) \-\- \fI\%user@ip\fP:ssh_port of machine that was defined
in jenkins according to SSH plugin instructions
.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- command to run on remote server
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- ssh\-builder:
      ssh\-user\-ip: foo@bar:22
      command: echo foo

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B system\-groovy()
Execute a system groovy script or command.
.sp
Requires the Jenkins \fI\%Groovy Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfile\fP (\fIstr\fP) \-\- Groovy file to run. (Alternative: you can chose a command
instead)
.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- Groovy command to run. (Alternative: you can choose a
script file instead)
.IP \(bu 2
\fBsandbox\fP (\fIbool\fP) \-\- Execute script inside of groovy sandbox (>=2.0)
(default false)
.IP \(bu 2
\fBbindings\fP (\fIstr\fP) \-\- Define variable bindings (in the properties file
format). Specified variables can be addressed from the script.
(optional)
.IP \(bu 2
\fBclass\-path\fP (\fI(\fP\fIlist str\fP\fI)\fP) \-\- List of script class paths.
(optional)
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- system\-groovy:
      file: \(dqtest.groovy\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- system\-groovy:
      command: \(dqprintln \(aqHello\(aq\(dq
      bindings: \(dqEXAMPLE=foo\-bar\(dq
      class\-path: \(dqfile:/home/user/example.jar\(dq
      sandbox: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B tox()
Use tox to build a multi\-configuration project.
.sp
Requires the Jenkins \fI\%ShiningPanda plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBini\fP (\fIstr\fP) \-\- The TOX configuration file path (default tox.ini)
.IP \(bu 2
\fBrecreate\fP (\fIbool\fP) \-\- If true, create a new environment each time (default
false)
.IP \(bu 2
\fBtoxenv\-pattern\fP (\fIstr\fP) \-\- The pattern used to build the TOXENV environment
variable. (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- tox:
      recreate: True

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B trigger\-builds()
Trigger builds of other jobs.
.sp
Requires the Jenkins \fI\%Parameterized Trigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproject\fP (\fIlist\fP) \-\- the Jenkins project to trigger
.IP \(bu 2
\fBpredefined\-parameters\fP (\fIstr\fP) \-\- key/value pairs to be passed to the job
(optional)
.IP \(bu 2
\fBbool\-parameters\fP (\fIlist\fP) \-\- .INDENT 2.0
.TP
.B Bool
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Parameter name
.IP \(bu 2
\fBvalue\fP (\fIbool\fP) \-\- Value to set (default false)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBproperty\-file\fP (\fIstr\fP) \-\- Pass properties from file to the other job (optional)
.IP \(bu 2
\fBproperty\-file\-fail\-on\-missing\fP (\fIbool\fP) \-\- Don\(aqt trigger if any files are missing (default true)
.IP \(bu 2
\fBcurrent\-parameters\fP (\fIbool\fP) \-\- Whether to include the parameters passed
to the current build to the triggered job.
.IP \(bu 2
\fBnode\-label\-name\fP (\fIstr\fP) \-\- Define a name for the NodeLabel parameter to be
set. Used in conjunction with node\-label. Requires NodeLabel Parameter
Plugin (optional)
.IP \(bu 2
\fBnode\-label\fP (\fIstr\fP) \-\- Label of the nodes where build should be triggered.
Used in conjunction with node\-label\-name.  Requires NodeLabel Parameter
Plugin (optional)
.IP \(bu 2
\fBrestrict\-matrix\-project\fP (\fIstr\fP) \-\- Filter that restricts the subset
of the combinations that the triggered job will run (optional)
.IP \(bu 2
\fBsvn\-revision\fP (\fIbool\fP) \-\- Whether to pass the svn revision to the triggered
job (optional)
.IP \(bu 2
\fBgit\-revision\fP (\fIdict\fP) \-\- 
.sp
Passes git revision to the triggered job
(optional).
.INDENT 2.0
.IP \(bu 2
\fBcombine\-queued\-commits\fP (bool): Whether to combine queued git
hashes or not (default false)
.UNINDENT

.IP \(bu 2
\fBblock\fP (\fIbool\fP) \-\- whether to wait for the triggered jobs to finish or not
(default false)
.IP \(bu 2
\fBblock\-thresholds\fP (\fIdict\fP) \-\- 
.sp
Fail builds and/or mark as failed or unstable
based on thresholds. Only apply if block parameter is true (optional)
.INDENT 2.0
.TP
.B block\-thresholds
.INDENT 7.0
.IP \(bu 2
\fBbuild\-step\-failure\-threshold\fP (\fIstr\fP) \- build step failure
threshold, valid values are \(aqnever\(aq, \(aqSUCCESS\(aq, \(aqUNSTABLE\(aq, or
\(aqFAILURE\(aq. (default \(aqFAILURE\(aq)
.IP \(bu 2
\fBunstable\-threshold\fP (\fIstr\fP) \- unstable threshold, valid
values are \(aqnever\(aq, \(aqSUCCESS\(aq, \(aqUNSTABLE\(aq, or \(aqFAILURE\(aq.
(default \(aqUNSTABLE\(aq)
.IP \(bu 2
\fBfailure\-threshold\fP (\fIstr\fP) \- overall failure threshold, valid
values are \(aqnever\(aq, \(aqSUCCESS\(aq, \(aqUNSTABLE\(aq, or \(aqFAILURE\(aq.
(default \(aqFAILURE\(aq)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBsame\-node\fP (\fIbool\fP) \-\- Use the same node for the triggered builds that was
used for this build (optional)
.IP \(bu 2
\fBparameter\-factories\fP (\fIlist\fP) \-\- 
.sp
list of parameter factories
.INDENT 2.0
.TP
.B Factory
.INDENT 7.0
.IP \(bu 2
\fBfactory\fP (\fIstr\fP) \fBfilebuild\fP \-\- For every property file,
invoke one build
.IP \(bu 2
\fBfile\-pattern\fP (\fIstr\fP) \-\- File wildcard pattern
.IP \(bu 2
\fBno\-files\-found\-action\fP (\fIstr\fP) \-\- Action to perform when
no files found. Valid values \(aqFAIL\(aq, \(aqSKIP\(aq, or \(aqNOPARMS\(aq.
(default \(aqSKIP\(aq)
.UNINDENT
.TP
.B Factory
.INDENT 7.0
.IP \(bu 2
\fBfactory\fP (\fIstr\fP) \fBbinaryfile\fP \-\- For every matching
file, invoke one build
.IP \(bu 2
\fBfile\-pattern\fP (\fIstr\fP) \-\- Artifact ID of the artifact
.IP \(bu 2
\fBno\-files\-found\-action\fP (\fIstr\fP) \-\- Action to perform when
no files found. Valid values \(aqFAIL\(aq, \(aqSKIP\(aq, or \(aqNOPARMS\(aq.
(default \(aqSKIP\(aq)
.UNINDENT
.TP
.B Factory
.INDENT 7.0
.IP \(bu 2
\fBfactory\fP (\fIstr\fP) \fBcounterbuild\fP \-\- Invoke i=0...N builds
.IP \(bu 2
\fBfrom\fP (\fIint\fP) \-\- Artifact ID of the artifact
.IP \(bu 2
\fBto\fP (\fIint\fP) \-\- Version of the artifact
.IP \(bu 2
\fBstep\fP (\fIint\fP) \-\- Classifier of the artifact
.IP \(bu 2
\fBparameters\fP (\fIstr\fP) \-\- KEY=value pairs, one per line
(default \(aq\(aq)
.IP \(bu 2
\fBvalidation\-fail\fP (\fIstr\fP) \-\- Action to perform when
stepping validation fails. Valid values \(aqFAIL\(aq, \(aqSKIP\(aq, or
\(aqNOPARMS\(aq. (default \(aqFAIL\(aq)
.UNINDENT
.TP
.B Factory
.INDENT 7.0
.IP \(bu 2
\fBfactory\fP (\fIstr\fP) \fBallnodesforlabel\fP \-\- Trigger a build
on all nodes having specific label. Requires NodeLabel
Parameter Plugin (optional)
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of the parameter to set (optional)
.IP \(bu 2
\fBnode\-label\fP (\fIstr\fP) \-\- Label of the nodes where build
should be triggered
.IP \(bu 2
\fBignore\-offline\-nodes\fP (\fIbool\fP) \-\- Don\(aqt trigger build on
offline nodes (default true)
.UNINDENT
.TP
.B Factory
.INDENT 7.0
.IP \(bu 2
\fBfactory\fP (\fIstr\fP) \fBallonlinenodes\fP \-\- Trigger a build on
every online node. Requires NodeLabel Parameter Plugin (optional)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Examples:
.sp
Basic usage with yaml list of projects.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- trigger\-builds:
    \- project:
        \- \(dqfoo\(dq
        \- \(dqbar\(dq
        \- \(dqbaz\(dq
      current\-parameters: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Basic usage with passing svn revision through.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- trigger\-builds:
    \- project: \(dqbuild_started\(dq
      predefined\-parameters:
        FOO=\(dqbar\(dq
      current\-parameters: true
      svn\-revision: true
      block: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Basic usage with passing git revision through.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- trigger\-builds:
    \- project: \(dqbuild_started\(dq
      predefined\-parameters:
        FOO=\(dqbar\(dq
      current\-parameters: true
      node\-label\-name: NODE
      node\-label: testnodes
      git\-revision: true
      block: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example with all supported parameter factories.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- trigger\-builds:
    \- project: \(dqbuild_started\(dq
      predefined\-parameters:
        FOO=\(dqbar\(dq
      current\-parameters: true
      svn\-revision: true
      parameter\-factories:
        \- factory: filebuild
          file\-pattern: propfile*.txt
        \- factory: binaryfile
          parameter\-name: filename
          file\-pattern: otherpropfile*.txt
        \- factory: counterbuild
          from: 0
          to: 5
          step: 1
        \- factory: allnodesforlabel
          name: parametername
          node\-label: labelname
          ignore\-offline\-nodes: false
        \- factory: allonlinenodes
      block: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B trigger\-remote()
Trigger build of job on remote Jenkins instance.
.sp
Requires the Jenkins \fI\%Parameterized Remote Trigger Plugin\fP
.sp
Please note that this plugin requires system configuration on the Jenkins
Master that is unavailable from individual job views; specifically, one
must add remote jenkins servers whose \(aqDisplay Name\(aq field are what make up
valid fields on the \fIremote\-jenkins\-name\fP attribute below.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBremote\-jenkins\-name\fP (\fIstr\fP) \-\- the remote Jenkins server (required)
.IP \(bu 2
\fBjob\fP (\fIstr\fP) \-\- the Jenkins project to trigger on the remote Jenkins server
(required)
.IP \(bu 2
\fBshould\-not\-fail\-build\fP (\fIbool\fP) \-\- if true, remote job failure will not lead
current job to fail (default false)
.IP \(bu 2
\fBprevent\-remote\-build\-queue\fP (\fIbool\fP) \-\- if true, wait to trigger remote
builds until no other builds (default false)
.IP \(bu 2
\fBblock\fP (\fIbool\fP) \-\- whether to wait for the trigger jobs to finish or not
(default true)
.IP \(bu 2
\fBpoll\-interval\fP (\fIstr\fP) \-\- polling interval in seconds for checking statues of
triggered remote job, only necessary if current job is configured to
block (default 10)
.IP \(bu 2
\fBconnection\-retry\-limit\fP (\fIstr\fP) \-\- number of connection attempts to remote
Jenkins server before giving up. (default 5)
.IP \(bu 2
\fBenhanced\-logging\fP (\fIbool\fP) \-\- if this option is enabled,
the console output of the remote job is also logged. (default false)
.IP \(bu 2
\fBpredefined\-parameters\fP (\fIstr\fP) \-\- predefined parameters to send to the remote
job when triggering it (optional)
.IP \(bu 2
\fBproperty\-file\fP (\fIstr\fP) \-\- file in workspace of current job containing
additional parameters to be set on remote job
(optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- trigger\-remote:
      remote\-jenkins\-name: \(dqhttp://example.jenkinsmaster.lan\(dq
      token: \(dqBLAH\(dq
      job: \(dqbuild\-things\(dq
      should\-fail\-build: True
      prevent\-remote\-build\-queue: True
      poll\-interval: 5
      connection\-retry\-limit: 5
      block: true
      enhanced\-logging: True
      property\-file: \(aq.props\(aq
      predefined\-parameters: |
        FOO=\(dqbar\(dq
        herp=\(dqderp\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B xcode()
This step allows you to execute an xcode build step.
.sp
Requires the Jenkins \fI\%Xcode Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdeveloper\-profile\fP (\fIstr\fP) \-\- the jenkins credential id for a
ios developer profile. (optional)
.IP \(bu 2
\fBclean\-build\fP (\fIbool\fP) \-\- if true will delete the build directories
before invoking the build. (default false)
.IP \(bu 2
\fBclean\-test\-reports\fP (\fIbool\fP) \-\- UNKNOWN. (default false)
.IP \(bu 2
\fBarchive\fP (\fIbool\fP) \-\- if true will generate an xcarchive of the specified
scheme. A workspace and scheme are are also needed for archives.
(default false)
.IP \(bu 2
\fBconfiguration\fP (\fIstr\fP) \-\- This is the name of the configuration
as defined in the Xcode project. (default \(aqRelease\(aq)
.IP \(bu 2
\fBconfiguration\-directory\fP (\fIstr\fP) \-\- The value to use for
CONFIGURATION_BUILD_DIR setting. (default \(aq\(aq)
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- Leave empty for all targets. (default \(aq\(aq)
.IP \(bu 2
\fBsdk\fP (\fIstr\fP) \-\- Leave empty for default SDK. (default \(aq\(aq)
.IP \(bu 2
\fBsymroot\fP (\fIstr\fP) \-\- Leave empty for default SYMROOT. (default \(aq\(aq)
.IP \(bu 2
\fBproject\-path\fP (\fIstr\fP) \-\- Relative path within the workspace
that contains the xcode project file(s). (default \(aq\(aq)
.IP \(bu 2
\fBproject\-file\fP (\fIstr\fP) \-\- Only needed if there is more than one
project file in the Xcode Project Directory. (default \(aq\(aq)
.IP \(bu 2
\fBbuild\-arguments\fP (\fIstr\fP) \-\- Extra commandline arguments provided
to the xcode builder. (default \(aq\(aq)
.IP \(bu 2
\fBschema\fP (\fIstr\fP) \-\- Only needed if you want to compile for a
specific schema instead of a target. (default \(aq\(aq)
.IP \(bu 2
\fBworkspace\fP (\fIstr\fP) \-\- Only needed if you want to compile a
workspace instead of a project. (default \(aq\(aq)
.IP \(bu 2
\fBprofile\fP (\fIstr\fP) \-\- The relative path to the mobileprovision to embed,
leave blank for no embedded profile. (default \(aq\(aq)
.IP \(bu 2
\fBcodesign\-id\fP (\fIstr\fP) \-\- Override the code signing identity specified
in the project. (default \(aq\(aq)
.IP \(bu 2
\fBallow\-failing\fP (\fIbool\fP) \-\- if true will prevent this build step from
failing if xcodebuild exits with a non\-zero return code. (default
false)
.IP \(bu 2
\fBversion\-technical\fP (\fIstr\fP) \-\- The value to use for CFBundleVersion.
Leave blank to use project\(aqs technical number. (default \(aq\(aq)
.IP \(bu 2
\fBversion\-marketing\fP (\fIstr\fP) \-\- The value to use for
CFBundleShortVersionString. Leave blank to use project\(aqs
marketing number. (default \(aq\(aq)
.IP \(bu 2
\fBipa\-export\-method\fP (\fIstr\fP) \-\- The export method of the .app to generate the
\&.ipa file.  Should be one in \(aqdevelopment\(aq, \(aqad\-hoc\(aq, \(aqenterprise\(aq,
or \(aqapp\-store\(aq. (default \(aq\(aq)
.IP \(bu 2
\fBipa\-version\fP (\fIstr\fP) \-\- A pattern for the ipa file name. You may use
${VERSION} and ${BUILD_DATE} (yyyy.MM.dd) in this string.
(default \(aq\(aq)
.IP \(bu 2
\fBipa\-output\fP (\fIstr\fP) \-\- The output directory for the .ipa file,
relative to the build directory. (default \(aq\(aq)
.IP \(bu 2
\fBcompile\-bitcode\fP (\fIbool\fP) \-\- recompile from Bitcode when exporting the
application to IPA. (default true)
.IP \(bu 2
\fBupload\-bitcode\fP (\fIbool\fP) \-\- include Bitcode when exporting applications to
IPA. (default true)
.IP \(bu 2
\fBupload\-symbols\fP (\fIbool\fP) \-\- include symbols when exporting applications to
IPA. (default true)
.IP \(bu 2
\fBdevelopment\-team\-id\fP \-\- The ID of the Apple development team to use to
sign the IPA (default \(aq\(aq)
.IP \(bu 2
\fBkeychain\-name\fP (\fIstr\fP) \-\- The globally configured keychain to unlock for
this build. (default \(aq\(aq)
.IP \(bu 2
\fBkeychain\-path\fP (\fIstr\fP) \-\- The path of the keychain to use to sign the IPA.
(default \(aq\(aq)
.IP \(bu 2
\fBkeychain\-password\fP (\fIstr\fP) \-\- The password to use to unlock the keychain.
(default \(aq\(aq)
.IP \(bu 2
\fBkeychain\-unlock\fP (\fIstr\fP) \-\- Unlocks the keychain during use.
(default false)
.IP \(bu 2
\fBbundle\-id\fP (\fIstr\fP) \-\- The bundle identifier (App ID) for this provisioning
profile (default \(aq\(aq)
.IP \(bu 2
\fBprovisioning\-profile\-uuid\fP (\fIstr\fP) \-\- The UUID of the provisioning profile
associated to this bundle identifier. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- xcode
  \- xcode:
      developer\-profile: \(dq849b07cd\-ac61\-4588\-89c8\-b6606ee84946\(dq
      clean\-build: true
      clean\-test\-reports: true
      configuration: Distribution
      target: TARGET
      sdk: iphonesimulator
      build\-arguments: \(dqtest ONLY_ACTIVE_ARCH=NO \-destination \(aqplatform=iOS Simulator,name=iPhone 6\(aq \-derivedDataPath .\(dq
      schema: \(dqUASDKInternal\(dq
      workspace: \(dqUA\(dq
      profile: \(dqPROFILE\(dq
      codesign\-id: \(dqiPhone Distribution: MapMyFitness Inc.\(dq
      allow\-failing: true
      version\-technical: \(dqTECHNICAL\(dq
      version\-marketing: \(dqMARKETING\(dq
      ipa\-export\-method: ad\-hoc
      ipa\-version: \(dq${VERSION}\(dq
      ipa\-output: \(dq/output\(dq
      compile\-bitcode: false
      upload\-bitcode: false
      upload\-symbols: false
      development\-team\-id: foo
      keychain\-path: \(dq/Users/jenkins/Library/Keychains/jenkins\-uasdk\-ios\-pre_review\(dq
      keychain\-password: \(dqtestpass\(dq
      keychain\-unlock: true
      provisioning\-profiles:
        \- bundle\-id: foo
          provisioning\-profile\-uuid: bar
        \- bundle\-id: foo2
          provisioning\-profile\-uuid: bar2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B xunit()
Process tests results.
.sp
Requires the Jenkins \fI\%xUnit Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBthresholdmode\fP (\fIstr\fP) \-\- Whether thresholds represents an absolute number
of tests or a percentage. Either \(aqnumber\(aq or \(aqpercent\(aq. (default
\(aqnumber\(aq)
.IP \(bu 2
\fBthresholds\fP (\fIlist\fP) \-\- 
.sp
Thresholds for both \(aqfailed\(aq and \(aqskipped\(aq tests.
.INDENT 2.0
.TP
.B threshold (\fIdict\fP)
Threshold values to set, where missing, xUnit
should default to an internal value of 0. Each test threshold
should contain the following:
.INDENT 7.0
.IP \(bu 2
\fBunstable\fP (\fIint\fP)
.IP \(bu 2
\fBunstablenew\fP (\fIint\fP)
.IP \(bu 2
\fBfailure\fP (\fIint\fP)
.IP \(bu 2
\fBfailurenew\fP (\fIint\fP)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtest\-time\-margin\fP (\fIint\fP) \-\- Give the report time margin value in ms, before
to fail if not new unless the option \fBrequireupdate\fP is set for the
configured framework. (default 3000)
.IP \(bu 2
\fBtypes\fP (\fIlist\fP) \-\- 
.sp
Frameworks to configure, and options. Supports the
following: \fBaunit\fP, \fBboosttest\fP, \fBchecktype\fP, \fBcpptest\fP,
\fBcppunit\fP, \fBctest\fP, \fBdotnettest\fP, \fBembunit\fP, \fBfpcunit\fP,
\fBgtest\fP, \fBjunit\fP, \fBmstest\fP, \fBnunit\fP, \fBphpunit\fP, \fBtusar\fP,
\fBunittest\fP, and \fBvalgrind\fP\&.
.sp
The \(aqcustom\(aq type is not supported.
.INDENT 2.0
.TP
.B type (\fIdict\fP)
each type can be configured using the following:
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP): An Ant pattern to look for Junit result
files, relative to the workspace root (default \(aq\(aq)
.IP \(bu 2
\fBrequireupdate\fP (\fIbool\fP): fail the build whenever fresh tests
results have not been found (default true).
.IP \(bu 2
\fBdeleteoutput\fP (\fIbool\fP): delete temporary JUnit files
(default true).
.IP \(bu 2
\fBskip\-if\-no\-test\-files\fP (\fIbool\fP): Skip parsing this xUnit type
report if there are no test reports files (default false).
.IP \(bu 2
\fBstoponerror\fP (\fIbool\fP): Fail the build whenever an error occur
during a result file processing (default true).
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- xunit:
      types:
        \- junit:
            pattern: \(dqjunit.xml\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
builders:
  \- xunit:
      thresholdmode: \(aqpercent\(aq
      thresholds:
          \- failed:
                unstable: 0
                unstablenew: 0
                failure: 0
                failurenew: 0
          \- skipped:
                unstable: 0
                unstablenew: 0
                failure: 0
                failurenew: 0
      test\-time\-margin: 5000
      types:
          \- phpunit:
              pattern: \(dqphpunit.log\(dq
              requireupdate: true
              deleteoutput: true
              skip\-if\-no\-test\-files: false
              stoponerror: true
          \- cppunit:
              pattern: \(dqcppunit.log\(dq
              requireupdate: false
              deleteoutput: false
              skip\-if\-no\-test\-files: true
              stoponerror: false
          \- gtest:
              pattern: \(dqgtest.log\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Hipchat
.sp
Enable HipChat notifications of build execution.
.sp
Supports hipchat plugin versions < 1.9. Will automatically redirect to the
publishers module for newer versions, but still recommended that you convert
to the newer module.
.INDENT 0.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenabled\fP \fI(bool)\fP: general cut off switch. If not explicitly set to
\fBtrue\fP, no hipchat parameters are written to XML. For Jenkins HipChat
plugin of version prior to 0.1.5, also enables all build results to be
reported in HipChat room. For later plugin versions, explicit notify\-*
setting is required (see below).
.IP \(bu 2
\fBroom\fP \fI(str)\fP: name of HipChat room to post messages to (default \(aq\(aq)
.sp
Deprecated since version 1.2.0: Please use \(aqrooms\(aq.

.IP \(bu 2
\fBrooms\fP \fI(list)\fP: list of HipChat rooms to post messages to
(default empty)
.IP \(bu 2
\fBstart\-notify\fP \fI(bool)\fP: post messages about build start event
.sp
Deprecated since version 1.2.0: use notify\-start parameter instead

.IP \(bu 2
\fBnotify\-start\fP \fI(bool)\fP: post messages about build start event
(default false)
.IP \(bu 2
\fBnotify\-success\fP \fI(bool)\fP: post messages about successful build event
(Jenkins HipChat plugin >= 0.1.5) (default false)
.IP \(bu 2
\fBnotify\-aborted\fP \fI(bool)\fP: post messages about aborted build event
(Jenkins HipChat plugin >= 0.1.5) (default false)
.IP \(bu 2
\fBnotify\-not\-built\fP \fI(bool)\fP: post messages about build set to NOT_BUILT
status (Jenkins HipChat plugin >= 0.1.5). This status code is used in a
multi\-stage build (like maven2) where a problem in earlier stage prevented
later stages from building. (default false)
.IP \(bu 2
\fBnotify\-unstable\fP \fI(bool)\fP: post messages about unstable build event
(Jenkins HipChat plugin >= 0.1.5) (default false)
.IP \(bu 2
\fBnotify\-failure\fP \fI(bool)\fP:  post messages about build failure event
(Jenkins HipChat plugin >= 0.1.5) (default false)
.IP \(bu 2
\fBnotify\-back\-to\-normal\fP \fI(bool)\fP: post messages about build being back to
normal after being unstable or failed (Jenkins HipChat plugin >= 0.1.5)
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
hipchat:
  enabled: true
  rooms:
      \- My Room
      \- Your Room
  notify\-start: true
  notify\-success: true
  notify\-aborted: true
  notify\-not\-built: true
  notify\-unstable: true
  notify\-failure: true
  notify\-back\-to\-normal: true

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  hipchat_notif.HipChat(registry)
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  80
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Metadata
.sp
The Metadata plugin module enables the ability to add metadata to the projects
that can be exposed to job environment.
.sp
Requires the Jenkins \fI\%Metadata Plugin\fP\&.
.INDENT 0.0
.TP
\fBComponent\fP: metadata
.INDENT 7.0
.TP
.B Macro
metadata
.TP
.B Entry Point
jenkins_jobs.metadata
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
metadata:
  \- string:
      name: FOO
      value: bar
      expose\-to\-env: true
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  metadata.Metadata(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqmetadata\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqmetadata\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  21
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B date()
A date metadata
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the metadata
.IP \(bu 2
\fBtime\fP (\fIstr\fP) \-\- time value in millisec since 1970\-01\-01 00:00:00 UTC
.IP \(bu 2
\fBtimezone\fP (\fIstr\fP) \-\- time zone of the metadata
.IP \(bu 2
\fBexpose\-to\-env\fP (\fIbool\fP) \-\- expose to environment (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
metadata:
  \- date:
      name: FOO
      value: 1371708900268
      timezone: Australia/Melbourne
      expose\-to\-env: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B number()
A number metadata.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the metadata
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) \-\- the value of the metadata
.IP \(bu 2
\fBexpose\-to\-env\fP (\fIbool\fP) \-\- expose to environment (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
metadata:
  \- number:
      name: FOO
      value: 1
      expose\-to\-env: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B string()
A string metadata.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the metadata
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) \-\- the value of the metadata
.IP \(bu 2
\fBexpose\-to\-env\fP (\fIbool\fP) \-\- expose to environment (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
metadata:
  \- string:
      name: FOO
      value: bar
      expose\-to\-env: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Notifications
.sp
The Notifications module allows you to configure Jenkins to notify
other applications about various build phases.  It requires the
Jenkins notification plugin.
.INDENT 0.0
.TP
\fBComponent\fP: notifications
.INDENT 7.0
.TP
.B Macro
notification
.TP
.B Entry Point
jenkins_jobs.notifications
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  notifications.Notifications(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqnotifications\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqnotification\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  22
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B http()
Defines an HTTP notification endpoint.
.sp
Requires the Jenkins \fI\%Notification Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBformat\fP (\fIstr\fP) \-\- notification payload format, JSON (default) or XML
.IP \(bu 2
\fBevent\fP (\fIstr\fP) \-\- job events that trigger notifications: started,
completed, finalized or all (default)
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL of the endpoint
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \-\- Timeout in milliseconds for sending notification
request (30 seconds by default)
.IP \(bu 2
\fBretries\fP (\fIint\fP) \-\- Nr of times to retry sending notification in case
sending notification fails. (0 by default)
.IP \(bu 2
\fBlog\fP (\fIint\fP) \-\- Number lines of log messages to send (0 by default).
Use \-1 for all (use with caution).
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
notifications:
  \- http:
      url: http://example.com/jenkins_endpoint
      format: xml
      event: completed
      timeout: 40000
      log: \-1
      retries: 5

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Parameters
.sp
The Parameters module allows you to specify build parameters for a job.
.INDENT 0.0
.TP
\fBComponent\fP: parameters
.INDENT 7.0
.TP
.B Macro
parameter
.TP
.B Entry Point
jenkins_jobs.parameters
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job:
  name: test_job

  parameters:
    \- string:
        name: FOO
        default: bar
        description: \(dqA parameter named FOO, defaults to \(aqbar\(aq.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  parameters.Parameters(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqparameters\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqparameter\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  21
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B active\-choices()
Active Choices Parameter
.sp
Requires the Jenkins \fI\%Active Choices Plug\-in\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of the parameter (required).
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Description of the parameter.
.IP \(bu 2
\fBscript\fP (\fIlist\fP) \-\- 
.sp
Use a Groovy script to define the parameter.
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBgroovy\fP (\fIstr\fP) Groovy DSL Script
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-groovy\-sandbox\fP (\fIbool\fP) To run this
Groovy script in a sandbox with limited abilities
(default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBscript\-additional\-classpath\fP (\fIlist\fP) Additional
classpath entries accessible from the script.
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfallback\-script\fP (\fIlist\fP) \-\- 
.sp
Use a Fallback script. If the script
(specified above) fails, the fallback script will be used as a fallback.
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBgroovy\fP (\fIstr\fP) Groovy DSL Script
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-groovy\-sandbox\fP (\fIbool\fP) To run this Groovy
script in a sandbox with limited abilities.
(default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBscript\-additional\-classpath\fP (\fIlist\fP) Additional
classpath entries accessible from the script.
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBenable\-filters\fP (\fIbool\fP) \-\- If enabled a text box will appear next to
this element and will permit the user to filter its entries. The
list values never get re\-evaluated (default False).
.IP \(bu 2
\fBfilter\-starts\-at\fP (\fIint\fP) \-\- How many characters a user must enter
before the filter is applied (default 1).
.IP \(bu 2
\fBchoice\-type\fP (\fIstr\fP) \-\- 
.sp
type of the choices. (default \(aqsingle\-select\(aq)
.INDENT 2.0
.TP
.B Allowed Values
.INDENT 7.0
.IP \(bu 2
\fBsingle\-select\fP
.IP \(bu 2
\fBmulti\-select\fP
.IP \(bu 2
\fBradio\-buttons\fP
.IP \(bu 2
\fBcheckboxes\fP
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: active\-choices\-job
    parameters:
      \- active\-choices:
          name: lorem

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: active\-choices\-job
    parameters:
      \- active\-choices:
          name: lorem
          description: ipsum
          script:
              groovy: |\-
                  return [
                      \(aqparam1\(aq,
                      \(aqparam2\(aq
                  ]
              use\-groovy\-sandbox: false
              script\-additional\-classpath:
                  \- file:/jar\-file\-path
                  \- file:/jar\-file\-path2
          fallback\-script:
              groovy: |\-
                  return [
                      \(aqparam3\(aq,
                      \(aqparam4\(aq
                  ]
              use\-groovy\-sandbox: false
              script\-additional\-classpath:
                  \- file:/jar\-file\-path
                  \- file:/jar\-file\-path2
          choice\-type: multi\-select
          enable\-filters: true
          filter\-starts\-at: 1

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B active\-choices\-reactive()
Active Choices Reactive Parameter
.sp
Requires the Jenkins \fI\%Active Choices Plug\-in\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of the parameter (required).
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Description of the parameter.
.IP \(bu 2
\fBscript\fP (\fIlist\fP) \-\- 
.sp
Use a Groovy script to define the parameter.
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBgroovy\fP (\fIstr\fP) Groovy DSL Script
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-groovy\-sandbox\fP (\fIbool\fP) To run this
Groovy script in a sandbox with limited abilities
(default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBscript\-additional\-classpath\fP (\fIlist\fP) Additional
classpath entries accessible from the script.
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfallback\-script\fP (\fIlist\fP) \-\- 
.sp
Use a Fallback script. If the script
(specified above) fails, the fallback script will be used as a fallback.
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBgroovy\fP (\fIstr\fP) Groovy DSL Script
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-groovy\-sandbox\fP (\fIbool\fP) To run this Groovy
script in a sandbox with limited abilities.
(default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBscript\-additional\-classpath\fP (\fIlist\fP) Additional
classpath entries accessible from the script.
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBenable\-filters\fP (\fIbool\fP) \-\- If enabled a text box will appear next to
this element and will permit the user to filter its entries. The
list values never get re\-evaluated (default False).
.IP \(bu 2
\fBfilter\-starts\-at\fP (\fIint\fP) \-\- How many characters a user must enter
before the filter is applied (default 1).
.IP \(bu 2
\fBchoice\-type\fP (\fIstr\fP) \-\- 
.sp
type of the choices. (default \(aqsingle\-select\(aq)
.INDENT 2.0
.TP
.B Allowed Values
.INDENT 7.0
.IP \(bu 2
\fBsingle\-select\fP
.IP \(bu 2
\fBmulti\-select\fP
.IP \(bu 2
\fBradio\-buttons\fP
.IP \(bu 2
\fBcheckboxes\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBreferenced\-parameters\fP (\fIstr\fP) \-\- Comma separated list of other job
parameters referenced in the uno\-choice script
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: active\-choices\-job
    parameters:
      \- active\-choices\-reactive:
          name: foo

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: active\-choices\-job
    parameters:
      \- active\-choices\-reactive:
          name: lorem
          description: ipsum
          script:
              groovy: |\-
                  return [
                      \(aqparam1\(aq,
                      \(aqparam2\(aq
                  ]
              use\-groovy\-sandbox: false
              script\-additional\-classpath:
                  \- file:/jar\-file\-path
                  \- file:/jar\-file\-path2
          fallback\-script:
              groovy: |\-
                  return [
                      \(aqparam3\(aq,
                      \(aqparam4\(aq
                  ]
              use\-groovy\-sandbox: false
              script\-additional\-classpath:
                  \- file:/jar\-file\-path
                  \- file:/jar\-file\-path2
          choice\-type: multi\-select
          enable\-filters: true
          filter\-starts\-at: 1
          referenced\-parameters: foo,bar

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B bool()
A boolean parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdefault\fP (\fIstr\fP) \-\- the default value of the parameter (optional)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- bool:
      name: FOO
      default: false
      description: \(dqA parameter named FOO, defaults to \(aqfalse\(aq.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B choice()
A single selection parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBchoices\fP (\fIlist\fP) \-\- the available choices, first one is the default one.
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- choice:
      name: project
      choices:
        \- nova
        \- glance
      description: \(dqOn which project to run?\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B copyartifact\-build\-selector()
Control via a build parameter, which build the copyartifact plugin should
copy when it is configured to use \(aqbuild\-param\(aq.
.sp
Requires the Jenkins \fI\%Copy Artifact plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- name of the build parameter to store the selection in
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBwhich\-build\fP (\fIstr\fP) \-\- which to provide as the default value in the UI. See
\fBwhich\-build\fP param of \fI\%copyartifact\fP from the
builders module for the available values as well as options available
that control additional behaviour for the selected value.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- copyartifact\-build\-selector:
      name: BUILD_SELECTOR
      which\-build: workspace\-latest
      description: \(aqWhich build from upstream to copy artifacts from\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B credentials()
A credentials selection parameter.
.sp
Requires the Jenkins \fI\%Credentials Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- 
.sp
credential type (optional, default \(aqany\(aq)
.INDENT 2.0
.TP
.B Allowed Values
.INDENT 7.0
.IP \(bu 2
\fBany\fP Any credential type (default)
.IP \(bu 2
\fBusernamepassword\fP Username with password
.IP \(bu 2
\fBsshkey\fP SSH Username with private key
.IP \(bu 2
\fBsecretfile\fP Secret file
.IP \(bu 2
\fBsecrettext\fP Secret text
.IP \(bu 2
\fBcertificate\fP Certificate
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrequired\fP (\fIbool\fP) \-\- whether this parameter is required (optional, default
false)
.IP \(bu 2
\fBdefault\fP (\fIstr\fP) \-\- default credentials ID (optional)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- credentials:
      name: OS_CREDENTIALS
      type: usernamepassword
      default: \(dqdefault\-credentials\-id\(dq
      description: \(dqTest credentials\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dynamic\-choice()
Dynamic Choice Parameter
.sp
Requires the Jenkins \fI\%Jenkins Dynamic Parameter Plug\-in\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBscript\fP (\fIstr\fP) \-\- Groovy expression which generates the potential choices.
.IP \(bu 2
\fBremote\fP (\fIbool\fP) \-\- the script will be executed on the slave where the build
is started (default false)
.IP \(bu 2
\fBclasspath\fP (\fIstr\fP) \-\- class path for script (optional)
.IP \(bu 2
\fBread\-only\fP (\fIbool\fP) \-\- user can\(aqt modify parameter once populated
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- dynamic\-choice:
      name: OPTIONS
      description: \(dqAvailable options\(dq
      script: \(dq[\(aqoptionA\(aq, \(aqoptionB\(aq]\(dq
      remote: false
      read\-only: false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dynamic\-choice\-scriptler()
Dynamic Choice Parameter (Scriptler)
.sp
Requires the Jenkins \fI\%Jenkins Dynamic Parameter Plug\-in\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBscript\-id\fP (\fIstr\fP) \-\- Groovy script which generates the default value
.IP \(bu 2
\fBparameters\fP (\fIlist\fP) \-\- 
.sp
parameters to corresponding script
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) Parameter name
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) Parameter value
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBremote\fP (\fIbool\fP) \-\- the script will be executed on the slave where the build
is started (default false)
.IP \(bu 2
\fBread\-only\fP (\fIbool\fP) \-\- user can\(aqt modify parameter once populated
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- dynamic\-choice\-scriptler:
      name: OPTIONS
      description: \(dqAvailable options\(dq
      script\-id: \(dqscriptid.groovy\(dq
      parameters:
        \- name: param1
          value: value1
        \- name: param2
          value: value2
      remote: false
      read\-only: false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dynamic\-reference()
Active Choices Reactive Reference Parameter
.sp
Requires the Jenkins \fI\%Active Choices Plug\-in\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of the parameter (required).
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Description of the parameter.
.IP \(bu 2
\fBscript\fP (\fIlist\fP) \-\- 
.sp
Use a Groovy script to define the parameter.
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBgroovy\fP (\fIstr\fP) Groovy DSL Script
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-groovy\-sandbox\fP (\fIbool\fP) To run this
Groovy script in a sandbox with limited abilities
(default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBscript\-additional\-classpath\fP (\fIlist\fP) Additional
classpath entries accessible from the script.
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfallback\-script\fP (\fIlist\fP) \-\- 
.sp
Use a Fallback script. If the script
(specified above) fails, the fallback script will be used as a fallback.
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBgroovy\fP (\fIstr\fP) Groovy DSL Script
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-groovy\-sandbox\fP (\fIbool\fP) To run this Groovy
script in a sandbox with limited abilities.
(default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBscript\-additional\-classpath\fP (\fIlist\fP) Additional
classpath entries accessible from the script.
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBomit\-value\-field\fP (\fIbool\fP) \-\- By default Dynamic Reference Parameters always
include a hidden input for the value. If your script creates an input
HTML element, you can check this option and the value input field will
be omitted (default False).
.IP \(bu 2
\fBreferenced\-parameters\fP (\fIstr\fP) \-\- Comma separated list of other job
parameters referenced in the uno\-choice script. When any of the
referenced parameters are updated, the Groovy script will
re\-evaluate the choice list using the updated values of referenced
parameters.
.IP \(bu 2
\fBchoice\-type\fP (\fIstr\fP) \-\- 
.sp
type of the choices. (default \(aqinput\-text\-box\(aq)
.INDENT 2.0
.TP
.B Allowed Values
.INDENT 7.0
.IP \(bu 2
\fBinput\-text\-box\fP
.IP \(bu 2
\fBnumbered\-list\fP
.IP \(bu 2
\fBbullet\-items\-list\fP
.IP \(bu 2
\fBformatted\-html\fP
.IP \(bu 2
\fBformatted\-hidden\-html\fP
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: dynamic\-reference\-job
    parameters:
      \- dynamic\-reference:
          name: lorem

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- job:
    name: dynamic\-reference\-job
    folder: unochoice
    parameters:
      \- dynamic\-reference:
          name: lorem
          description: ipsum
          script:
              groovy: |\-
                  return [
                      \(aqparam1\(aq,
                      \(aqparam2\(aq
                  ]
              use\-groovy\-sandbox: false
              script\-additional\-classpath:
                  \- file:/path
                  \- file:/path2
          fallback\-script:
              groovy: |\-
                  return [
                      \(aqparam3\(aq,
                      \(aqparam4\(aq
                  ]
              use\-groovy\-sandbox: false
              script\-additional\-classpath:
                  \- file:/path
                  \- file:/path2
          choice\-type: numbered\-list
          omit\-value\-field: True
          referenced\-parameters: dolor

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dynamic\-string()
Dynamic Parameter
.sp
Requires the Jenkins \fI\%Jenkins Dynamic Parameter Plug\-in\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBscript\fP (\fIstr\fP) \-\- Groovy expression which generates the potential choices
.IP \(bu 2
\fBremote\fP (\fIbool\fP) \-\- the script will be executed on the slave where the build
is started (default false)
.IP \(bu 2
\fBclasspath\fP (\fIstr\fP) \-\- class path for script (optional)
.IP \(bu 2
\fBread\-only\fP (\fIbool\fP) \-\- user can\(aqt modify parameter once populated
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- dynamic\-string:
      name: FOO
      description: \(dqA parameter named FOO, defaults to \(aqbar\(aq.\(dq
      script: \(dqbar\(dq
      remote: false
      read\-only: false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dynamic\-string\-scriptler()
Dynamic Parameter (Scriptler)
.sp
Requires the Jenkins \fI\%Jenkins Dynamic Parameter Plug\-in\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBscript\-id\fP (\fIstr\fP) \-\- Groovy script which generates the default value
.IP \(bu 2
\fBparameters\fP (\fIlist\fP) \-\- 
.sp
parameters to corresponding script
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) Parameter name
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) Parameter value
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBremote\fP (\fIbool\fP) \-\- the script will be executed on the slave where the build
is started (default false)
.IP \(bu 2
\fBread\-only\fP (\fIbool\fP) \-\- user can\(aqt modify parameter once populated
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- dynamic\-string\-scriptler:
      name: FOO
      description: \(dqA parameter named FOO, defaults to \(aqbar\(aq.\(dq
      script\-id: \(dqscriptid.groovy\(dq
      parameters:
        \- name: param1
          value: value1
        \- name: param2
          value: value2
      remote: false
      read\-only: false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B extended\-choice()
Creates an extended choice parameter where values can be read from a file
.sp
Requires the Jenkins \fI\%Extended Choice Parameter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- description of the parameter
(optional, default \(aq\(aq)
.IP \(bu 2
\fBproperty\-file\fP (\fIstr\fP) \-\- location of property file to read from
(optional, default \(aq\(aq)
.IP \(bu 2
\fBproperty\-key\fP (\fIstr\fP) \-\- key for the property\-file (optional, default \(aq\(aq)
.IP \(bu 2
\fBquote\-value\fP (\fIbool\fP) \-\- whether to put quotes around the property
when passing to Jenkins (optional, default false)
.IP \(bu 2
\fBvisible\-items\fP (\fIstr\fP) \-\- number of items to show in the list
(optional, default 5)
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- type of select, can be single\-select, multi\-select,
multi\-level\-single\-select, multi\-level\-multi\-select,
radio, checkbox, textbox, json (optional, default single\-select)
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) \-\- comma separated list of values for the single select
or multi\-select box (optional, default \(aq\(aq)
.IP \(bu 2
\fBdefault\-value\fP (\fIstr\fP) \-\- used to set the initial selection of the
single\-select or multi\-select box (optional, default \(aq\(aq)
.IP \(bu 2
\fBvalue\-description\fP (\fIstr\fP) \-\- comma separated list of value descriptions
for the single select or multi\-select box (optional, default \(aq\(aq)
.IP \(bu 2
\fBdefault\-property\-file\fP (\fIstr\fP) \-\- location of property file when default
value needs to come from a property file (optional, default \(aq\(aq)
.IP \(bu 2
\fBdefault\-property\-key\fP (\fIstr\fP) \-\- key for the default property file
(optional, default \(aq\(aq)
.IP \(bu 2
\fBdescription\-property\-file\fP (\fIstr\fP) \-\- location of property file when value
description needs to come from a property file (optional, default \(aq\(aq)
.IP \(bu 2
\fBdescription\-property\-key\fP (\fIstr\fP) \-\- key for the value description
property file (optional, default \(aq\(aq)
.IP \(bu 2
\fBmulti\-select\-delimiter\fP (\fIstr\fP) \-\- value between selections when the
parameter is a multi\-select (optional, default \(aq,\(aq)
.IP \(bu 2
\fBgroovy\-script\fP (\fIstr\fP) \-\- the groovy script contents (optional, default \(aq,\(aq)
.IP \(bu 2
\fBgroovy\-script\-file\fP (\fIstr\fP) \-\- location of groovy script file to generate
parameters (optional, default \(aq\(aq)
.IP \(bu 2
\fBbindings\fP (\fIstr\fP) \-\- variable bindings for the groovy script
(optional, default \(aq\(aq)
.IP \(bu 2
\fBclasspath\fP (\fIstr\fP) \-\- the classpath for the groovy script
(optional, default \(aq,\(aq)
.IP \(bu 2
\fBdefault\-groovy\-script\fP (\fIstr\fP) \-\- the default groovy
script contents (optional, default \(aq\(aq)
.IP \(bu 2
\fBdefault\-groovy\-classpath\fP (\fIstr\fP) \-\- the default classpath for the
groovy script (optional, default \(aq\(aq)
.IP \(bu 2
\fBdescription\-groovy\-script\fP (\fIstr\fP) \-\- location of groovy script when value
description needs to come from a groovy script (optional, default \(aq\(aq)
.IP \(bu 2
\fBdescription\-groovy\-script\-file\fP (\fIstr\fP) \-\- location of groovy script file when value
description needs to come from a groovy script (optional, default \(aq\(aq)
.IP \(bu 2
\fBdescription\-groovy\-classpath\fP (\fIstr\fP) \-\- classpath for the value description
groovy script (optional, default \(aq\(aq)
.IP \(bu 2
\fBjavascript\fP (\fIstr\fP) \-\- the javascript script contents (optional, default \(aq\(aq)
.IP \(bu 2
\fBjavascript\-file\fP (\fIstr\fP) \-\- location of javasript script file to generate
parameters (optional, default \(aq\(aq)
.IP \(bu 2
\fBsave\-json\-parameter\-to\-file\fP (\fIbool\fP) \-\- if json parameter should be saved
to file (optional, default False)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- extended\-choice:
      name: OPTIONS
      description: \(dqAvailable options\(dq
      type: \(aqPT_CHECKBOX\(aq
      value: OptionA,OptionB,OptionC

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- extended\-choice:
      name: OPTIONS_VALUE
      description: \(dqAvailable options\(dq
      property\-key: key
      quote\-value: true
      type: multi\-select
      value: \(dqfoo|bar|select\(dq
      visible\-items: 2
      multi\-select\-delimiter: \(aq|\(aq
      default\-value: foo
      default\-property\-key: fookey
  \- extended\-choice:
      name: OPTIONS_FILE
      description: \(dqAvailable options\(dq
      property\-file: /home/foo/property.prop
      property\-key: key
      quote\-value: true
      type: multi\-select
      visible\-items: 2
      multi\-select\-delimiter: \(aq|\(aq
      default\-property\-file: /home/property.prop
      default\-property\-key: fookey
  \- extended\-choice:
      name: OPTIONS_CHECKBOX
      type: checkbox
      value: !join:
        \- \(aq,\(aq
        \-
            \- OptionA
            \- OptionB
            \- OptionC
      visible\-items: 2
  \- extended\-choice:
      name: MULTISELECTOPTIONS
      description: \(dqAvailable options\(dq
      property\-key: key
      quote\-value: true
      type: multi\-select
      value: !join:
        \- \(aq|\(aq
        \-
            \- foo
            \- bar
            \- select
      visible\-items: 2
      multi\-select\-delimiter: \(aq|\(aq
      default\-value: foo
  \- extended\-choice:
      name: JSON
      type: json
      groovy\-script: >\-
          import net.sf.json.JSONObject;
          def jsonEditorOptions = JSONObject.fromObject(/{schema:
          {\(dqtype\(dq: \(dqobject\(dq, \(dqtitle\(dq: \(dqName\(dq, \(dqproperties\(dq:
          {\(dqname\(dq: {\(dqtype\(dq: \(dqstring\(dq, \(dqpropertyOrder\(dq : 1}}}}/);
  \- extended\-choice:
      name: MULTILEVELMULTISELECT
      type: multi\-level\-multi\-select
      value: !join:
          \- \(aq,\(aq
          \-
              \- foo
              \- bar
              \- baz
  \- extended\-choice:
      name: MULTILEVELSINGLESELECT
      type: multi\-level\-single\-select
      value: foo

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B file()
A file parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the target location for the file upload
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- file:
      name: test.txt
      description: \(dqUpload test.txt.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B git\-parameter()
This parameter allows you to select a git tag, branch or revision number as
parameter in Parametrized builds.
.sp
Requires the Jenkins \fI\%Git Parameter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Description of the parameter (default \(aq\(aq)
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- 
.sp
The type of the list of parameters (default \(aqPT_TAG\(aq)
.INDENT 2.0
.TP
.B Allowed Values
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBPT_TAG\fP list of all commit tags in repository \-
returns Tag Name
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBPT_BRANCH\fP list of all branches in repository \-
returns Branch Name
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBPT_BRANCH_TAG\fP list of all commit tags and all
branches in repository \- returns Tag Name or Branch
Name
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBPT_REVISION\fP list of all revision sha1 in repository
followed by its author and date \- returns Tag SHA1
.UNINDENT
.IP \(bu 2
\fBPT_PULL_REQUEST\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbranch\fP (\fIstr\fP) \-\- Name of branch to look in. Used only if listing
revisions.  (default \(aq\(aq)
.IP \(bu 2
\fBbranchFilter\fP (\fIstr\fP) \-\- Regex used to filter displayed branches. If blank,
the filter will default to \(dq.*\(dq. Remote branches will be listed with
the remote name first. E.g., \(dqorigin/master\(dq  (default \(aq.*\(aq)
.IP \(bu 2
\fBtagFilter\fP (\fIstr\fP) \-\- Regex used to filter displayed branches. If blank, the
filter will default to \(dq.*\(dq. Remote branches will be listed with the
remote name first. E.g., \(dqorigin/master\(dq  (default \(aq*\(aq)
.IP \(bu 2
\fBsortMode\fP (\fIstr\fP) \-\- 
.sp
Mode of sorting.  (default \(aqNONE\(aq)
.INDENT 2.0
.TP
.B Allowed Values
.INDENT 7.0
.IP \(bu 2
\fBNONE\fP
.IP \(bu 2
\fBDESCENDING\fP
.IP \(bu 2
\fBASCENDING\fP
.IP \(bu 2
\fBASCENDING_SMART\fP
.IP \(bu 2
\fBDESCENDING_SMART\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdefaultValue\fP (\fIstr\fP) \-\- This value is returned when list is empty. (default
\(aq\(aq)
.IP \(bu 2
\fBselectedValue\fP (\fIstr\fP) \-\- 
.sp
Which value is selected, after loaded parameters.
If you choose \(aqdefault\(aq, but default value is not present on the list,
nothing is selected. (default \(aqNONE\(aq)
.INDENT 2.0
.TP
.B Allowed Values
.INDENT 7.0
.IP \(bu 2
\fBNONE\fP
.IP \(bu 2
\fBTOP\fP
.IP \(bu 2
\fBDEFAULT\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBuseRepository\fP (\fIstr\fP) \-\- If in the task is defined multiple repositories
parameter specifies which the repository is taken into account. If the
parameter is not defined, is taken first defined repository. The
parameter is a regular expression which is compared with a URL
repository. (default \(aq\(aq)
.IP \(bu 2
\fBquickFilterEnabled\fP (\fIbool\fP) \-\- When this option is enabled will show a text
field. Parameter is filtered on the fly. (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- git\-parameter:
      name: Foo

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- git\-parameter:
      name: Foo
      description: Lorem ipsum dolor sit amet.
      type: PT_BRANCH_TAG
      branch: baz
      tagFilter: bam
      branchFilter: boo
      sortMode: ASCENDING
      defaultValue: bor
      selectedValue: TOP
      useRepository: buh
      quickFilterEnabled: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B hidden()
Allows you to use parameters hidden from the build with parameter page.
.sp
Requires the Jenkins \fI\%Hidden Parameter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdefault\fP (\fIstr\fP) \-\- the default value of the parameter (optional)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- hidden:
      name: FOO
      default: bar
      description: A parameter named FOO, defaults to \(aqbar\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B label()
A node label parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdefault\fP (\fIstr\fP) \-\- the default value of the parameter (optional)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBall\-nodes\fP (\fIbool\fP) \-\- to run job on all nodes matching label
in parallel (default: false)
.IP \(bu 2
\fBmatching\-label\fP (\fIstr\fP) \-\- to run all nodes matching label
\(aqsuccess\(aq, \(aqunstable\(aq or \(aqallCases\(aq (optional)
.IP \(bu 2
\fBnode\-eligibility\fP (\fIstr\fP) \-\- all nodes, ignore temporary nodes or
ignore temporary offline nodes (optional, default all nodes)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- label:
      name: EXAMPLE LABEL 1
      description: \(dqEXAMPLE LABEL DESCRIPTION 1\(dq
      matching\-label: \(dqsuccess\(dq
      node\-eligibility: \(dqall\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B matrix\-combinations()
Matrix combinations parameter
.sp
Requires the Jenkins \fI\%Matrix Combinations Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBfilter\fP (\fIstr\fP) \-\- Groovy expression to use filter the combination by
default (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- matrix\-combinations:
      name: FOO
      description: \(dqSelect matrix combinations\(dq
      filter: \(dqplatform == foo\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maven\-metadata()
This parameter allows the resolution of maven artifact versions
by contacting the repository and reading the maven\-metadata.xml.
.sp
Requires the Jenkins \fI\%Maven Metadata Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Description of the parameter (optional)
.IP \(bu 2
\fBrepository\-base\-url\fP (\fIstr\fP) \-\- URL from where you retrieve your artifacts
(default \(aq\(aq)
.IP \(bu 2
\fBrepository\-username\fP (\fIstr\fP) \-\- Repository\(aqs username if authentication is
required. (default \(aq\(aq)
.IP \(bu 2
\fBrepository\-password\fP (\fIstr\fP) \-\- Repository\(aqs password if authentication is
required. (default \(aq\(aq)
.IP \(bu 2
\fBartifact\-group\-id\fP (\fIstr\fP) \-\- Unique project identifier (default \(aq\(aq)
.IP \(bu 2
\fBartifact\-id\fP (\fIstr\fP) \-\- Name of the artifact without version (default \(aq\(aq)
.IP \(bu 2
\fBpackaging\fP (\fIstr\fP) \-\- Artifact packaging option. Could be something such as
jar, zip, pom.... (default \(aq\(aq)
.IP \(bu 2
\fBversions\-filter\fP (\fIstr\fP) \-\- Specify a regular expression which will be used
to filter the versions which are actually displayed when triggering a
new build. (default \(aq\(aq)
.IP \(bu 2
\fBdefault\-value\fP (\fIstr\fP) \-\- For features such as SVN polling a default value
is required. If job will only be started manually, this field is not
necessary. (default \(aq\(aq)
.IP \(bu 2
\fBmaximum\-versions\-to\-display\fP (\fIstr\fP) \-\- The maximum number of versions to
display in the drop\-down. Any non\-number value as well as 0 or negative
values will default to all. (default 10)
.IP \(bu 2
\fBsorting\-order\fP (\fIstr\fP) \-\- ascending or descending
(default descending)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- maven\-metadata:
      name: \(aqmaven metadata param\(aq
      repository\-base\-url: \(aqhttp://nexus.example.com\(aq
      repository\-username: \(aqusername\(aq
      repository\-password: \(aqpassword\(aq
      artifact\-group\-id: \(aqcom.example\(aq
      artifact\-id: \(aqexample\(aq
      packaging: \(aqjar\(aq
      versions\-filter: \(aq[0\-9]+\(aq
      default\-value: \(aqFIRST\(aq
      maximum\-versions\-to\-display: \(dq5\(dq
      sorting\-order: \(dqAscending\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B node()
Defines a list of nodes where this job could potentially be executed on.
Restrict where this project can be run, If your using a node or label
parameter to run your job on a particular node, you should not use the
option \(dqRestrict where this project can be run\(dq in the job configuration
\- it will not have any effect to the selection of your node anymore!
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBdefault\-slaves\fP (\fIlist\fP) \-\- The nodes used when job gets triggered
by anything else other than manually
.IP \(bu 2
\fBallowed\-slaves\fP (\fIlist\fP) \-\- The nodes available for selection
when job gets triggered manually. Empty means \(aqAll\(aq.
.IP \(bu 2
\fBignore\-offline\-nodes\fP (\fIbool\fP) \-\- Ignore nodes not online or not having
executors (default false)
.IP \(bu 2
\fBallowed\-multiselect\fP (\fIbool\fP) \-\- Allow multi node selection for concurrent
builds \- this option only makes sense (and must be selected!) in
case the job is configured with: \(dqExecute concurrent builds if
necessary\(dq. With this configuration the build will be executed on all
the selected nodes in parallel. (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- node:
      name: SLAVE_NAME
      description: \(dqSelect slave\(dq
      allowed\-slaves:
        \- slave001
        \- slave002
        \- slave003
      ignore\-offline\-nodes: true
      allowed\-multiselect: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B parameter\-separator()
A parameter separator.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- name of the separator (default \(dq\(dq, the plugin will assign a randomly generated UUID if not specified)
.IP \(bu 2
\fBseparator\-style\fP (\fIstr\fP) \-\- the style of the separator. Uses CSS. (default \(dq\(dq)
.IP \(bu 2
\fBsection\-header\-text\fP (\fIstr\fP) \-\- the section header text of the separator (default \(dq\(dq)
.IP \(bu 2
\fBsection\-header\-style\fP (\fIstr\fP) \-\- the section header style (CSS) of the separator. Uses CSS. (default \(dq\(dq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- parameter\-separator:
      name: lorem
      separator\-style: FOO
      section\-header: bar
      section\-header\-style: font\-weight:bold;z\-index:10000
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B password()
A password parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdefault\fP (\fIstr\fP) \-\- the default value of the parameter (optional)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- password:
      name: FOO
      default: 1HSC0Ts6E161FysGf+e1xasgsHkgleLh09JUTYnipPvw=
      description: \(dqA parameter named FOO.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B promoted build()
A promoted build parameter.
.sp
Requires the Jenkins \fI\%Promoted Builds Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter (required)
.IP \(bu 2
\fBproject\-name\fP (\fIstr\fP) \-\- the job from which the user can pick runs (required)
.IP \(bu 2
\fBpromotion\-name\fP (\fIstr\fP) \-\- promotion process to choose from (optional)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- promoted:
      name: FOO
      project\-name: \(dqfoo\-build\(dq
      promotion\-name: \(dqpassed\-promotion\(dq
      description: \(dqSelect a foo\-build for promotion\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B random\-string()
This parameter generates a random string and passes it to the
build, preventing Jenkins from combining queued builds.
.sp
Requires the Jenkins \fI\%Random String Parameter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of the parameter
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Description of the parameter (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-validation\-message\fP (\fIstr\fP) \-\- Failure message to display for invalid
input (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- random\-string:
      name: job\-string
      description: \(dqA random string passed to the job\(dq
      failed\-validation\-message: \(dqYour input string is invalid\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B run()
A run parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBproject\-name\fP (\fIstr\fP) \-\- the name of job from which the user can pick runs
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- run:
      name: FOO
      project\-name: \(dqfoo\-build\(dq
      description: \(dqSelect a foo\-build for promotion\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B string()
A string parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdefault\fP (\fIstr\fP) \-\- the default value of the parameter (optional)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBtrim\fP (\fIbool\fP) \-\- strip whitespaces from the begnning and end
of the string (optional, default: false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- string:
      name: FOO
      default: bar
      description: \(dqA parameter named FOO, defaults to \(aqbar\(aq.\(dq
      trim: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B svn\-tags()
A svn tag parameter
.sp
Requires the Jenkins \fI\%Parameterized Trigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- the url to list tags from
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- Credentials ID to use for authentication
(default \(aq\(aq)
.IP \(bu 2
\fBfilter\fP (\fIstr\fP) \-\- the regular expression to filter tags (default \(aq\(aq)
.IP \(bu 2
\fBdefault\fP (\fIstr\fP) \-\- the default value of the parameter (default \(aq\(aq)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (default \(aq\(aq)
.IP \(bu 2
\fBmax\-tags\fP (\fIint\fP) \-\- the number of tags to display (default \(aq100\(aq)
.IP \(bu 2
\fBsort\-newest\-first\fP (\fIbool\fP) \-\- sort tags from newest to oldest (default true)
.IP \(bu 2
\fBsort\-z\-to\-a\fP (\fIbool\fP) \-\- sort tags in reverse alphabetical order
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- svn\-tags:
      name: BRANCH_NAME
      default: release
      description: A parameter named BRANCH_NAME default is release
      url: http://svn.example.org/repo
      filter: [A\-za\-z0\-9]*
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B text()
A text parameter.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdefault\fP (\fIstr\fP) \-\- the default value of the parameter (optional)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- text:
      name: FOO
      default: bar
      description: \(dqA parameter named FOO, defaults to \(aqbar\(aq.\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B validating\-string()
A validating string parameter
.sp
Requires the Jenkins \fI\%Validating String Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- the name of the parameter
.IP \(bu 2
\fBdefault\fP (\fIstr\fP) \-\- the default value of the parameter (optional)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- a description of the parameter (optional)
.IP \(bu 2
\fBregex\fP (\fIstr\fP) \-\- a regular expression to validate the string
.IP \(bu 2
\fBmsg\fP (\fIstr\fP) \-\- a message to display upon failed validation
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
parameters:
  \- validating\-string:
      name: FOO
      default: bar
      description: \(dqA parameter named FOO, defaults to \(aqbar\(aq.\(dq
      regex: [A\-Za\-z]*
      msg: Your entered value failed validation
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Properties
.sp
The Properties module supplies a wide range of options that are
implemented as Jenkins job properties.
.INDENT 0.0
.TP
\fBComponent\fP: properties
.INDENT 7.0
.TP
.B Macro
property
.TP
.B Entry Point
jenkins_jobs.properties
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job:
  name: test_job

  properties:
    \- github:
        url: https://github.com/openstack\-infra/jenkins\-job\-builder/
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  properties.Properties(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqproperties\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqproperty\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  20
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B authenticated\-build()
Specifies an authorization matrix where only authenticated users
may trigger a build.
.sp
Deprecated since version 0.1.0.: Please use \fI\%authorization\fP\&.

.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- authenticated\-build

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B authorization()
Specifies an authorization matrix
.INDENT 7.0
.TP
.B Parameters
\fB<name>\fP (\fIlist\fP) \-\- .INDENT 7.0
.TP
.B \fI<name>\fP is the name of the group or user, containing
the list of rights to grant.
.UNINDENT
.INDENT 7.0
.TP
.B <name> rights
.INDENT 7.0
.IP \(bu 2
\fBcredentials\-create\fP
.IP \(bu 2
\fBcredentials\-delete\fP
.IP \(bu 2
\fBcredentials\-manage\-domains\fP
.IP \(bu 2
\fBcredentials\-update\fP
.IP \(bu 2
\fBcredentials\-view\fP
.IP \(bu 2
\fBjob\-build\fP
.IP \(bu 2
\fBjob\-cancel\fP
.IP \(bu 2
\fBjob\-configure\fP
.IP \(bu 2
\fBjob\-delete\fP
.IP \(bu 2
\fBjob\-discover\fP
.IP \(bu 2
\fBjob\-extended\-read\fP
.IP \(bu 2
\fBjob\-move\fP
.IP \(bu 2
\fBjob\-read\fP
.IP \(bu 2
\fBjob\-status\fP
.IP \(bu 2
\fBjob\-workspace\fP
.IP \(bu 2
\fBownership\-jobs\fP
.IP \(bu 2
\fBrun\-delete\fP
.IP \(bu 2
\fBrun\-replay\fP
.IP \(bu 2
\fBrun\-update\fP
.IP \(bu 2
\fBscm\-tag\fP
.UNINDENT
.UNINDENT

.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
    \- authorization:
        admin:
            \- credentials\-create
            \- credentials\-delete
            \- credentials\-manage\-domains
            \- credentials\-update
            \- credentials\-view
            \- job\-build
            \- job\-cancel
            \- job\-configure
            \- job\-delete
            \- job\-discover
            \- job\-move
            \- job\-read
            \- job\-status
            \- job\-workspace
            \- ownership\-jobs
            \- run\-delete
            \- run\-replay
            \- run\-update
            \- scm\-tag
        anonymous:
            \- job\-read
            \- job\-extended\-read

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B batch\-tasks()
Batch tasks can be tasks for events like releases, integration, archiving,
etc. In this way, anyone in the project team can execute them in a way that
leaves a record.
.sp
A batch task consists of a shell script and a name. When you execute
a build, the shell script gets run on the workspace, just like a build.
Batch tasks and builds \(dqlock\(dq the workspace, so when one of those
activities is in progress, all the others will block in the queue.
.sp
Requires the Jenkins \fI\%Batch Task Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBbatch\-tasks\fP (\fIlist\fP) \-\- 
.sp
Batch tasks.
.INDENT 7.0
.TP
.B Tasks
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) Task name.
.IP \(bu 2
\fBscript\fP (\fIstr\fP) Task script.
.UNINDENT
.UNINDENT

.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- batch\-tasks:
      \- name: release
        script: mvn \-B release:prepare release:perform
      \- name: say hello
        script: echo \(dqHello world\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B branch\-api()
Enforces a minimum time between builds based on the desired maximum rate.
.sp
Requires the Jenkins \fI\%Branch API Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnumber\-of\-builds\fP (\fIint\fP) \-\- The maximum number of builds allowed within
the specified time period. (default 1)
.IP \(bu 2
\fBtime\-period\fP (\fIstr\fP) \-\- 
.sp
The time period within which the maximum number
of builds will be enforced. (default \(aqHour\(aq)
.INDENT 2.0
.TP
.B valid values
\fBSecond\fP \fBMinute\fP \fBHour\fP, \fBDay\fP, \fBWeek\fP, \fBMonth\fP, \fBYear\fP
.UNINDENT

.IP \(bu 2
\fBskip\-rate\-limit\fP (\fIbool\fP) \-\- Permit user triggered builds to
skip the rate limit (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- branch\-api

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- branch\-api:
      time\-period: Day
      number\-of\-builds: 5
      skip\-rate\-limit: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B build\-blocker()
This plugin keeps the actual job in the queue
if at least one name of currently running jobs
is matching with one of the given regular expressions.
.sp
Requires the Jenkins \fI\%Build Blocker Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuse\-build\-blocker\fP (\fIbool\fP) \-\- Enable or disable build blocker (default true)
.IP \(bu 2
\fBblocking\-jobs\fP (\fIlist\fP) \-\- One regular expression per line to select
blocking jobs by their names (required)
.IP \(bu 2
\fBblock\-level\fP (\fIstr\fP) \-\- block build globally (\(aqGLOBAL\(aq) or per node (\(aqNODE\(aq)
(default \(aqGLOBAL\(aq)
.IP \(bu 2
\fBqueue\-scanning\fP (\fIstr\fP) \-\- scan build queue for all builds (\(aqALL\(aq) or only
buildable builds (\(aqBUILDABLE\(aq) (default \(aqDISABLED\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- build\-blocker:
      blocking\-jobs:
        \- \(dq.*\-deploy\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- build\-blocker:
      use\-build\-blocker: true
      blocking\-jobs:
        \- \(dq.*\-deploy\(dq
        \- \(dq^maintenance.*\(dq
      block\-level: \(aqNODE\(aq
      queue\-scanning: \(aqBUILDABLE\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B build\-discarder()
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdays\-to\-keep\fP (\fIint\fP) \-\- Number of days to keep builds for (default \-1)
.IP \(bu 2
\fBnum\-to\-keep\fP (\fIint\fP) \-\- Number of builds to keep (default \-1)
.IP \(bu 2
\fBartifact\-days\-to\-keep\fP (\fIint\fP) \-\- Number of days to keep builds with
artifacts (default \-1)
.IP \(bu 2
\fBartifact\-num\-to\-keep\fP (\fIint\fP) \-\- Number of builds with artifacts to keep
(default \-1)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
    \- build\-discarder:
        days\-to\-keep: 42
        num\-to\-keep: 43
        artifact\-days\-to\-keep: 44
        artifact\-num\-to\-keep: 45

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
    \- build\-discarder

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B builds\-chain\-fingerprinter()
Builds chain fingerprinter.
.sp
Requires the Jenkins \fI\%Builds chain fingerprinter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBper\-builds\-chain\fP (\fIbool\fP) \-\- enable builds hierarchy fingerprinting
(default false)
.IP \(bu 2
\fBper\-job\-chain\fP (\fIbool\fP) \-\- enable jobs hierarchy fingerprinting
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- builds\-chain\-fingerprinter:
      per\-builds\-chain: true
      per\-job\-chain: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cachet\-gating()
The Cachet Gating Plugin provides a gating mechanism
based on the availability of resources.
.sp
Requires the Jenkins: \fI\%Cachet Gate Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrequired\-resources\fP (\fIbool\fP) \-\- Confirm availability of listed
resources before building. Requires the list of resources to
also be defined. (default true)
.IP \(bu 2
\fBresources\fP (\fIlist\fP) \-\- which resources to gate
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
      \- cachet\-gating:
          required\-resources: true
          resources:
              \- beaker
              \- brew

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B copyartifact()
Specify a list of projects that have access to copy the artifacts of
this project.
.sp
Requires the Jenkins \fI\%Copy Artifact plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBprojects\fP (\fIstr\fP) \-\- comma separated list of projects that can copy
artifacts of this project. Wild card character \(aq*\(aq is available.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- copyartifact:
      projects: foo*

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B delivery\-pipeline()
Requires the Jenkins \fI\%Delivery Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstage\fP (\fIstr\fP) \-\- Name of the stage for this job (default \(aq\(aq)
.IP \(bu 2
\fBtask\fP (\fIstr\fP) \-\- Name of the task for this job (default \(aq\(aq)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- task description template for this job
(default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- delivery\-pipeline

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- delivery\-pipeline:
      stage: Stage
      task: Task
      description: Task\-Description

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B disable\-resume()
Do not allow the pipeline to resume if the master restarts
.sp
Requires the Jenkins \fI\%Pipeline Job Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- disable\-resume

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B disk\-usage()
Enables the Disk Usage Plugin.
.sp
Requires the Jenkins \fI\%Disk Usage Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- disk\-usage

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B docker\-container()
Requires the Jenkins: \fI\%Docker Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdocker\-registry\-url\fP (\fIstr\fP) \-\- URL of the Docker registry. (default \(aq\(aq)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- Credentials Id for the Docker registey.
(default \(aq\(aq)
.IP \(bu 2
\fBcommit\-on\-success\fP (\fIbool\fP) \-\- When a job completes, the docker slave
instance is committed with repository based on the job name and build
number as tag. (default false)
.IP \(bu 2
\fBadditional\-tag\fP (\fIstr\fP) \-\- Additional tag to apply to the docker slave
instance when committing it. (default \(aq\(aq)
.IP \(bu 2
\fBpush\-on\-success\fP (\fIbool\fP) \-\- Also push the resulting image when committing
the docker slave instance. (default false)
.IP \(bu 2
\fBclean\-local\-images\fP (\fIbool\fP) \-\- Clean images from the local daemon after
building. (default true)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- docker\-container

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- docker\-container:
      commit\-on\-success: true
      additional\-tag: latest
      push\-on\-success: true
      clean\-local\-images: true
      docker\-registry\-url: https://index.docker.io/v1/
      credentials\-id: 71e4f29c\-162b\-40d0\-85d9\-3ddfba2911a0

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gitbucket()
Integrate GitBucket to Jenkins.
.sp
Requires the Jenkins \fI\%GitBucket Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- GitBucket URL to issue (required)
.IP \(bu 2
\fBlink\-enabled\fP (\fIbool\fP) \-\- Enable hyperlink to issue (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- gitbucket:
      url: https://foo.com

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- gitbucket:
      url: https://foo.com
      link\-enabled: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B github()
Sets the GitHub URL for the project.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- the GitHub URL (required)
.IP \(bu 2
\fBdisplay\-name\fP (\fIstr\fP) \-\- This value will be used as context name for commit
status if status builder or status publisher is defined for this
project. (>= 1.14.1) (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- github:
      url: https://github.com/openstack\-infra/jenkins\-job\-builder/

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- github:
      url: https://github.com/openstack\-infra/jenkins\-job\-builder/
      display\-name: foo

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gitlab()
Sets the GitLab connection for the project. Configured via Jenkins Global
Configuration.
.sp
Requires the Jenkins \fI\%GitLab Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBconnection\fP (\fIstr\fP) \-\- the GitLab connection name (required)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- gitlab:
      connection: gitlab\-connection

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gitlab\-logo()
Configures the GitLab\-Logo Plugin.
.sp
Requires the Jenkins \fI\%GitLab Logo Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBrepository\-name\fP (\fIstr\fP) \-\- the GitLab repository name (required)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- gitlab\-logo:
      repository\-name: gitlab\-repository\-name

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gogs()
Sets the Gogs webhook properties for the project.
.sp
Requires the Jenkins \fI\%Gogs Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsecret\fP (\fIstr\fP) \-\- webhook secret (default \(aq\(aq)
.IP \(bu 2
\fBbranch\-filter\fP (\fIstr\fP) \-\- filter which needs to match to trigger a job (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- gogs

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- gogs:
      branch\-filter: \(aqmaster\(aq
      secret: \(aqyoursecret\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B groovy\-label()
This plugin allows you to use Groovy script to restrict where this project
can be run.
.sp
Requires the Jenkins \fI\%Groovy Label Assignment Plugin\fP\&.
.sp
Return value from Groovy script is treated as Label Expression.
It is treated as followings:
.INDENT 7.0
.IP \(bu 2
A non\-string value will be converted to a string using toString()
.IP \(bu 2
When null or blank string is returned, node restriction does not take
effect (or is not overwritten).
.IP \(bu 2
When exception occurred or Label Expression is not parsed correctly,
builds are canceled.
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBscript\fP (\fIstr\fP) \-\- Groovy script (default \(aq\(aq)
.IP \(bu 2
\fBsandbox\fP (\fIbool\fP) \-\- Use Groovy Sandbox. (default false)
If checked, run this Groovy script in a sandbox with limited abilities.
If unchecked, and you are not a Jenkins administrator, you will need to
wait for an administrator to approve the script
.IP \(bu 2
\fBclasspath\fP (\fIlist\fP) \-\- Additional classpath entries accessible from
the script, each of which should be an absolute local path or
URL to a JAR file, according to \(dqThe file URI Scheme\(dq (optional)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
    \- groovy\-label

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
    \- groovy\-label:
        script: \(dq$LABEL_NAME\(dq
        sandbox: true
        classpath:
            \- \(dqfile:/minimal/absolute/path/to/file.jar\(dq
            \- \(dqfile:///traditional/absolute/path/to/file.jar\(dq
            \- \(dqhttp://example.org/path/to/file.jar\(dq
            \- \(dqhttps://example.org/path/to/file.jar\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B heavy\-job()
This plugin allows you to define \(dqweight\(dq on each job,
and making each job consume that many executors
.sp
Requires the Jenkins \fI\%Heavy Job Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBweight\fP (\fIint\fP) \-\- Specify the total number of executors
that this job should occupy (default 1)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- heavy\-job:
      weight: 2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B inject()
Allows you to inject environment variables into the build.
.sp
Requires the Jenkins \fI\%EnvInject Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproperties\-file\fP (\fIstr\fP) \-\- file to read with properties (optional)
.IP \(bu 2
\fBproperties\-content\fP (\fIstr\fP) \-\- key=value properties (optional)
.IP \(bu 2
\fBscript\-file\fP (\fIstr\fP) \-\- file with script to run (optional)
.IP \(bu 2
\fBscript\-content\fP (\fIstr\fP) \-\- script to run (optional)
.IP \(bu 2
\fBgroovy\-content\fP (\fIstr\fP) \-\- groovy script to run (optional)
.IP \(bu 2
\fBgroovy\-sandbox\fP (\fIbool\fP) \-\- run groovy script in sandbox (default false)
.IP \(bu 2
\fBload\-from\-master\fP (\fIbool\fP) \-\- load files from master (default false)
.IP \(bu 2
\fBenabled\fP (\fIbool\fP) \-\- injection enabled (default true)
.IP \(bu 2
\fBkeep\-system\-variables\fP (\fIbool\fP) \-\- keep system variables (default true)
.IP \(bu 2
\fBkeep\-build\-variables\fP (\fIbool\fP) \-\- keep build variable (default true)
.IP \(bu 2
\fBoverride\-build\-parameters\fP (\fIbool\fP) \-\- override build parameters
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- inject:
      properties\-content: |
        FOO=bar
        BAZ=foobar

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B least\-load()
Enables the Least Load Plugin.
.sp
Requires the Jenkins \fI\%Least Load Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBdisabled\fP (\fIbool\fP) \-\- whether or not leastload is disabled (default true)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- least\-load:
      disabled: False

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B lockable\-resources()
Requires the Jenkins \fI\%Lockable Resources Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBresources\fP (\fIstr\fP) \-\- List of required resources, space separated.
(required, mutual exclusive with label)
.IP \(bu 2
\fBlabel\fP (\fIstr\fP) \-\- If you have created a pool of resources, i.e. a label,
you can take it into use here. The build will select the resource(s)
from the pool that includes all resources sharing the given label.
(required, mutual exclusive with resources)
.IP \(bu 2
\fBvar\-name\fP (\fIstr\fP) \-\- Name for the Jenkins variable to store the reserved
resources in. Leave empty to disable. (default \(aq\(aq)
.IP \(bu 2
\fBnumber\fP (\fIint\fP) \-\- Number of resources to request, empty value or 0 means
all. This is useful, if you have a pool of similar resources,
from which you want one or more to be reserved. (default 0)
.IP \(bu 2
\fBmatch\-script\fP (\fIstr\fP) \-\- Groovy script to reserve resource based on its
properties. Leave empty to disable. (default None)
.IP \(bu 2
\fBgroovy\-sandbox\fP (\fIbool\fP) \-\- Execute the provided match\-script in Groovy
sandbox. Leave empty to disable. (default False)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-
properties:
  \- lockable\-resources:
      resources: \(dqthe\-resource\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-
properties:
  \- lockable\-resources:
      label: \(dqpool\-1\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-
properties:
  \- lockable\-resources:
      resources: \(dqthe\-resource\(dq
      var\-name: \(dqRESOURCE_NAME\(dq
      number: 10

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-\-
properties:
  \- lockable\-resources:
      match\-script: \(dqresourceName == MY_VAR\(dq
      groovy\-sandbox: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B naginator\-opt\-out()
Lets you opt\-out so no rebuild option for Naginator is added.
.sp
Requires the Jenkins \fI\%Naginator Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBopt\-out\fP (\fIbool\fP) \-\- disables the rebuild option if True (default False).
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
 \- naginator\-opt\-out:
    opt\-out: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B office\-365\-connector()
Used to send actionable messages to MS Outlook or Teams
.sp
Requires the Jenkins: :jenkins\-plugins:\(ga Office\-365\-Connector Plugin
<Office\-365\-Connector>\(ga.
.INDENT 7.0
.TP
.B Parameters
\fBwebhooks\fP (\fIlist\fP) \-\- 
.sp
List of webhooks (required)
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (srt): URL generated in the Office 365 Connectors page (required)
.IP \(bu 2
.INDENT 2.0
.TP
\fBname\fP (str): Allows to provide name fo the connection. Name is not
mandatory but helps managing when there are many connection
assigned to the build (optional, default \(aq\(aq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBstart\-notification\fP (bool): If the notification should be sent on
start of build (optional, default False)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnotify\-success\fP (bool): If the notification should be sent on
succeeded build (optional, default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnotify\-aborted\fP (bool): If the notification should be sent on
aborted build (optional, default False)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnotify\-not\-built\fP (bool): If the notification should be sent on
not built build (optional, default False)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnotify\-unstable\fP (bool): If the notification should be sent on
unstable build (optional, default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnotify\-failure\fP (bool): If the notification should be sent on
failed build (optional, default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnotify\-back\-to\-normal\fP (bool): If the notification should be sent on
back to normal build (optional, default True)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnotify\-repeated\-failure\fP (bool): If the notification should be sent on
repeated failures (optional, default False)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBtimeout\fP (int): connection timeout (in milliseconds) for TCP and HTTP
(optional, default 30000)
.UNINDENT
.IP \(bu 2
\fBmacros\fP (list): List of macros
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBtemplate\fP (str)
\fBvalue\fP (str)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBfact\-definitions\fP (list): List of fact definitions
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBname\fP (str)
\fBtemplate\fP (str)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- office\-365\-connector:
      webhooks:
        \- url: http://outlook.office.com/webhook
          name: full
          start\-notification: true
          notify\-success: false
          notify\-aborted: true
          notify\-not\-built: true
          notify\-unstable: false
          notify\-failure: false
          notify\-back\-to\-normal: false
          notify\-repeated\-failure: true
          timeout: 30001
          macros:
            \- template: macro1
              value: macro1_value
            \- template: macro2
              value: macro2_value
          fact\-definitions:
            \- name: fd1
              template: fd1_value
            \- name: fd2
              template: fd2_value

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ownership()
Plugin provides explicit ownership for jobs and slave nodes.
.sp
Requires the Jenkins \fI\%Ownership Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenabled\fP (\fIbool\fP) \-\- whether ownership enabled (default : true)
.IP \(bu 2
\fBowner\fP (\fIstr\fP) \-\- the owner of job
.IP \(bu 2
\fBco\-owners\fP (\fIlist\fP) \-\- list of job co\-owners
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
 \- ownership:
    owner: foo
    co\-owners:
     \- bar
     \- moo

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B priority\-sorter()
Allows simple ordering of builds, using a configurable job priority.
.sp
Requires the Jenkins \fI\%Priority Sorter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBpriority\fP (\fIint\fP) \-\- Priority of the job.  Higher value means higher
priority, with 3 as the default priority. (required)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- priority\-sorter:
      priority: 3

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B promoted\-build()
Marks a build for promotion. A promotion process with an identical
name must be created via the web interface in the job in order for the job
promotion to persist. Promotion processes themselves cannot be configured
by jenkins\-jobs due to the separate storage of plugin configuration files.
.sp
Requires the Jenkins \fI\%Promoted Builds Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBnames\fP (\fIlist\fP) \-\- the promoted build names (optional)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- promoted\-build:
      names:
        \- \(dqRelease to QA\(dq
        \- \(dqJane Must Approve\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B rebuild()
This plug\-in allows the user to rebuild a parameterized build without
entering the parameters again.It will also allow the user to edit the
parameters before rebuilding.
.sp
Requires the Jenkins \fI\%Rebuild Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBauto\-rebuild\fP (\fIbool\fP) \-\- Rebuild without asking for parameters
(default false)
.IP \(bu 2
\fBrebuild\-disabled\fP (\fIbool\fP) \-\- Disable rebuilding for this job
(default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
    \- rebuild

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
    \- rebuild:
        auto\-rebuild: true
        rebuild\-disabled: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B resource\-gating()
Jenkins Gating enables requiring external resources to be available before
build starts.
.sp
Requires the Jenkins: \fI\%Jenkins Gating\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBresources\fP (\fIlist\fP) \-\- Resource identifiers to be up before building
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
    \- resource\-gating:
        resources:
            \- external/ci.example.com
            \- foo/bar/baz

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sidebar()
Allows you to add links in the sidebar.
Requires the Jenkins \fI\%Sidebar\-Link Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- url to link to (optional)
.IP \(bu 2
\fBtext\fP (\fIstr\fP) \-\- text for the link (optional)
.IP \(bu 2
\fBicon\fP (\fIstr\fP) \-\- path to icon (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
   \- sidebar:
       url: https://jenkins.debian.net/userContent/about.html
       text: About jenkins.debian.net
       icon: /userContent/images/debian\-swirl\-24x24.png
   \- sidebar:
       url: https://jenkins.debian.net/view/reproducible
       text: reproducible builds jobs
       icon: /userContent/images/debian\-jenkins\-24x24.png

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B slack()
Requires the Jenkins \fI\%Slack Plugin\fP\&.
.sp
When using Slack Plugin version < 2.0, Slack Plugin itself requires a
publisher aswell as properties please note that you have to add the
publisher to your job configuration aswell. When using Slack Plugin
version >= 2.0, you should only configure the publisher.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnotify\-start\fP (\fIbool\fP) \-\- Send notification when the job starts
(default false)
.IP \(bu 2
\fBnotify\-success\fP (\fIbool\fP) \-\- Send notification on success. (default false)
.IP \(bu 2
\fBnotify\-aborted\fP (\fIbool\fP) \-\- Send notification when job is aborted. (
default false)
.IP \(bu 2
\fBnotify\-not\-built\fP (\fIbool\fP) \-\- Send notification when job set to NOT_BUILT
status. (default false)
.IP \(bu 2
\fBnotify\-unstable\fP (\fIbool\fP) \-\- Send notification when job becomes unstable.
(default false)
.IP \(bu 2
\fBnotify\-failure\fP (\fIbool\fP) \-\- Send notification when job fails.
(default false)
.IP \(bu 2
\fBnotify\-back\-to\-normal\fP (\fIbool\fP) \-\- Send notification when job is
succeeding again after being unstable or failed. (default false)
.IP \(bu 2
\fB\(aqnotify\-repeated\-failure\(aq\fP (\fIbool\fP) \-\- Send notification when job is
still failing after last failure. (default false)
.IP \(bu 2
\fBinclude\-test\-summary\fP (\fIbool\fP) \-\- Include the test summary. (default
False)
.IP \(bu 2
\fBinclude\-custom\-message\fP (\fIbool\fP) \-\- Include a custom message into the
notification. (default false)
.IP \(bu 2
\fBcustom\-message\fP (\fIstr\fP) \-\- Custom message to be included. (default \(aq\(aq)
.IP \(bu 2
\fBroom\fP (\fIstr\fP) \-\- A comma separated list of rooms / channels to send
the notifications to. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
    \- slack:
        room: dummy, dummy2
        notify\-start: true
        notify\-success: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B slave\-prerequisites()
This plugin allows you to check prerequisites on slave before
a job can run a build on it
.sp
Requires the Jenkins \fI\%Slave Prerequisites Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBscript\fP (\fIstr\fP) \-\- A script to be executed on slave node.
If returning non 0 status, the node will be vetoed from hosting
the build. (required)
.IP \(bu 2
\fBinterpreter\fP (\fIstr\fP) \-\- Command line interpreter to be used for executing
the prerequisite script \- either \fIshell\fP for Unix shell or \fIcmd\fP for
Windows batch script. (default shell)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- slave\-prerequisites:
      script: |
        #!/bin/bash
        AVAILABLE=$(df \-BG \-\-output=avail / | tail \-1)
        test ${AVAILABLE%G} \-ge 10

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- slave\-prerequisites:
      interpreter: cmd
      script: |
        @echo off
        if exist C:\eJenkins\eworkspace.lock exit /b 1

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B slave\-utilization()
This plugin allows you to specify the percentage of a slave\(aqs capacity a
job wants to use.
.sp
Requires the Jenkins \fI\%Slave Utilization Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBslave\-percentage\fP (\fIint\fP) \-\- Specify the percentage of a slave\(aqs execution
slots that this job should occupy (default 0)
.IP \(bu 2
\fBsingle\-instance\-per\-slave\fP (\fIbool\fP) \-\- Control whether concurrent instances
of this job will be permitted to run in parallel on a single slave
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- slave\-utilization:
      slave\-percentage: 40
      single\-instance\-per\-slave: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B speed\-durability()
This setting allows users to change the default durability mode
for running Pipelines.
.INDENT 7.0
.TP
.B Parameters
\fBhint\fP (\fIstr\fP) \-\- speed durability hint to be used, can be performance\-optimized,
survivable\-non\-atomic, max\-survivability
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- speed\-durability:
      hint: performance\-optimized

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B throttle()
Throttles the number of builds for this job.
.sp
Requires the Jenkins \fI\%Throttle Concurrent Builds Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBoption\fP (\fIstr\fP) \-\- throttle \fIproject\fP (throttle the project alone)
or \fIcategory\fP (throttle the project as part of one or more categories)
.IP \(bu 2
\fBmax\-per\-node\fP (\fIint\fP) \-\- max concurrent builds per node (default 0)
.IP \(bu 2
\fBmax\-total\fP (\fIint\fP) \-\- max concurrent builds (default 0)
.IP \(bu 2
\fBenabled\fP (\fIbool\fP) \-\- whether throttling is enabled (default true)
.IP \(bu 2
\fBcategories\fP (\fIlist\fP) \-\- multiproject throttle categories
.IP \(bu 2
\fBmatrix\-builds\fP (\fIbool\fP) \-\- throttle matrix master builds (default true)
.IP \(bu 2
\fBmatrix\-configs\fP (\fIbool\fP) \-\- throttle matrix config builds (default false)
.IP \(bu 2
\fBparameters\-limit\fP (\fIstr\fP) \-\- prevent jobs with matching parameters from
running concurrently (default false)
.IP \(bu 2
\fBparameters\-check\-list\fP (\fIlist\fP) \-\- Comma\-separated list of parameters
to use when comparing jobs (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- throttle:
      max\-per\-node: 2
      max\-total: 4
      categories:
        \- cat1
        \- cat2
      option: category
      matrix\-builds: false
      matrix\-configs: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B zeromq\-event()
This is a Jenkins plugin that will publish Jenkins Job run events
(start, complete, finish) to a ZMQ PUB socket.
.sp
Requires the Jenkins \fI\%ZMQ Event Publisher.\fP
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
properties:
  \- zeromq\-event

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Publishers
.sp
Publishers define actions that the Jenkins job should perform after
the build is complete.
.INDENT 0.0
.TP
\fBComponent\fP: publishers
.INDENT 7.0
.TP
.B Macro
publisher
.TP
.B Entry Point
jenkins_jobs.publishers
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  publishers.Publishers(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqpublishers\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqpublisher\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  70
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B aggregate\-flow\-tests()
Aggregate downstream test results in a Build Flow job.
.sp
Requires the Jenkins \fI\%Build Flow Test Aggregator Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBshow\-test\-results\-trend\fP (\fIbool\fP) \-\- whether to show test results
trend graph (default true)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- aggregate\-flow\-tests:
      show\-test\-results\-trend: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B aggregate\-tests()
Aggregate downstream test results
.INDENT 7.0
.TP
.B Parameters
\fBinclude\-failed\-builds\fP (\fIbool\fP) \-\- whether to include failed builds
(default false)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- aggregate\-tests:
      include\-failed\-builds: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B allure()
Publish Allure report for the build. Requires the Jenkins
\fI\%Allure Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBjdk\fP (\fIstr\fP) \-\- String identifier for a JDK installation in Jenkins
.IP \(bu 2
\fBcommandline\fP (\fIstr\fP) \-\- String identifier for a Allure\-commandline tool
installation
.IP \(bu 2
\fBreport\-build\-policy\fP (\fIstr\fP) \-\- String identifier for a report build
policy enum. Possible values: \(aqALWAYS\(aq, \(aqUNSTABLE\(aq, \(aqUNSUCCESSFUL\(aq.
(By default is \(aqALWAYS\(aq)
.IP \(bu 2
\fBinclude\-properties\fP (\fIbool\fP) \-\- Flag to include specified properties
.IP \(bu 2
\fBresults\-paths\fP (\fIlist\fP) \-\- List of results directories
.IP \(bu 2
\fBproperties\fP (\fIlist\fP) \-\- List of key:value property pairs
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- allure:
      results\-paths:
       \- path: \(aqbuild/allure\-results\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- allure:
      results\-paths:
       \- path: \(aqbuild/allure\-results1\(aq
       \- path: \(aqbuild/allure\-results2\(aq
      properties:
       \- key: \(aqallure.link.issue.pattern\(aq
         value: \(aqhttp://test.tms/{}\(aq
      jdk: openjdk1.8
      commandline: allure2
      report\-build\-policy: UNSTABLE
      include\-properties: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B archive()
Archive build artifacts
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBartifacts\fP (\fIstr\fP) \-\- path specifier for artifacts to archive
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \-\- path specifier for artifacts to exclude (optional)
.IP \(bu 2
\fBlatest\-only\fP (\fIbool\fP) \-\- only keep the artifacts from the latest
successful build
.IP \(bu 2
\fBallow\-empty\fP (\fIbool\fP) \-\- pass the build if no artifacts are
found (default false)
.IP \(bu 2
\fBonly\-if\-success\fP (\fIbool\fP) \-\- archive artifacts only if build is successful
(default false)
.IP \(bu 2
\fBfingerprint\fP (\fIbool\fP) \-\- fingerprint all archived artifacts (default false)
.IP \(bu 2
\fBdefault\-excludes\fP (\fIbool\fP) \-\- This option allows you to enable or disable the
default Ant exclusions. (default true)
.IP \(bu 2
\fBcase\-sensitive\fP (\fIbool\fP) \-\- Treat include and exclude patterns as case
sensitive. (default true)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- archive:
      artifacts: \(aq*.tar.gz\(aq
      allow\-empty: \(aqtrue\(aq
      fingerprint: true
      default\-excludes: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B artifact\-deployer()
This plugin makes it possible to copy artifacts to remote locations.
.sp
Requires the Jenkins \fI\%ArtifactDeployer Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBentries\fP (\fIlist\fP) \-\- .INDENT 2.0
.TP
.B entries
.INDENT 7.0
.IP \(bu 2
\fBfiles\fP (\fIstr\fP) \- files to deploy
.IP \(bu 2
\fBbasedir\fP (\fIstr\fP) \- the dir from files are deployed
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \- the mask to exclude files
.IP \(bu 2
\fBremote\fP (\fIstr\fP) \- a remote output directory
.IP \(bu 2
\fBflatten\fP (\fIbool\fP) \- ignore the source directory structure
(default false)
.IP \(bu 2
\fBdelete\-remote\fP (\fIbool\fP) \- clean\-up remote directory
before deployment (default false)
.IP \(bu 2
\fBdelete\-remote\-artifacts\fP (\fIbool\fP) \- delete remote artifacts
when the build is deleted (default false)
.IP \(bu 2
\fBfail\-no\-files\fP (\fIbool\fP) \- fail build if there are no files
(default false)
.IP \(bu 2
\fBgroovy\-script\fP (\fIstr\fP) \- execute a Groovy script
before a build is deleted
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdeploy\-if\-fail\fP (\fIbool\fP) \-\- Deploy if the build is failed (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- artifact\-deployer:
      entries:
        \- files: \(aq*.tar.gz\(aq
          basedir: \(aq/opt/data\(aq
          excludes: \(aq*tmp*\(aq
          remote: \(aq/home/test/\(aq
          flatten: true
          delete\-remote: true
          delete\-remote\-artifacts: true
          fail\-no\-files: true
          groovy\-script: \(aqprint 123\(aq
      deploy\-if\-fail: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B artifactory()
Uses/requires the Artifactory plugin to deploy artifacts to
Artifactory Server.
.sp
Requires the Jenkins \fI\%Artifactory Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- Artifactory server url (default \(aq\(aq)
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Artifactory user with permissions use for
connected to the selected Artifactory Server (default \(aq\(aq)
.IP \(bu 2
\fBrelease\-repo\-key\fP (\fIstr\fP) \-\- Release repository name (default \(aq\(aq)
.IP \(bu 2
\fBsnapshot\-repo\-key\fP (\fIstr\fP) \-\- Snapshots repository name (default \(aq\(aq)
.IP \(bu 2
\fBpublish\-build\-info\fP (\fIbool\fP) \-\- Push build metadata with artifacts
(default false)
.IP \(bu 2
\fBdiscard\-old\-builds\fP (\fIbool\fP) \-\- Remove older build info from Artifactory (default false)
.IP \(bu 2
\fBdiscard\-build\-artifacts\fP (\fIbool\fP) \-\- Remove older build artifacts from Artifactory (default false)
.IP \(bu 2
\fBeven\-if\-unstable\fP (\fIbool\fP) \-\- Deploy artifacts even when the build
is unstable (default false)
.IP \(bu 2
\fBrun\-checks\fP (\fIbool\fP) \-\- Run automatic license scanning check after the
build is complete (default false)
.IP \(bu 2
\fBinclude\-publish\-artifacts\fP (\fIbool\fP) \-\- Include the build\(aqs published
module artifacts in the license violation checks if they are
also used as dependencies for other modules in this build
(default false)
.IP \(bu 2
\fBpass\-identified\-downstream\fP (\fIbool\fP) \-\- When true, a build parameter
named ARTIFACTORY_BUILD_ROOT with a value of
${JOB_NAME}\-${BUILD_NUMBER} will be sent to downstream builds
(default false)
.IP \(bu 2
\fBlicense\-auto\-discovery\fP (\fIbool\fP) \-\- Tells Artifactory not to try
and automatically analyze and tag the build\(aqs dependencies
with license information upon deployment (default true)
.IP \(bu 2
\fBenable\-issue\-tracker\-integration\fP (\fIbool\fP) \-\- When the Jenkins
JIRA plugin is enabled, synchronize information about JIRA
issues to Artifactory and attach issue information to build
artifacts (default false)
.IP \(bu 2
\fBaggregate\-build\-issues\fP (\fIbool\fP) \-\- When the Jenkins JIRA plugin
is enabled, include all issues from previous builds up to the
latest build status defined in \(dqAggregation Build Status\(dq
(default false)
.IP \(bu 2
\fBallow\-promotion\-of\-non\-staged\-builds\fP (\fIbool\fP) \-\- The build
promotion operation will be available to all successful builds
instead of only staged ones (default false)
.IP \(bu 2
\fBfilter\-excluded\-artifacts\-from\-build\fP (\fIbool\fP) \-\- Add the excluded
files to the excludedArtifacts list and remove them from the
artifacts list in the build info (default false)
.IP \(bu 2
\fBscopes\fP (\fIstr\fP) \-\- A list of dependency scopes/configurations to run
license violation checks on. If left empty all dependencies from
all scopes will be checked (default \(aq\(aq)
.IP \(bu 2
\fBviolation\-recipients\fP (\fIstr\fP) \-\- Recipients that need to be notified
of license violations in the build info (default \(aq\(aq)
.IP \(bu 2
\fBmatrix\-params\fP (\fIlist\fP) \-\- Semicolon\-separated list of properties to
attach to all deployed artifacts in addition to the default ones:
build.name, build.number, and vcs.revision (default [])
.IP \(bu 2
\fBblack\-duck\-app\-name\fP (\fIstr\fP) \-\- The existing Black Duck Code Center
application name (default \(aq\(aq)
.IP \(bu 2
\fBblack\-duck\-app\-version\fP (\fIstr\fP) \-\- The existing Black Duck Code Center
application version (default \(aq\(aq)
.IP \(bu 2
\fBblack\-duck\-report\-recipients\fP (\fIstr\fP) \-\- Recipients that will be emailed
a report after the automatic Black Duck Code Center compliance checks
finished (default \(aq\(aq)
.IP \(bu 2
\fBblack\-duck\-scopes\fP (\fIstr\fP) \-\- A list of dependency scopes/configurations
to run Black Duck Code Center compliance checks on. If left empty
all dependencies from all scopes will be checked (default \(aq\(aq)
.IP \(bu 2
\fBblack\-duck\-run\-checks\fP (\fIbool\fP) \-\- Automatic Black Duck Code Center
compliance checks will occur after the build completes
(default false)
.IP \(bu 2
\fBblack\-duck\-include\-published\-artifacts\fP (\fIbool\fP) \-\- Include the build\(aqs
published module artifacts in the license violation checks if they
are also used as dependencies for other modules in this build
(default false)
.IP \(bu 2
\fBauto\-create\-missing\-component\-requests\fP (\fIbool\fP) \-\- Auto create
missing components in Black Duck Code Center application after
the build is completed and deployed in Artifactory
(default true)
.IP \(bu 2
\fBauto\-discard\-stale\-component\-requests\fP (\fIbool\fP) \-\- Auto discard
stale components in Black Duck Code Center application after
the build is completed and deployed in Artifactory
(default true)
.IP \(bu 2
\fBdeploy\-artifacts\fP (\fIbool\fP) \-\- Push artifacts to the Artifactory
Server. Use deployment\-include\-patterns and
deployment\-exclude\-patterns to filter deploy artifacts. (default true)
.IP \(bu 2
\fBdeployment\-include\-patterns\fP (\fIlist\fP) \-\- New line or comma separated mappings
of build artifacts to published artifacts. Supports Ant\-style wildcards
mapping to target directories. E.g.: \fI/\fP\&.zip=>dir (default [])
.IP \(bu 2
\fBdeployment\-exclude\-patterns\fP (\fIlist\fP) \-\- New line or comma separated patterns
for excluding artifacts from deployment to Artifactory (default [])
.IP \(bu 2
\fBenv\-vars\-include\fP (\fIbool\fP) \-\- Include all environment variables
accessible by the build process. Jenkins\-specific env variables
are always included. Use env\-vars\-include\-patterns and
env\-vars\-exclude\-patterns to filter variables to publish,
(default false)
.IP \(bu 2
\fBenv\-vars\-include\-patterns\fP (\fIlist\fP) \-\- Comma or space\-separated list of
environment variables that will be included as part of the published
build info. Environment variables may contain the * and the ? wildcards
(default [])
.IP \(bu 2
\fBenv\-vars\-exclude\-patterns\fP (\fIlist\fP) \-\- Comma or space\-separated list of
environment variables that will be excluded from the published
build info (default [])
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- artifactory:
      url: http://artifactory.example.net/artifactory
      name: \(aqtest\(aq
      release\-repo\-key: libs\-release\-local
      snapshot\-repo\-key: libs\-snapshot\-local

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- artifactory:
      url: http://artifactory.example.net/artifactory
      name: \(aqtest\(aq
      release\-repo\-key: libs\-release\-local
      snapshot\-repo\-key: libs\-snapshot\-local
      publish\-build\-info: true
      discard\-old\-builds: true
      discard\-build\-artifacts: true
      even\-if\-unstable: true
      run\-checks: true
      include\-publish\-artifacts: true
      pass\-identified\-downstream: true
      license\-auto\-discovery: true
      aggregate\-build\-issues: true
      allow\-promotion\-of\-non\-staged\-builds: true
      filter\-excluded\-artifacts\-from\-build: true
      violation\-recipients: myfake@email.com
      matrix\-params: []
      black\-duck\-app\-name: myapp
      black\-duck\-app\-version: \(aq1.0\(aq
      black\-duck\-report\-recipients: myfake@email.com
      black\-duck\-scopes: []
      black\-duck\-run\-checks: true
      black\-duck\-include\-published\-artifacts: true
      auto\-create\-missing\-component\-requests: false
      auto\-discard\-stale\-component\-requests: false
      deploy\-artifacts: true
      deployment\-include\-patterns: []
      deployment\-exclude\-patterns: []
      env\-vars\-include: true
      env\-vars\-include\-patterns: []
      env\-vars\-exclude\-patterns: []

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B blame\-upstream()
Notify upstream committers when build fails
.sp
Requires the Jenkins \fI\%Blame Upstream Committers Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- blame\-upstream

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B build\-publisher()
This plugin allows records from one Jenkins to be published
on another Jenkins.
.sp
Requires the Jenkins \fI\%Build Publisher Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpublish\-unstable\-builds\fP (\fIbool\fP) \-\- publish unstable builds (default true)
.IP \(bu 2
\fBpublish\-failed\-builds\fP (\fIbool\fP) \-\- publish failed builds (default true)
.IP \(bu 2
\fBdays\-to\-keep\fP (\fIint\fP) \-\- days to keep when publishing results (optional)
.IP \(bu 2
\fBnum\-to\-keep\fP (\fIint\fP) \-\- number of jobs to keep in the published results
(optional)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- build\-publisher

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- build\-publisher:
      publish\-unstable\-builds: false
      publish\-failed\-builds: false
      days\-to\-keep: \-1
      num\-to\-keep: 100

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B campfire()
Send build notifications to Campfire rooms.
Requires the Jenkins \fI\%Campfire Plugin\fP\&.
.sp
Campfire notifications global default values must be configured for
the Jenkins instance. Default values will be used if no specific
values are specified for each job, so all config params are optional.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsubdomain\fP (\fIstr\fP) \-\- override the default campfire subdomain
.IP \(bu 2
\fBtoken\fP (\fIstr\fP) \-\- override the default API token
.IP \(bu 2
\fBssl\fP (\fIbool\fP) \-\- override the default \(aquse SSL\(aq
.IP \(bu 2
\fBroom\fP (\fIstr\fP) \-\- override the default room name
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- campfire:
        subdomain: \(aqsub\(aq
        ssl: true
        token: \(aqTOKEN\(aq
        room: \(aqroom\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B checkstyle()
Publish trend reports with Checkstyle.
.sp
Requires the Jenkins Checkstyle Plugin
(\fI\%https://github.com/jenkinsci/checkstyle\-plugin\fP).
.sp
The checkstyle component accepts a dictionary with the
following values:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- Report filename pattern (default \(aq\(aq)
.IP \(bu 2
\fBcan\-run\-on\-failed\fP (\fIbool\fP) \-\- Also runs for failed builds, instead of just
stable or unstable builds (default false)
.IP \(bu 2
\fBshould\-detect\-modules\fP (\fIbool\fP) \-\- Determines if Ant or Maven modules should
be detected for all files that contain warnings (default false)
.IP \(bu 2
\fBhealthy\fP (\fIint\fP) \-\- Sunny threshold (default \(aq\(aq)
.IP \(bu 2
\fBunhealthy\fP (\fIint\fP) \-\- Stormy threshold (default \(aq\(aq)
.IP \(bu 2
\fBhealth\-threshold\fP (\fIstr\fP) \-\- Threshold priority for health status
(\(aqlow\(aq, \(aqnormal\(aq or \(aqhigh\(aq) (default \(aqlow\(aq)
.IP \(bu 2
\fBthresholds\fP (\fIdict\fP) \-\- 
.sp
Mark build as failed or unstable if the number of
errors exceeds a threshold. (optional)
.INDENT 2.0
.TP
.B thresholds
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBunstable\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unstable
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfailed\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B failed
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdefault\-encoding\fP (\fIstr\fP) \-\- Encoding for parsing or showing files
(default \(aq\(aq)
.IP \(bu 2
\fBdo\-not\-resolve\-relative\-paths\fP (\fIbool\fP) \-\- (default false)
.IP \(bu 2
\fBdont\-compute\-new\fP (\fIbool\fP) \-\- If set to false, computes new warnings based on
the reference build (default true)
.IP \(bu 2
\fBuse\-previous\-build\-as\-reference\fP (\fIbool\fP) \-\- determines whether to always
use the previous build as the reference build (default false)
.IP \(bu 2
\fBuse\-stable\-build\-as\-reference\fP (\fIbool\fP) \-\- The number of new warnings will be
calculated based on the last stable build, allowing reverts of unstable
builds where the number of warnings was decreased. (default false)
.IP \(bu 2
\fBuse\-delta\-values\fP (\fIbool\fP) \-\- If set then the number of new warnings is
calculated by subtracting the total number of warnings of the current
build from the reference build. (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
 \- checkstyle:
    pattern: \(aq**/checkstyle\-result.xml\(aq
    healthy: 0
    unhealthy: 100
    health\-threshold: \(aqhigh\(aq
    thresholds:
        unstable:
            total\-high: 10
        failed:
            total\-high: 1

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
 \- checkstyle:
    pattern: \(aq**/checkstyle\-result.xml\(aq
    can\-run\-on\-failed: true
    should\-detect\-modules: true
    healthy: 0
    unhealthy: 100
    health\-threshold: \(aqhigh\(aq
    thresholds:
        unstable:
            total\-all: 90
            total\-high: 80
            total\-normal: 70
            total\-low: 60
            new\-all: 50
            new\-high: 40
            new\-normal: 30
            new\-low: 20
        failed:
            total\-all: 91
            total\-high: 81
            total\-normal: 71
            total\-low: 61
            new\-all: 51
            new\-high: 41
            new\-normal: 31
            new\-low: 21
    default\-encoding: \(aqutf\-8\(aq
    do\-not\-resolve\-relative\-paths: true
    dont\-compute\-new: false
    use\-stable\-build\-as\-reference: true
    use\-delta\-values: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B chuck\-norris()
Displays a picture of Chuck Norris (instead of Jenkins the butler) and a
random Chuck Norris \(aqThe Programmer\(aq fact on each build page.
.sp
Requires the Jenkins \fI\%ChuckNorris Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- chuck\-norris

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cifs()
Upload files via CIFS.
Requires the Jenkins \fI\%Publish over CIFS Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fIstr\fP) \-\- name of the cifs site/share (required)
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- destination directory (required)
.IP \(bu 2
\fBtarget\-is\-date\-format\fP (\fIbool\fP) \-\- whether target is a date format. If true,
raw text should be quoted (default false)
.IP \(bu 2
\fBclean\-remote\fP (\fIbool\fP) \-\- should the remote directory be deleted before
transferring files (default false)
.IP \(bu 2
\fBsource\fP (\fIstr\fP) \-\- source path specifier (required)
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \-\- excluded file pattern (default \(aq\(aq)
.IP \(bu 2
\fBremove\-prefix\fP (\fIstr\fP) \-\- prefix to remove from uploaded file paths
(default \(aq\(aq)
.IP \(bu 2
\fBfail\-on\-error\fP (\fIbool\fP) \-\- fail the build if an error occurs (default false).
.IP \(bu 2
\fBflatten\fP (\fIbool\fP) \-\- only create files on the server, don\(aqt create
directories (default false).
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- adds lots of detail useful for debug to the console
but generally should be left off (default false)
.IP \(bu 2
\fBretries\fP (\fIint\fP) \-\- the number of times to retry this server in the event of
failure (optional)
.IP \(bu 2
\fBretry\-delay\fP (\fIint\fP) \-\- the time to wait, in milliseconds, before attempting
another transfer (default 10000)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cifs:
      site: \(aqcifs.share\(aq
      target: \(aqdest/dir\(aq
      source: \(aqbase/source/dir/**\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cifs:
      site: \(aqcifs.share\(aq
      target: \(dq\(aqdest/dir/\(aqyyyyMMddHHmmss\(dq
      target\-is\-date\-format: true
      clean\-remote: true
      source: \(aqbase/source/dir/**\(aq
      excludes: \(aq**/*.excludedfiletype\(aq
      remove\-prefix: \(aqbase/source/dir\(aq
      fail\-on\-error: true
      flatten: true
      verbose: true
      retries: 99
      retry\-delay: 12345

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cigame()
This plugin introduces a game where users get points
for improving the builds.
Requires the Jenkins Continuous Integration Game
plugin (\fI\%https://github.com/jenkinsci/ci\-game\-plugin\fP).
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cigame

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B claim\-build()
Claim build failures
Requires the Jenkins \fI\%Claim Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- claim\-build

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B clamav()
Check files with ClamAV, an open source antivirus engine.
Requires the Jenkins \fI\%ClamAV Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBincludes\fP (\fIstr\fP) \-\- Comma separated list of files that should be scanned.
Must be set for ClamAV to check for artifacts. (default \(aq\(aq)
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \-\- Comma separated list of files that should be ignored
(default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- clamav:
      includes: \(aq*.zip\(aq
      excludes: \(aqfoo.zip\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- clamav

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B clone\-workspace()
Archive the workspace from builds of one project and reuse them as the SCM
source for another project.
Requires the Jenkins \fI\%Clone Workspace SCM Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBworkspace\-glob\fP (\fIstr\fP) \-\- Files to include in cloned workspace (default \(aq\(aq)
.IP \(bu 2
\fBworkspace\-exclude\-glob\fP (\fIstr\fP) \-\- Files to exclude from cloned workspace
.IP \(bu 2
\fBcriteria\fP (\fIstr\fP) \-\- Criteria for build to be archived.  Can be \(aqany\(aq,
\(aqnot failed\(aq, or \(aqsuccessful\(aq. (default \(aqany\(aq)
.IP \(bu 2
\fBarchive\-method\fP (\fIstr\fP) \-\- Choose the method to use for archiving the
workspace.  Can be \(aqtar\(aq or \(aqzip\(aq.  (default \(aqtar\(aq)
.IP \(bu 2
\fBoverride\-default\-excludes\fP (\fIbool\fP) \-\- Override default ant excludes.
(default false)
.UNINDENT
.UNINDENT
.sp
Minimal example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- clone\-workspace

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- clone\-workspace:
      criteria: \(dqAny\(dq
      archive\-method: \(dqTAR\(dq
      override\-default\-excludes: false
      workspace\-glob: \(dq**/*.zip\(dq
      workspace\-exclude\-glob: \(dq**/*.tgz\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cloudfoundry()
Pushes a project to Cloud Foundry or a CF\-based platform (e.g. Stackato) at
the end of a build. Requires the Jenkins \fI\%Cloud Foundry
Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- The API endpoint of the platform you want to push to.
This is the URL you use to access the platform, possibly with \(dq.api\(dq
added. (required)
.IP \(bu 2
\fBorganization\fP (\fIstr\fP) \-\- An org is a development account that an individual
or multiple collaborators can own and use (required)
.IP \(bu 2
\fBspace\fP (\fIstr\fP) \-\- Provide users with access to a shared location for
application development, deployment, and maintenance (required)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- credentials\-id of the user (required)
.IP \(bu 2
\fBself\-signed\fP (\fIbool\fP) \-\- Allow self\-signed SSL certificates from the target
(default false)
.IP \(bu 2
\fBreset\-app\fP (\fIbool\fP) \-\- Delete app before pushing app\(aqs configurations
(default false)
.IP \(bu 2
\fBplugin\-timeout\fP (\fIint\fP) \-\- The time in seconds before the Cloud Foundry
plugin stops fetching logs and marks the build a failure (default 120)
.IP \(bu 2
\fBcreate\-services\fP (\fIlist\fP) \-\- 
.sp
Create services automatically (default \(aq\(aq)
.INDENT 2.0
.TP
.B create\-services
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\(aqstr\(aq) \-\- Service name (default \(aq\(aq)
.IP \(bu 2
\fBtype\fP (\(aqstr\(aq) \-\- Service type (default \(aq\(aq)
.IP \(bu 2
\fBplan\fP (\(aqstr\(aq) \-\- Service plan (default \(aq\(aq)
.IP \(bu 2
.INDENT 2.0
.TP
\fBreset\-service\fP (\(aqbool\(aq) \-\- Delete the service before creating
the new one (default false)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBvalue\fP (\fIstr\fP) \-\- Select to read configuration from manifest file or to enter
configuration in Jenkins (default \(aqmanifestFile\(aq)
.IP \(bu 2
\fBmanifest\-file\fP (\fIstr\fP) \-\- Path to manifest file (default \(aqmanifest.yml\(aq)
.IP \(bu 2
\fBapp\-name\fP (\fIstr\fP) \-\- The application\(aqs name. Default to Jenkins build name.
(default \(aq\(aq)
.IP \(bu 2
\fBmemory\fP (\fIint\fP) \-\- The application\(aqs memory usage in MB (default 512)
.IP \(bu 2
\fBhost\-name\fP (\fIstr\fP) \-\- The hostname of the URI to access your application.
Default to app\-name (default \(aq\(aq)
.IP \(bu 2
\fBinstances\fP (\fIint\fP) \-\- Number of instances of your application on creation
(default 1)
.IP \(bu 2
\fBmanifest\-timeout\fP (\fIint\fP) \-\- The time in seconds before the health\-manager
gives up on starting the application (default 60)
.IP \(bu 2
\fBno\-route\fP (\fIbool\fP) \-\- No URI path will be created to access the application
(default false)
.IP \(bu 2
\fBapp\-path\fP (\fIstr\fP) \-\- Path to application (default \(aq\(aq)
.IP \(bu 2
\fBbuild\-pack\fP \-\- If your application requires a custom buildpack, you can
use this to specify its URL or name (default \(aq\(aq)
.IP \(bu 2
\fBstack\fP (\fIstr\fP) \-\- If your application requires a custom stack, you can use
this to specify its name. (default \(aq\(aq)
.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- Set a custom start command for your application
(default \(aq\(aq)
.IP \(bu 2
\fBdomain\fP (\fIstr\fP) \-\- The domain of the URI to access your application
(default \(aq\(aq)
.IP \(bu 2
\fBenvironment\-variables\fP (\fIlist\fP) \-\- 
.sp
Inject environment variables
.INDENT 2.0
.TP
.B environment\-variables
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\(aqstr\(aq) \-\- Environment variable key (default \(aq\(aq)
.IP \(bu 2
\fBvalue\fP (\(aqstr\(aq) \-\- Environment variable value (default \(aq\(aq)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBservices\-names\fP (\fIlist\fP) \-\- 
.sp
Name of service instances
.INDENT 2.0
.TP
.B services\-names
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\(aqstr\(aq) \-\- Name of the service instance (default \(aq\(aq)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cloudfoundry:
      target: https://api.stackato\-rkw2.local
      organization: AS
      space: SimpleSpace
      credentials\-id: j89jk213

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cloudfoundry:
      target: https://api.stackato\-rkw2.local
      organization: AS
      space: SimpleSpace
      credentials\-id: 123
      self\-signed: true
      reset\-app: true
      timeout: 240
      create\-services:
        \- name: foo\-name
          type: foo\-type
          plan: plan1
          reset\-service: true
        \- name: bar\-name
          type: bar\-type
          plan: plan2
          reset\-service: false
      value: jenkinsConfig
      manifest\-file: manifest.yml
      app\-name: cloudfoundry
      memory: 1024
      host\-name: cloudfoundry
      instances: 5
      manifest\-timeout: 120
      no\-route: true
      app\-path: foo
      build\-pack: custom\-buildpack
      stack: custom\-stack
      command: start
      domain: cloudfoundry.domain
      environment\-variables:
        \- key: key
          value: value
        \- key: key2
          value: value2
      services\-names:
        \- name: service\-name
        \- name: service\-name2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cloudformation()
Create cloudformation stacks before running a build and optionally
delete them at the end.  Requires the Jenkins \fI\%AWS
Cloudformation Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcreate\-stacks\fP (\fIlist\fP) \-\- 
.sp
List of stacks to create
.INDENT 2.0
.TP
.B create\-stacks attributes
.INDENT 7.0
.IP \(bu 2
\fBarg str name\fP \- The name of the stack (Required)
.IP \(bu 2
\fBarg str description\fP \- Description of the stack (Optional)
.IP \(bu 2
\fBarg str recipe\fP \- The cloudformation recipe file (Required)
.IP \(bu 2
\fBarg list parameters\fP \- A list of key/value pairs, will be
joined together into a comma separated string (Optional)
.IP \(bu 2
\fBarg int timeout\fP \- Number of seconds to wait before giving up
creating a stack (default 0)
.IP \(bu 2
\fBarg str access\-key\fP \- The Amazon API Access Key (Required)
.IP \(bu 2
\fBarg str secret\-key\fP \- The Amazon API Secret Key (Required)
.IP \(bu 2
\fBarg int sleep\fP \- Number of seconds to wait before continuing
to the next step (default 0)
.IP \(bu 2
\fBarg array region\fP \- The region to run cloudformation in.
(Required)
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B region values
.INDENT 7.0
.IP \(bu 2
\fBus\-east\-1\fP
.IP \(bu 2
\fBus\-west\-1\fP
.IP \(bu 2
\fBus\-west\-2\fP
.IP \(bu 2
\fBeu\-central\-1\fP
.IP \(bu 2
\fBeu\-west\-1\fP
.IP \(bu 2
\fBap\-southeast\-1\fP
.IP \(bu 2
\fBap\-southeast\-2\fP
.IP \(bu 2
\fBap\-northeast\-1\fP
.IP \(bu 2
\fBsa\-east\-1\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdelete\-stacks\fP (\fIlist\fP) \-\- 
.sp
List of stacks to delete
.INDENT 2.0
.TP
.B delete\-stacks attributes
.INDENT 7.0
.IP \(bu 2
\fBarg list name\fP \- The names of the stacks to delete (Required)
.IP \(bu 2
\fBarg str access\-key\fP \- The Amazon API Access Key (Required)
.IP \(bu 2
\fBarg str secret\-key\fP \- The Amazon API Secret Key (Required)
.IP \(bu 2
\fBarg bool prefix\fP \- If selected the tear down process will look
for the stack that Starts with the stack name with the oldest
creation date and will delete it.  (default false)
.IP \(bu 2
\fBarg array region\fP \- The region to run cloudformation in.
(Required)
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B region values
.INDENT 7.0
.IP \(bu 2
\fBus\-east\-1\fP
.IP \(bu 2
\fBus\-west\-1\fP
.IP \(bu 2
\fBus\-west\-2\fP
.IP \(bu 2
\fBeu\-central\-1\fP
.IP \(bu 2
\fBeu\-west\-1\fP
.IP \(bu 2
\fBap\-southeast\-1\fP
.IP \(bu 2
\fBap\-southeast\-2\fP
.IP \(bu 2
\fBap\-northeast\-1\fP
.IP \(bu 2
\fBsa\-east\-1\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cloudformation:
      create\-stacks:
        \- name: \(dqfoo\(dq
          description: \(dqBuild the foo stack\(dq
          recipe: \(dqfoo.json\(dq
          parameters:
            \- \(dqKey1=foo\(dq
            \- \(dqKey2=fuu\(dq
          timeout: 3600
          access\-key: \(dq$AWS_ACCESS_KEY\(dq
          secret\-key: \(dq$AWS_SECRET_KEY\(dq
          region: us\-west\-2
          sleep: 5
        \- name: \(dqbar\(dq
          description: \(dqBuild the bar stack\(dq
          recipe: \(dqbar.json\(dq
          parameters:
            \- \(dqKey1=bar\(dq
            \- \(dqKey2=baa\(dq
          timeout: 3600
          access\-key: \(dq$AWS_ACCESS_KEY\(dq
          secret\-key: \(dq$AWS_SECRET_KEY\(dq
          region: us\-west\-1
      delete\-stacks:
        \- name: \(dqfoo\(dq
          prefix: true
          region: us\-west\-2
          access\-key: \(dq$AWS_ACCESS_KEY\(dq
          secret\-key: \(dq$AWS_SECRET_KEY\(dq
        \- name: \(dqbar\(dq
          region: us\-west\-1
          access\-key: \(dq$AWS_ACCESS_KEY\(dq
          secret\-key: \(dq$AWS_SECRET_KEY\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cloverphp()
Capture code coverage reports from PHPUnit
Requires the Jenkins \fI\%Clover PHP Plugin\fP\&.
.sp
Your job definition should pass to PHPUnit the \-\-coverage\-clover option
pointing to a file in the workspace (ex: clover\-coverage.xml). The filename
has to be filled in the \fIxml\-location\fP field.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBxml\-location\fP (\fIstr\fP) \-\- Path to the coverage XML file generated by PHPUnit
using \-\-coverage\-clover. Relative to workspace. (required)
.IP \(bu 2
\fBhtml\fP (\fIdict\fP) \-\- 
.sp
When existent, whether the plugin should generate a HTML
report.  Note that PHPUnit already provide a HTML report via its
\-\-cover\-html option which can be set in your builder (optional):
.INDENT 2.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBdir\fP (str): Directory where HTML report will be generated relative
to workspace. (required in \fIhtml\fP dict).
.UNINDENT
.IP \(bu 2
\fBarchive\fP (bool): Whether to archive HTML reports (default true).
.UNINDENT

.IP \(bu 2
\fBmetric\-targets\fP (\fIlist\fP) \-\- 
.sp
List of metric targets to reach, must be one of
\fBhealthy\fP, \fBunhealthy\fP and \fBfailing\fP\&. Each metric target can
takes two parameters:
.INDENT 2.0
.IP \(bu 2
\fBmethod\fP  Target for method coverage
.IP \(bu 2
\fBstatement\fP Target for statements coverage
.UNINDENT
.sp
Whenever a metric target is not filled in, the Jenkins plugin can fill
in defaults for you (as of v0.3.3 of the plugin the healthy target will
have method: 70 and statement: 80 if both are left empty). Jenkins Job
Builder will mimic that feature to ensure clean configuration diff.

.UNINDENT
.UNINDENT
.sp
Minimal example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Test for the defaults, only xml\-location is required
publishers:
 \- cloverphp:
       xml\-location: \(aqbuild/clover.xml\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
# Exercise all options with non defaults values
publishers:
 \- cloverphp:
       xml\-location: \(aqbuild/clover.xml\(aq
       html:
         dir: \(aqhtml\(aq
         archive: false
       metric\-targets:
        \- healthy:
           method: 80
           statement: 90
        \- unhealthy:
           method: 40
           statement: 50
        \- failing:
           method: 10
           statement: 20

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cobertura()
Generate a cobertura coverage report.
Requires the Jenkins \fI\%Cobertura Coverage Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreport\-file\fP (\fIstr\fP) \-\- This is a file name pattern that can be used
to locate the cobertura xml report files (optional)
.IP \(bu 2
\fBonly\-stable\fP (\fIbool\fP) \-\- Include only stable builds (default false)
.IP \(bu 2
\fBfail\-no\-reports\fP (\fIbool\fP) \-\- fail builds if no coverage reports are found
(default false)
.IP \(bu 2
\fBfail\-unhealthy\fP (\fIbool\fP) \-\- Unhealthy projects will be failed (default false)
.IP \(bu 2
\fBfail\-unstable\fP (\fIbool\fP) \-\- Unstable projects will be failed (default false)
.IP \(bu 2
\fBhealth\-auto\-update\fP (\fIbool\fP) \-\- Auto update threshold for health on
successful build (default false)
.IP \(bu 2
\fBstability\-auto\-update\fP (\fIbool\fP) \-\- Auto update threshold for stability on
successful build (default false)
.IP \(bu 2
\fBzoom\-coverage\-chart\fP (\fIbool\fP) \-\- Zoom the coverage chart and crop area below
the minimum and above the maximum coverage of the past reports
(default false)
.IP \(bu 2
\fBsource\-encoding\fP (\fIstr\fP) \-\- Override the source encoding (default ASCII)
.IP \(bu 2
\fBtargets\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B targets
(packages, files, classes, method, line, conditional)
.INDENT 7.0
.IP \(bu 2
\fBhealthy\fP (\fIint\fP): Healthy threshold (default 0)
.IP \(bu 2
\fBunhealthy\fP (\fIint\fP): Unhealthy threshold (default 0)
.IP \(bu 2
\fBfailing\fP (\fIint\fP): Failing threshold (default 0)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cobertura:
      report\-file: \(dq/reports/cobertura/coverage.xml\(dq
      only\-stable: \(dqtrue\(dq
      fail\-no\-reports: \(dqtrue\(dq
      fail\-unhealthy: \(dqtrue\(dq
      fail\-unstable: \(dqtrue\(dq
      health\-auto\-update: \(dqtrue\(dq
      stability\-auto\-update: \(dqtrue\(dq
      zoom\-coverage\-chart: \(dqtrue\(dq
      source\-encoding: \(dqBig5\(dq
      targets:
        \- files:
            healthy: 10
            unhealthy: 20
            failing: 30
        \- method:
            healthy: 50
            unhealthy: 40
            failing: 30

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B codecover()
This plugin allows you to capture code coverage report from CodeCover.
Jenkins will generate the trend report of coverage.
Requires the Jenkins \fI\%CodeCover Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinclude\fP (\fIstr\fP) \-\- Specify the path to the CodeCover HTML report file,
relative to the workspace root (default \(aq\(aq)
.IP \(bu 2
\fBmin\-statement\fP (\fIint\fP) \-\- Minimum statement threshold (default 0)
.IP \(bu 2
\fBmax\-statement\fP (\fIint\fP) \-\- Maximum statement threshold (default 90)
.IP \(bu 2
\fBmin\-branch\fP (\fIint\fP) \-\- Minimum branch threshold (default 0)
.IP \(bu 2
\fBmax\-branch\fP (\fIint\fP) \-\- Maximum branch threshold (default 80)
.IP \(bu 2
\fBmin\-loop\fP (\fIint\fP) \-\- Minimum loop threshold (default 0)
.IP \(bu 2
\fBmax\-loop\fP (\fIint\fP) \-\- Maximum loop threshold (default 50)
.IP \(bu 2
\fBmin\-condition\fP (\fIint\fP) \-\- Minimum condition threshold (default 0)
.IP \(bu 2
\fBmax\-condition\fP (\fIint\fP) \-\- Maximum conditon threshold (default 50)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- codecover

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- codecover:
      include: ./path/report.html
      min\-statement: 1
      max\-statement: 100
      min\-branch: 2
      max\-branch: 90
      min\-loop: 3
      max\-loop: 80
      min\-condition: 4
      max\-condition: 70

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B conditional\-publisher()
Conditionally execute some post\-build steps. Requires the Jenkins
\fI\%Flexible Publish Plugin\fP\&.
.sp
A Flexible Publish list of Conditional Actions is created in Jenkins.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcondition\-kind\fP (\fIstr\fP) \-\- Condition kind that must be verified before the
action is executed. Valid values and their additional attributes are
described in the \fI\%conditions\fP table.
.IP \(bu 2
\fBcondition\-aggregation\fP (\fIbool\fP) \-\- If true Matrix Aggregation will be
enabled. (default false)
.IP \(bu 2
\fBcondition\-aggregation\-kind\fP (\fIstr\fP) \-\- Condition Aggregation kind that
must be verified before the
action is executed. Valid values and their additional attributes are
described in the \fI\%conditions\fP table.
.IP \(bu 2
\fBon\-evaluation\-failure\fP (\fIstr\fP) \-\- What should be the outcome of the build
if the evaluation of the condition fails. Possible values are \fIfail\fP,
\fImark\-unstable\fP, \fIrun\-and\-mark\-unstable\fP, \fIrun\fP and \fIdont\-run\fP\&.
Default is \fIfail\fP\&.
.IP \(bu 2
\fBaction\fP (\fIlist\fP) \-\- Action to run if the condition is verified. Item
can be any publisher known by Jenkins Job Builder and supported
by the Flexible Publish Plugin.
.UNINDENT
.UNINDENT
.TS
center;
|l|l|.
_
T{
Condition kind
T}	T{
Description
T}
_
T{
always
T}	T{
Condition is always verified
T}
_
T{
never
T}	T{
Condition is never verified
T}
_
T{
boolean\-expression
T}	T{
Run the action if the expression expands to a
representation of true
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-expression
Expression to expand
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
current\-status
T}	T{
Run the action if the current build status is
within the configured range
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-worst
Accepted values are SUCCESS,
UNSTABLE, FAILURE, NOT_BUILD, ABORTED
.TP
.B condition\-best
Accepted values are SUCCESS,
UNSTABLE, FAILURE, NOT_BUILD, ABORTED
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
shell
T}	T{
Run the action if the shell command succeeds
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-command
Shell command to execute
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
windows\-shell
T}	T{
Similar to shell, except that commands will be
executed by cmd, under Windows
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-command
Command to execute
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
regexp
T}	T{
Run the action if a regular expression matches
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-expression
Regular Expression
.TP
.B condition\-searchtext
Text to match against
the regular expression
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
file\-exists
T}	T{
Run the action if a file exists
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B condition\-filename
Check existence of this file
.TP
.B condition\-basedir
If condition\-filename is
relative, it will be considered relative to
either \fIworkspace\fP, \fIartifact\-directory\fP,
or \fIjenkins\-home\fP\&. Default is \fIworkspace\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
Single Conditional Action Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- conditional\-publisher:
        \- condition\-kind: current\-status
          condition\-worst: FAILURE
          condition\-best: SUCCESS
          action:
              \- archive:
                  artifacts: \(aq**/**\(aq
                  allow\-empty: \(aqtrue\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Multiple Conditional Actions Example
(includes example of multiple actions per condition which requires
v0.13 or higher of the Flexible Publish plugin):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- conditional\-publisher:
        \- condition\-kind: always
          on\-evaluation\-failure: run\-and\-mark\-unstable
          action:
              \- archive:
                  artifacts: \(aq**/**\(aq
                  allow\-empty: \(aqtrue\(aq
              \- aggregate\-tests:
                  include\-failed\-builds: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBMultiple Conditional Actions Example for pre\-v0.13 versions\fP
.UNINDENT
.INDENT 0.0
.TP
.B copy\-to\-master()
Copy files to master from slave.
.sp
Requires the Jenkins \fI\%Copy To Slave Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBincludes\fP (\fIlist\fP) \-\- list of file patterns to copy
.IP \(bu 2
\fBexcludes\fP (\fIlist\fP) \-\- list of file patterns to exclude
.IP \(bu 2
\fBdestination\fP (\fIstr\fP) \-\- absolute path into which the files will be copied.
If left blank they will be copied into the workspace of the current job
(default \(aq\(aq)
.IP \(bu 2
\fBrun\-after\-result\fP (\fIbool\fP) \-\- If this is checked then copying files back to
master will not run until the build result is finalized.(default true)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- copy\-to\-master:
      includes:
        \- file1
        \- file2*.txt
      excludes:
        \- file2bad.txt

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B coverage()
WARNING: The coverage function is deprecated. Instead, use the
cobertura function to generate a cobertura coverage report.
Requires the Jenkins \fI\%Cobertura Coverage Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- coverage

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cppcheck()
Cppcheck result publisher
Requires the Jenkins \fI\%Cppcheck Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- File pattern for cppcheck xml report (required)
.IP \(bu 2
\fBignoreblankfiles\fP (\fIbool\fP) \-\- Ignore blank files (default false)
.IP \(bu 2
\fBallow\-no\-report\fP (\fIbool\fP) \-\- Do not fail the build if the Cppcheck report
is not found (default false)
.IP \(bu 2
\fBthresholds\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B thresholds
Configure the build status and health. A build is
considered as unstable or failure if the new or total number
of issues exceeds the specified thresholds. The build health
is also determined by thresholds. If the actual number of issues
is between the provided thresholds, then the build health is
interpolated.
.UNINDENT
.INDENT 2.0
.IP \(bu 2
\fBunstable\fP (\fIstr\fP): Total number unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBnew\-unstable\fP (\fIstr\fP): New number unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBfailure\fP (\fIstr\fP): Total number failure threshold (default \(aq\(aq)
.IP \(bu 2
\fBnew\-failure\fP (\fIstr\fP): New number failure threshold (default \(aq\(aq)
.IP \(bu 2
\fBhealthy\fP (\fIstr\fP): Healthy threshold (default \(aq\(aq)
.IP \(bu 2
\fBunhealthy\fP (\fIstr\fP): Unhealthy threshold (default \(aq\(aq)
.UNINDENT

.IP \(bu 2
\fBseverity\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B severity
Determines which severity of issues should be considered
when evaluating the build status and health, default all true
.UNINDENT
.INDENT 2.0
.IP \(bu 2
\fBerror\fP (\fIbool\fP): Severity error (default true)
.IP \(bu 2
\fBwarning\fP (\fIbool\fP): Severity warning (default true)
.IP \(bu 2
\fBstyle\fP (\fIbool\fP): Severity style (default true)
.IP \(bu 2
\fBperformance\fP (\fIbool\fP): Severity performance (default true)
.IP \(bu 2
\fBinformation\fP (\fIbool\fP): Severity information (default true)
.IP \(bu 2
\fBnocategory\fP (\fIbool\fP): Severity nocategory (default true)
.IP \(bu 2
\fBportability\fP (\fIbool\fP): Severity portability (default true)
.UNINDENT

.IP \(bu 2
\fBgraph\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B graph
Graph configuration
.UNINDENT
.INDENT 2.0
.IP \(bu 2
\fBxysize\fP (\fIarray\fP): Chart width and height (default [500, 200])
.IP \(bu 2
\fBnum\-builds\-in\-graph\fP (\fIint\fP): Builds number in graph (default 0)
.UNINDENT

.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B :arg dict display
.INDENT 7.0
.TP
.B display
which errors to display, default only sum
.UNINDENT
.INDENT 7.0
.IP \(bu 2
\fBsum\fP (\fIbool\fP): Display sum of all issues (default true)
.IP \(bu 2
\fBerror\fP (\fIbool\fP): Display errors (default false)
.IP \(bu 2
\fBwarning\fP (\fIbool\fP): Display warnings (default false)
.IP \(bu 2
\fBstyle\fP (\fIbool\fP): Display style (default false)
.IP \(bu 2
\fBperformance\fP (\fIbool\fP): Display performance (default false)
.IP \(bu 2
\fBinformation\fP (\fIbool\fP): Display information (default false)
.IP \(bu 2
\fBnocategory\fP (\fIbool\fP): Display no category (default false)
.IP \(bu 2
\fBportability\fP (\fIbool\fP): Display portability (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cppcheck:
      pattern: \(dq**/cppcheck.xml\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cppcheck:
      pattern: \(dq**/cppcheck.xml\(dq
      # the rest is optional
      ignoreblankfiles: true
      allow\-no\-report: true
      # build status (new) error count thresholds
      thresholds:
        unstable: 5
        new\-unstable: 5
        failure: 7
        new\-failure: 3
        healthy: 5
        unhealthy: 10
        # severities which count towards the threshold, default all true
        severity:
          error: false
          warning: false
          style: false
          performance: false
          information: false
          nocategory: false
          portability: false
      graph:
        xysize: [600, 300]
        num\-builds\-in\-graph: 10
        # which errors to display, default only sum
        display:
          sum: false
          error: true
          warning: true
          style: true
          performance: true
          information: true
          nocategory: true
          portability: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cucumber\-reports()
This plugin creates pretty cucumber\-jvm html reports on jenkins.
.sp
Requires the Jenkins \fI\%cucumber reports\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBjson\-reports\-path\fP (\fIstr\fP) \-\- The path relative to the workspace of
the json reports generated by cucumber\-jvm e.g. target \- leave
empty to scan the whole workspace (default \(aq\(aq)
.IP \(bu 2
\fBfile\-include\-pattern\fP (\fIstr\fP) \-\- Include pattern (default \(aq\(aq)
.IP \(bu 2
\fBfile\-exclude\-pattern\fP (\fIstr\fP) \-\- Exclude pattern (default \(aq\(aq)
.IP \(bu 2
\fBplugin\-url\-path\fP (\fIstr\fP) \-\- The path to the jenkins user content url
e.g. \fBhttp://host:port[/jenkins/]plugin\fP \- leave empty if jenkins
url root is host:port (default \(aq\(aq)
.IP \(bu 2
\fBskipped\-fails\fP (\fIbool\fP) \-\- Skipped steps to cause the build to fail
(default false)
.IP \(bu 2
\fBpending\-fails\fP (\fIbool\fP) \-\- Pending steps to cause the build to fail
(default false)
.IP \(bu 2
\fBundefined\-fails\fP (\fIbool\fP) \-\- Undefined steps to cause the build to fail
(default false)
.IP \(bu 2
\fBmissing\-fails\fP (\fIbool\fP) \-\- Missing steps to cause the build to fail
(default false)
.IP \(bu 2
\fBno\-flash\-charts\fP (\fIbool\fP) \-\- Use javascript charts instead of flash charts
(default false)
.IP \(bu 2
\fBignore\-failed\-tests\fP (\fIbool\fP) \-\- Entire build to fail when these tests fail
(default false)
.IP \(bu 2
\fBparallel\-testing\fP (\fIbool\fP) \-\- Run same test in parallel for multiple devices
(default false)
.IP \(bu 2
\fBfailed\-steps\-number\fP (\fIint\fP) \-\- Maximum number of failed steps above which
build result is changed (default 0)
.IP \(bu 2
\fBskipped\-steps\-number\fP (\fIint\fP) \-\- Maximum number of skipped steps above which
build result is changed (default 0)
.IP \(bu 2
\fBpending\-steps\-number\fP (\fIint\fP) \-\- Maximum number of pending steps above which
build result is changed (default 0)
.IP \(bu 2
\fBundefined\-steps\-number\fP (\fIint\fP) \-\- Maximum number of undefined steps above
which build result is changed (default 0)
.IP \(bu 2
\fBfailed\-scenarios\-number\fP (\fIint\fP) \-\- Maximum number of failed scenarios above
which build result is changed (default 0)
.IP \(bu 2
\fBfailed\-features\-number\fP (\fIint\fP) \-\- Maximum number of failed features above
which build result is changed (default 0)
.IP \(bu 2
\fBbuild\-status\fP (\fIlist\fP) \-\- Build result to which the build should be set
when the report becomes failed or unstable (default \(aq\(aq)
.IP \(bu 2
\fBtrends\-limit\fP (\fIint\fP) \-\- Number of past reports that should be presented.
Zero means unlimited number of builds (default 0)
.IP \(bu 2
\fBsorting\-method\fP (\fIlist\fP) \-\- Result sorting order (default \(aqNATURAL\(aq)
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cucumber\-reports:
      json\-reports\-path: path
      plugin\-url\-path: http://example.com/
      file\-include\-pattern: \(aq**/*.json\(aq
      file\-exclude\-pattern: badfile.txt
      skipped\-fails: true
      pending\-fails: true
      undefined\-fails: true
      missing\-fails: true
      no\-flash\-charts: true
      ignore\-failed\-tests: true
      parallel\-testing: true
      failed\-steps\-number: 1
      skipped\-steps\-number: 2
      pending\-steps\-number: 3
      undefined\-steps\-number: 4
      failed\-scenarios\-number: 5
      failed\-features\-number: 6
      build\-status: UNSTABLE
      trends\-limit: 7
      sorting\-method: ALPHABETICAL
      sorting\-values:
        \- key\-value\-pair:
            key: classification key 1
            value: classification value 1
        \- key\-value\-pair:
            key: classification key 2
            value: classification value 2

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- cucumber\-reports

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cucumber\-testresult()
Publish cucumber test results.
Requires the Jenkins \fI\%Cucumber testresult\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBresults\fP (\fIstr\fP) \-\- Results filename (required)
.IP \(bu 2
\fBignore\-bad\-steps\fP (\fIbool\fP) \-\- Ignore not existed step results (default false)
.UNINDENT
.UNINDENT
.sp
Minimal example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- cucumber\-testresult:
    results: nosetests.xml

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- cucumber\-testresult:
    results: nosetests.xml
    ignore\-bad\-steps: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dependency\-check()
Dependency\-Check is an open source utility that identifies project
dependencies and checks if there are any known, publicly disclosed,
vulnerabilities.
.sp
Requires the Jenkins \fI\%OWASP Dependency\-Check Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- Report filename pattern (optional)
.IP \(bu 2
\fBcan\-run\-on\-failed\fP (\fIbool\fP) \-\- Also runs for failed builds, instead of just
stable or unstable builds (default false)
.IP \(bu 2
\fBshould\-detect\-modules\fP (\fIbool\fP) \-\- Determines if Ant or Maven modules should
be detected for all files that contain warnings (default false)
.IP \(bu 2
\fBhealthy\fP (\fIint\fP) \-\- Sunny threshold (optional)
.IP \(bu 2
\fBunhealthy\fP (\fIint\fP) \-\- Stormy threshold (optional)
.IP \(bu 2
\fBhealth\-threshold\fP (\fIstr\fP) \-\- Threshold priority for health status
(\(aqlow\(aq, \(aqnormal\(aq or \(aqhigh\(aq, defaulted to \(aqlow\(aq)
.IP \(bu 2
\fBthresholds\fP (\fIdict\fP) \-\- 
.sp
Mark build as failed or unstable if the number of
errors exceeds a threshold. (optional)
.INDENT 2.0
.TP
.B thresholds
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBunstable\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unstable
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfailed\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B failed
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdefault\-encoding\fP (\fIstr\fP) \-\- Encoding for parsing or showing files (optional)
.IP \(bu 2
\fBdo\-not\-resolve\-relative\-paths\fP (\fIbool\fP) \-\- (default false)
.IP \(bu 2
\fBdont\-compute\-new\fP (\fIbool\fP) \-\- If set to false, computes new warnings based on
the reference build (default true)
.IP \(bu 2
\fBuse\-previous\-build\-as\-reference\fP (\fIbool\fP) \-\- determines whether to always
use the previous build as the reference build (default false)
.IP \(bu 2
\fBuse\-stable\-build\-as\-reference\fP (\fIbool\fP) \-\- The number of new warnings will be
calculated based on the last stable build, allowing reverts of unstable
builds where the number of warnings was decreased. (default false)
.IP \(bu 2
\fBuse\-delta\-values\fP (\fIbool\fP) \-\- If set then the number of new warnings is
calculated by subtracting the total number of warnings of the current
build from the reference build.
(default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- dependency\-check

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- dependency\-check:
      pattern: \(aq**/dependency\-check\-report.xml\(aq
      can\-run\-on\-failed: true
      should\-detect\-modules: true
      healthy: 0
      unhealthy: 100
      health\-threshold: \(aqhigh\(aq
      thresholds:
          unstable:
              total\-all: 90
              total\-high: 80
              total\-normal: 70
              total\-low: 60
              new\-all: 50
              new\-high: 40
              new\-normal: 30
              new\-low: 20
          failed:
              total\-all: 91
              total\-high: 81
              total\-normal: 71
              total\-low: 61
              new\-all: 51
              new\-high: 41
              new\-normal: 31
              new\-low: 21
      default\-encoding: \(aqutf\-8\(aq
      do\-not\-resolve\-relative\-paths: true
      dont\-compute\-new: false
      use\-previous\-build\-as\-reference: true
      use\-stable\-build\-as\-reference: true
      use\-delta\-values: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B description\-setter()
This plugin sets the description for each build,
based upon a RegEx test of the build log file.
.sp
Requires the Jenkins \fI\%Description Setter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBregexp\fP (\fIstr\fP) \-\- A RegEx which is used to scan the build log file
(default \(aq\(aq)
.IP \(bu 2
\fBregexp\-for\-failed\fP (\fIstr\fP) \-\- A RegEx which is used for failed builds
(default \(aq\(aq)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- The description to set on the build (optional)
.IP \(bu 2
\fBdescription\-for\-failed\fP (\fIstr\fP) \-\- The description to set on
the failed builds (optional)
.IP \(bu 2
\fBset\-for\-matrix\fP (\fIbool\fP) \-\- Also set the description on
a multi\-configuration build (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- description\-setter

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- description\-setter:
      regexp: \(dq.*(<a href=.*a>)\(dq
      regexp\-for\-failed: \(dq.*(<a href=.*a>)\(dq
      description: \(dqsome description\(dq
      description\-for\-failed: \(dqanother description\(dq
      set\-for\-matrix: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B disable\-failed\-job()
Automatically disable failed jobs.
.sp
Requires the Jenkins \fI\%Disable Failed Job Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBwhen\-to\-disable\fP (\fIstr\fP) \-\- 
.sp
The condition to disable the job. (required)
Possible values are
.INDENT 2.0
.IP \(bu 2
\fBOnly Failure\fP
.IP \(bu 2
\fBFailure and Unstable\fP
.IP \(bu 2
\fBUnstable\fP
.UNINDENT

.IP \(bu 2
\fBno\-of\-failures\fP (\fIint\fP) \-\- Number of consecutive failures to disable the
job. (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- disable\-failed\-job:
      when\-to\-disable: \(aqFailure and Unstable\(aq
      no\-of\-failures: 3

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B display\-upstream\-changes()
Display SCM changes of upstream jobs. Requires the Jenkins
\fI\%Display Upstream Changes Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- display\-upstream\-changes

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B docker\-stop\-container()
This plugin allows removing stopped docker containers.
It requires the \fI\%Docker build step plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBremove\-stopped\-containers\fP (\fIbool\fP) \-\- Boolean value to remove
stopped docker containers (default False)
.UNINDENT
.sp
Minimal Example:
\&.. literalinclude:: /../../tests/
publishers/fixtures/docker\-stop\-container\-minimal.yaml
.sp
Full Example:
\&.. literalinclude:: /../../tests/
publishers/fixtures/docker\-stop\-container\-full.yaml
.UNINDENT
.INDENT 0.0
.TP
.B downstream\-ext()
Trigger multiple downstream jobs when a job is completed and
condition is met.
.sp
Requires the Jenkins \fI\%Downstream\-Ext Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprojects\fP (\fIlist\fP) \-\- Projects to build (required)
.IP \(bu 2
\fBcondition\fP (\fIstr\fP) \-\- comparison condition used for the criteria.
One of \(aqequal\-or\-over\(aq, \(aqequal\-or\-under\(aq, \(aqequal\(aq
(default \(aqequal\-or\-over\(aq)
.IP \(bu 2
\fBcriteria\fP (\fIstr\fP) \-\- Trigger downstream job if build results meets
condition. One of \(aqsuccess\(aq, \(aqunstable\(aq, \(aqfailure\(aq or
\(aqaborted\(aq (default \(aqsuccess\(aq)
.IP \(bu 2
\fBonly\-on\-scm\-change\fP (\fIbool\fP) \-\- Trigger only if downstream project
has SCM changes (default false)
.IP \(bu 2
\fBonly\-on\-local\-scm\-change\fP (\fIbool\fP) \-\- Trigger only if current project
has SCM changes (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- downstream\-ext:
      projects:
        \- foo
        \- bar
      only\-on\-scm\-change: true
      criteria: unstable
      condition: equal

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B doxygen()
This plugin parses the Doxygen descriptor (Doxyfile) and provides a link to
the generated Doxygen documentation.
.sp
Requires the Jenkins \fI\%Doxygen Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdoxyfile\fP (\fIstr\fP) \-\- The doxyfile path (required)
.IP \(bu 2
\fBslave\fP (\fIstr\fP) \-\- The node or label to pull the doxygen HTML files from
(default \(aq\(aq)
.IP \(bu 2
\fBkeep\-all\fP (\fIbool\fP) \-\- Retain doxygen generation for each successful build
(default false)
.IP \(bu 2
\fBfolder\fP (\fIstr\fP) \-\- Folder where you run doxygen (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- doxygen:
      doxyfile: \(dqDoxyfile\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- doxygen:
      doxyfile: \(dqDoxyfile\(dq
      slave: \(dqdoxygen\-slave\(dq
      keep\-all: true
      folder: \(dqbuild\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dry()
Publish trend reports with DRY.
.sp
Requires the Jenkins DRY Plugin (\fI\%https://github.com/jenkinsci/dry\-plugin\fP).
.sp
The DRY component accepts a dictionary with the following values:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- Report filename pattern (default \(aq\(aq)
.IP \(bu 2
\fBcan\-run\-on\-failed\fP (\fIbool\fP) \-\- Also runs for failed builds, instead of just
stable or unstable builds (default false)
.IP \(bu 2
\fBshould\-detect\-modules\fP (\fIbool\fP) \-\- Determines if Ant or Maven modules should
be detected for all files that contain warnings (default false)
.IP \(bu 2
\fBhealthy\fP (\fIint\fP) \-\- Sunny threshold (default \(aq\(aq)
.IP \(bu 2
\fBunhealthy\fP (\fIint\fP) \-\- Stormy threshold (default \(aq\(aq)
.IP \(bu 2
\fBhealth\-threshold\fP (\fIstr\fP) \-\- Threshold priority for health status
(\(aqlow\(aq, \(aqnormal\(aq or \(aqhigh\(aq, defaulted to \(aqlow\(aq)
.IP \(bu 2
\fBhigh\-threshold\fP (\fIint\fP) \-\- Minimum number of duplicated lines for high
priority warnings. (default 50)
.IP \(bu 2
\fBnormal\-threshold\fP (\fIint\fP) \-\- Minimum number of duplicated lines for normal
priority warnings. (default 25)
.IP \(bu 2
\fBthresholds\fP (\fIdict\fP) \-\- 
.sp
Mark build as failed or unstable if the number of
errors exceeds a threshold. (default \(aq\(aq)
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B thresholds
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBunstable\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unstable
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfailed\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B failed
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdefault\-encoding\fP (\fIstr\fP) \-\- Encoding for parsing or showing files (optional)
.IP \(bu 2
\fBdo\-not\-resolve\-relative\-paths\fP (\fIbool\fP) \-\- (default false)
.IP \(bu 2
\fBdont\-compute\-new\fP (\fIbool\fP) \-\- If set to false, computes new warnings based on
the reference build (default true)
.IP \(bu 2
\fBuse\-previous\-build\-as\-reference\fP (\fIbool\fP) \-\- determines whether to always
use the previous build as the reference build (default false)
.IP \(bu 2
\fBuse\-stable\-build\-as\-reference\fP (\fIbool\fP) \-\- The number of new warnings will be
calculated based on the last stable build, allowing reverts of unstable
builds where the number of warnings was decreased. (default false)
.IP \(bu 2
\fBuse\-delta\-values\fP (\fIbool\fP) \-\- If set then the number of new warnings is
calculated by subtracting the total number of warnings of the current
build from the reference build. (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
 \- dry:
    pattern: \(aq**/cpd\-result.xml\(aq
    healthy: 0
    unhealthy: 100
    health\-threshold: \(aqhigh\(aq
    high\-threshold: 50
    normal\-threshold: 25
    thresholds:
        unstable:
            total\-high: 10
        failed:
            total\-high: 1

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
 \- dry:
    pattern: \(aq**/cpd\-result.xml\(aq
    can\-run\-on\-failed: true
    should\-detect\-modules: true
    healthy: 0
    unhealthy: 100
    health\-threshold: \(aqhigh\(aq
    high\-threshold: 20
    normal\-threshold: 10
    thresholds:
        unstable:
            total\-all: 90
            total\-high: 80
            total\-normal: 70
            total\-low: 60
            new\-all: 50
            new\-high: 40
            new\-normal: 30
            new\-low: 20
        failed:
            total\-all: 91
            total\-high: 81
            total\-normal: 71
            total\-low: 61
            new\-all: 51
            new\-high: 41
            new\-normal: 31
            new\-low: 21
    default\-encoding: \(aqutf\-8\(aq
    do\-not\-resolve\-relative\-paths: true
    dont\-compute\-new: false
    use\-stable\-build\-as\-reference: true
    use\-delta\-values: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B email()
Email notifications on build failure.
Requires the Jenkins \fI\%Mailer Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrecipients\fP (\fIstr\fP) \-\- Space separated list of recipient email addresses
(required)
.IP \(bu 2
\fBnotify\-every\-unstable\-build\fP (\fIbool\fP) \-\- Send an email for every
unstable build (default true)
.IP \(bu 2
\fBsend\-to\-individuals\fP (\fIbool\fP) \-\- Send an email to the individual
who broke the build (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- email:
      recipients: foo@example.com

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- email:
      recipients: foo@example.com bar@example.com
      notify\-every\-unstable\-build: false
      send\-to\-individuals: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B email\-ext()
Extend Jenkin\(aqs built in email notification
Requires the Jenkins \fI\%Email\-ext Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdisable\-publisher\fP (\fIbool\fP) \-\- Disable the publisher, while maintaining the
settings. The usage model for this is when you want to test things out
in the build, not send out e\-mails during the testing. A message will
be printed to the build log saying that the publisher is disabled.
(default false)
.IP \(bu 2
\fBrecipients\fP (\fIstr\fP) \-\- Comma separated list of recipient email addresses
(default \(aq$DEFAULT_RECIPIENTS\(aq)
.IP \(bu 2
\fBreply\-to\fP (\fIstr\fP) \-\- Comma separated list of email addresses that should be
in the Reply\-To header for this project (default \(aq$DEFAULT_REPLYTO\(aq)
.IP \(bu 2
\fBfrom\fP (\fIstr\fP) \-\- Email address that should be
in the From header for this project (default \(aq\(aq)
.IP \(bu 2
\fBcontent\-type\fP (\fIstr\fP) \-\- The content type of the emails sent. If not set, the
Jenkins plugin uses the value set on the main configuration page.
Possible values: \(aqhtml\(aq, \(aqtext\(aq, \(aqboth\-html\-text\(aq or \(aqdefault\(aq
(default \(aqdefault\(aq)
.IP \(bu 2
\fBsubject\fP (\fIstr\fP) \-\- Subject for the email, can include variables like
${BUILD_NUMBER} or even groovy or javascript code
(default \(aq$DEFAULT_SUBJECT\(aq)
.IP \(bu 2
\fBbody\fP (\fIstr\fP) \-\- Content for the body of the email, can include variables
like ${BUILD_NUMBER}, but the real magic is using groovy or
javascript to hook into the Jenkins API itself
(default \(aq$DEFAULT_CONTENT\(aq)
.IP \(bu 2
\fBattach\-build\-log\fP (\fIbool\fP) \-\- Include build log in the email (default false)
.IP \(bu 2
\fBcompress\-log\fP (\fIbool\fP) \-\- Compress build log in the email (default false)
.IP \(bu 2
\fBattachments\fP (\fIstr\fP) \-\- pattern of files to include as attachment
(default \(aq\(aq)
.IP \(bu 2
\fBalways\fP (\fIbool\fP) \-\- Send an email for every result (default false)
.IP \(bu 2
\fBunstable\fP (\fIbool\fP) \-\- Send an email for an unstable result (default false)
.IP \(bu 2
\fBfirst\-failure\fP (\fIbool\fP) \-\- Send an email for just the first failure
(default false)
.IP \(bu 2
\fBfirst\-unstable\fP (\fIbool\fP) \-\- Send an email for just the first unstable build
(default false)
.IP \(bu 2
\fBnot\-built\fP (\fIbool\fP) \-\- Send an email if not built (default false)
.IP \(bu 2
\fBaborted\fP (\fIbool\fP) \-\- Send an email if the build is aborted (default false)
.IP \(bu 2
\fBregression\fP (\fIbool\fP) \-\- Send an email if there is a regression
(default false)
.IP \(bu 2
\fBfailure\fP (\fIbool\fP) \-\- Send an email if the build fails (default true)
.IP \(bu 2
\fBsecond\-failure\fP (\fIbool\fP) \-\- Send an email for the second failure
(default false)
.IP \(bu 2
\fBimprovement\fP (\fIbool\fP) \-\- Send an email if the build improves (default false)
.IP \(bu 2
\fBstill\-failing\fP (\fIbool\fP) \-\- Send an email if the build is still failing
(default false)
.IP \(bu 2
\fBsuccess\fP (\fIbool\fP) \-\- Send an email for a successful build (default false)
.IP \(bu 2
\fBfixed\fP (\fIbool\fP) \-\- Send an email if the build is fixed (default false)
.IP \(bu 2
\fBfixed\-unhealthy\fP (\fIbool\fP) \-\- Send an email if the build status
changes from \(dqFailure\(dq or \(dqUnstable\(dq to \(dqSuccess\(dq. Intermediate
\(dqAborted\(dq builds are ignored. (default false)
.IP \(bu 2
\fBstill\-unstable\fP (\fIbool\fP) \-\- Send an email if the build is still unstable
(default false)
.IP \(bu 2
\fBpre\-build\fP (\fIbool\fP) \-\- Send an email before the build (default false)
.IP \(bu 2
\fBtrigger\-script\fP (\fIstr\fP) \-\- A Groovy script used to determine if an email
should be sent.
.IP \(bu 2
\fBpresend\-script\fP (\fIstr\fP) \-\- A Groovy script executed prior sending the mail.
(default \(aq\(aq)
.IP \(bu 2
\fBpostsend\-script\fP (\fIstr\fP) \-\- A Goovy script executed after sending the email.
(default \(aq\(aq)
.IP \(bu 2
\fBsave\-output\fP (\fIbool\fP) \-\- Save email content to workspace (default false)
.IP \(bu 2
\fBmatrix\-trigger\fP (\fIstr\fP) \-\- 
.sp
If using matrix projects, when to trigger
.INDENT 2.0
.TP
.B matrix\-trigger values
.INDENT 7.0
.IP \(bu 2
\fBboth\fP
.IP \(bu 2
\fBonly\-parent\fP
.IP \(bu 2
\fBonly\-configurations\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBsend\-to\fP (\fIlist\fP) \-\- 
.sp
list of recipients from the predefined groups
.INDENT 2.0
.TP
.B send\-to values
.INDENT 7.0
.IP \(bu 2
\fBdevelopers\fP (disabled by default)
.IP \(bu 2
\fBrequester\fP (disabled by default)
.IP \(bu 2
\fBculprits\fP (disabled by default)
.IP \(bu 2
\fBrecipients\fP (enabled by default)
.IP \(bu 2
\fBupstream\-committers\fP (>=2.39) (disabled by default)
.IP \(bu 2
\fBfailing\-test\-suspects\-recipients\fP (>=2.39) (disabled by default)
.IP \(bu 2
\fBfirst\-failing\-build\-suspects\-recipients\fP (>=2.39) (disabled by default)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- email\-ext:
      recipients: foo@example.com, bar@example.com
      reply\-to: foo@example.com
      content\-type: html
      subject: Subject for Build ${BUILD_NUMBER}
      body: The build has finished
      attach\-build\-log: false
      compress\-log: false
      attachments: \(dq*/foo*.log\(dq
      always: true
      unstable: true
      first\-failure: true
      first\-unstable: true
      not\-built: true
      aborted: true
      regression: true
      failure: true
      second\-failure: true
      improvement: true
      still\-failing: true
      success: true
      fixed: true
      fixed\-unhealthy: true
      still\-unstable: true
      pre\-build: true
      matrix\-trigger: only\-configurations
      presend\-script: \(dqcancel=true\(dq
      postsend\-script: \(dqcancel=true\(dq
      save\-output: true
      send\-to:
        \- developers
        \- requester
        \- culprits
        \- recipients
        \- upstream\-committers

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B emotional\-jenkins()
Emotional Jenkins. This funny plugin changes the expression of Mr. Jenkins
in the background when your builds fail.
.sp
Requires the Jenkins \fI\%Emotional Jenkins Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- emotional\-jenkins

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B findbugs()
FindBugs reporting for builds
.sp
Requires the Jenkins FindBugs Plugin
(\fI\%https://github.com/jenkinsci/findbugs\-plugin\fP).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- specifies the generated raw FindBugs XML report files,
such as **/findbugs.xml or **/findbugsXml.xml. (default \(aq\(aq)
.IP \(bu 2
\fBrank\-priority\fP (\fIbool\fP) \-\- Use rank as priority (default false)
.IP \(bu 2
\fBinclude\-files\fP (\fIstr\fP) \-\- Comma separated list of files to include.
(default \(aq\(aq)
.IP \(bu 2
\fBexclude\-files\fP (\fIstr\fP) \-\- Comma separated list of files to exclude.
(default \(aq\(aq)
.IP \(bu 2
\fBcan\-run\-on\-failed\fP (\fIbool\fP) \-\- Weather or not to run plug\-in on failed builds
(default false)
.IP \(bu 2
\fBshould\-detect\-modules\fP (\fIbool\fP) \-\- Determines if Ant or Maven modules should
be detected for all files that contain warnings. (default false)
.IP \(bu 2
\fBhealthy\fP (\fIint\fP) \-\- Sunny threshold (default \(aq\(aq)
.IP \(bu 2
\fBunhealthy\fP (\fIint\fP) \-\- Stormy threshold (default \(aq\(aq)
.IP \(bu 2
\fBhealth\-threshold\fP (\fIstr\fP) \-\- Threshold priority for health status
(\(aqlow\(aq, \(aqnormal\(aq or \(aqhigh\(aq, defaulted to \(aqlow\(aq)
.IP \(bu 2
\fBdont\-compute\-new\fP (\fIbool\fP) \-\- If set to false, computes new warnings based on
the reference build (default true)
.IP \(bu 2
\fBuse\-delta\-values\fP (\fIbool\fP) \-\- Use delta for new warnings. (default false)
.IP \(bu 2
\fBuse\-previous\-build\-as\-reference\fP (\fIbool\fP) \-\- If set then the number of new
warnings will always be calculated based on the previous build.
Otherwise the reference build. (default false)
.IP \(bu 2
\fBuse\-stable\-build\-as\-reference\fP (\fIbool\fP) \-\- The number of new warnings will be
calculated based on the last stable build, allowing reverts of unstable
builds where the number of warnings was decreased. (default false)
.IP \(bu 2
\fBthresholds\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B thresholds
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBunstable\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unstable
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfailed\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B failed
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- findbugs

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- findbugs:
        pattern: \(aq**/findbugs.xml\(aq
        rank\-priority: true
        include\-files: \(aqf,d,e,.*\(aq
        exclude\-files: \(aqa,c,d,.*\(aq
        can\-run\-on\-failed: true
        should\-detect\-modules: true
        healthy: 80
        unhealthy: 10
        use\-delta\-values: true
        health\-threshold: \(aqhigh\(aq
        thresholds:
            unstable:
                total\-all: 90
                total\-high: 80
                total\-normal: 50
                total\-low: 20
                new\-all: 95
                new\-high: 85
                new\-normal: 55
                new\-low: 25
            failed:
                total\-all: 80
                total\-high: 70
                total\-normal: 40
                total\-low: 10
                new\-all: 85
                new\-high: 75
                new\-normal: 45
                new\-low: 15
        dont\-compute\-new: false
        use\-delta\-values: true
        use\-previous\-build\-as\-reference: true
        use\-stable\-build\-as\-reference: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B fingerprint()
Fingerprint files to track them across builds. Requires the
Jenkins \fI\%Fingerprint Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfiles\fP (\fIstr\fP) \-\- files to fingerprint, follows the @includes of Ant fileset
(default \(aq\(aq)
.IP \(bu 2
\fBrecord\-artifacts\fP (\fIbool\fP) \-\- fingerprint all archived artifacts
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- fingerprint:
      files: builddir/test*.xml
      record\-artifacts: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B fitnesse()
Publish Fitnesse test results
.sp
Requires the Jenkins \fI\%Fitnesse plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBresults\fP (\fIstr\fP) \-\- path specifier for results files
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- fitnesse:
      results: \(dqfitnesse\-results/**/*.xml\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B flowdock()
This plugin publishes job build results to a Flowdock flow.
.sp
Requires the Jenkins \fI\%Flowdock Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtoken\fP (\fIstr\fP) \-\- API token for the targeted flow.
(required)
.IP \(bu 2
\fBtags\fP (\fIstr\fP) \-\- Comma\-separated list of tags to include in message
(default \(dq\(dq)
.IP \(bu 2
\fBchat\-notification\fP (\fIbool\fP) \-\- Send chat notification when build fails
(default true)
.IP \(bu 2
\fBnotify\-success\fP (\fIbool\fP) \-\- Send notification on build success
(default true)
.IP \(bu 2
\fBnotify\-failure\fP (\fIbool\fP) \-\- Send notification on build failure
(default true)
.IP \(bu 2
\fBnotify\-fixed\fP (\fIbool\fP) \-\- Send notification when build is fixed
(default true)
.IP \(bu 2
\fBnotify\-unstable\fP (\fIbool\fP) \-\- Send notification when build is unstable
(default false)
.IP \(bu 2
\fBnotify\-aborted\fP (\fIbool\fP) \-\- Send notification when build was aborted
(default false)
.IP \(bu 2
\fBnotify\-notbuilt\fP (\fIbool\fP) \-\- Send notification when build did not occur
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- flowdock:
      token: abcdefghijklmnopqrstuvwxyzabcdef

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- flowdock:
      token: abcdefghijklmnopqrstuvwxyzabcdef
      tags: jenkins,ci
      chat\-notification: true
      notify\-success: true
      notify\-failure: true
      notify\-fixed: true
      notify\-unstable: false
      notify\-aborted: false
      notify\-notbuilt: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ftp()
Upload files via FTP.
Requires the Jenkins \fI\%Publish over FTP Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fIstr\fP) \-\- name of the ftp site (required)
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- destination directory (required)
.IP \(bu 2
\fBtarget\-is\-date\-format\fP (\fIbool\fP) \-\- whether target is a date format. If true,
raw text should be quoted (default false)
.IP \(bu 2
\fBclean\-remote\fP (\fIbool\fP) \-\- should the remote directory be deleted before
transferring files (default false)
.IP \(bu 2
\fBsource\fP (\fIstr\fP) \-\- source path specifier (required)
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \-\- excluded file pattern (optional)
.IP \(bu 2
\fBremove\-prefix\fP (\fIstr\fP) \-\- prefix to remove from uploaded file paths
(optional)
.IP \(bu 2
\fBfail\-on\-error\fP (\fIbool\fP) \-\- fail the build if an error occurs (default false).
.IP \(bu 2
\fBflatten\fP (\fIbool\fP) \-\- only create files on the server, don\(aqt create
directories (default false).
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- adds lots of detail useful for debug to the console
but generally should be left off (default false)
.IP \(bu 2
\fBretries\fP (\fIint\fP) \-\- the number of times to retry this server in the event of
failure (optional)
.IP \(bu 2
\fBretry\-delay\fP (\fIint\fP) \-\- the time to wait, in milliseconds, before attempting
another transfer (default 10000)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- ftp:
      site: \(aqftp.example.com\(aq
      target: \(aqdest/dir\(aq
      source: \(aqbase/source/dir/**\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- ftp:
      site: \(aqftp.example.com\(aq
      target: \(dq\(aqdest/dir/\(aqyyyyMMddHHmmss\(dq
      target\-is\-date\-format: true
      clean\-remote: true
      source: \(aqbase/source/dir/**\(aq
      excludes: \(aq**/*.excludedfiletype\(aq
      remove\-prefix: \(aqbase/source/dir\(aq
      fail\-on\-error: true
      flatten: true
      verbose: true
      retries: 99
      retry\-delay: 12345

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ftp\-publisher()
This plugin can be used to upload project artifacts and whole directories
to an ftp server.
Requires the Jenkins \fI\%FTP\-Publisher Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuploads\fP (\fIlist\fP) \-\- 
.sp
List of files to upload
.INDENT 2.0
.TP
.B uploads
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBfile\-path\fP (\(aqstr\(aq) \-\- Destination folder. It will be created
if doesn\(aqt exists. Created relative to ftp root directory.
(default \(aq\(aq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBsource\-file\fP (\(aqstr\(aq) \-\- Source files which will be uploaded
(default \(aq\(aq)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBsite\-name\fP (\fIstr\fP) \-\- Name of FTP server to upload to (required)
.IP \(bu 2
\fBuse\-timestamps\fP (\fIbool\fP) \-\- Use timestamps in the FTP directory path (default
false)
.IP \(bu 2
\fBflatten\-files\fP (\fIbool\fP) \-\- Flatten files on the FTP host (default false)
.IP \(bu 2
\fBskip\-publishing\fP (\fIbool\fP) \-\- Skip publishing (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- ftp\-publisher:
      site\-name: foo

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- ftp\-publisher:
      uploads:
        \- file\-path: destination/folder
          source\-file: folder/dist/*.jar
        \- file\-path: foo/bar
          source\-file: foo/bar/*.ear
      site\-name: foo
      use\-timestamps: true
      flatten\-files: true
      skip\-publishing: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gatling()
Publish gatling results as a trend graph
Requires the Jenkins \fI\%Gatling Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- gatling

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B git()
This plugin will configure the Jenkins Git plugin to
push merge results, tags, and/or branches to
remote repositories after the job completes.
.sp
Requires the Jenkins \fI\%Git Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpush\-merge\fP (\fIbool\fP) \-\- push merges back to the origin specified in the
pre\-build merge options (default false)
.IP \(bu 2
\fBpush\-only\-if\-success\fP (\fIbool\fP) \-\- Only push to remotes if the build succeeds
\- otherwise, nothing will be pushed.
(default true)
.IP \(bu 2
\fBforce\-push\fP (\fIbool\fP) \-\- Add force option to git push (default false)
.IP \(bu 2
\fBtags\fP (\fIlist\fP) \-\- 
.sp
tags to push at the completion of the build
.INDENT 2.0
.TP
.B tag
.INDENT 7.0
.IP \(bu 2
\fBremote\fP (\fIstr\fP) remote repo name to push to
(default \(aqorigin\(aq)
.IP \(bu 2
\fBname\fP (\fIstr\fP) name of tag to push
.IP \(bu 2
\fBmessage\fP (\fIstr\fP) message content of the tag
.IP \(bu 2
\fBcreate\-tag\fP (\fIbool\fP) whether or not to create the tag
after the build, if this is False then the tag needs to
exist locally (default false)
.IP \(bu 2
\fBupdate\-tag\fP (\fIbool\fP) whether to overwrite a remote tag
or not (default false)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbranches\fP (\fIlist\fP) \-\- 
.sp
branches to push at the completion of the build
.INDENT 2.0
.TP
.B branch
.INDENT 7.0
.IP \(bu 2
\fBremote\fP (\fIstr\fP) remote repo name to push to
(default \(aqorigin\(aq)
.IP \(bu 2
\fBname\fP (\fIstr\fP) name of remote branch to push to
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBnotes\fP (\fIlist\fP) \-\- 
.sp
notes to push at the completion of the build
.INDENT 2.0
.TP
.B note
.INDENT 7.0
.IP \(bu 2
\fBremote\fP (\fIstr\fP) remote repo name to push to
(default \(aqorigin\(aq)
.IP \(bu 2
\fBmessage\fP (\fIstr\fP) content of the note
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) namespace of the note
(default master)
.IP \(bu 2
\fBreplace\-note\fP (\fIbool\fP) whether to overwrite a note or not
(default false)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- git

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- git:
      push\-merge: true
      push\-only\-if\-success: false
      force\-push: true
      tags:
          \- tag:
              remote: tagremotename
              name: tagname
              message: \(dqsome tag message\(dq
              create\-tag: true
              update\-tag: true
      branches:
          \- branch:
              remote: branchremotename
              name: \(dqsome/branch\(dq
      notes:
          \- note:
              remote: remotename
              message: \(dqsome note to push\(dq
              namespace: notenamespace
              replace\-note: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B github\-notifier()
Set build status on Github commit.
Requires the Jenkins \fI\%Github Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- github\-notifier

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B github\-pull\-request\-merge()
This action merges the pull request that triggered the build (see the
github pull request trigger)
.sp
Requires the Jenkins \fI\%GitHub pull request builder plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBonly\-admins\-merge\fP (\fIbool\fP) \-\- if \fItrue\fP only administrators can merge the
pull request, (default false)
.IP \(bu 2
\fBdisallow\-own\-code\fP (\fIbool\fP) \-\- if \fItrue\fP will allow merging your own pull
requests, in opposite to needing someone else to trigger the merge.
(default false)
.IP \(bu 2
\fBmerge\-comment\fP (\fIstr\fP) \-\- Comment to set on the merge commit (default \(aq\(aq)
.IP \(bu 2
\fBfail\-on\-non\-merge\fP (\fIbool\fP) \-\- fail the job if the merge was unsuccessful
(default false)
.IP \(bu 2
\fBdelete\-on\-merge\fP (\fIbool\fP) \-\- Delete the branch of the pull request on
successful merge (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- github\-pull\-request\-merge:
      only\-admins\-merge: true
      disallow\-own\-code: true
      merge\-comment: \(aqmy fancy commit message\(aq
      fail\-on\-non\-merge: true
      delete\-on\-merge: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- github\-pull\-request\-merge

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gitlab\-message()
Add note with build status on GitLab merge request.
Requires the Jenkins \fI\%GitLab Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfailure\-only\fP (\fIbool\fP) \-\- make a comment only on failure (default false)
.IP \(bu 2
\fBsuccess\-note\fP (\fIbool\fP) \-\- make a comment on GitLab Merge Request
if build succeeds (default false)
.IP \(bu 2
\fBfailure\-note\fP (\fIbool\fP) \-\- make a comment on GitLab Merge Request
if build failed (default false)
.IP \(bu 2
\fBabort\-note\fP (\fIbool\fP) \-\- make a comment on GitLab Merge Request
if build aborted (default false)
.IP \(bu 2
\fBunstable\-note\fP (\fIbool\fP) \-\- make a comment on GitLab Merge Request
if build unstable (default false)
.IP \(bu 2
\fBsuccess\-note\-text\fP (\fIstr\fP) \-\- text of comment on success build (default \(aq\(aq)
.IP \(bu 2
\fBfailure\-note\-text\fP (\fIstr\fP) \-\- text of comment on failed build (default \(aq\(aq)
.IP \(bu 2
\fBabort\-note\-text\fP (\fIstr\fP) \-\- text of comment on aborted build (default \(aq\(aq)
.IP \(bu 2
\fBunstable\-note\-text\fP (\fIstr\fP) \-\- text of comment on unstable build (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- gitlab\-message

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- gitlab\-message:
      failure\-only: true
      success\-note: true
      success\-note\-text: \(dqSUCCESS\(dq
      failure\-note: true
      failure\-note\-text: \(dqBuild was failed. See log on Jenkins\(dq
      abort\-note: true
      abort\-note\-text: \(dqBuild was aborted\(dq
      unstable\-note: true
      unstable\-note\-text: \(dqThe build is unstable\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gitlab\-notifier()
Set build status on GitLab commit.
Requires the Jenkins \fI\%GitLab Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- The name of the build in GitLab. With this you can
distinguish different Jenkins jobs for the same commit in GitLab.
(default \(aqjenkins\(aq)
.IP \(bu 2
\fBmark\-unstable\-as\-success\fP (\fIbool\fP) \-\- (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- gitlab\-notifier

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- gitlab\-notifier:
      name: foobar\-jenkins
      mark\-unstable\-as\-success: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gitlab\-vote()
Set vote for build status on GitLab merge request.
Requires the Jenkins \fI\%GitLab Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- gitlab\-vote

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B google\-cloud\-storage()
Upload build artifacts to Google Cloud Storage. Requires the
Jenkins \fI\%Google Cloud Storage plugin\fP\&.
.sp
Apart from the Google Cloud Storage Plugin itself, installation of Google
OAuth Credentials and addition of required credentials to Jenkins is
required.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- The set of Google credentials registered with
the Jenkins Credential Manager for authenticating
with your project. (required)
.IP \(bu 2
\fBuploads\fP (\fIlist\fP) \-\- .INDENT 2.0
.TP
.B uploads
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBexpiring\-elements\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B params
.INDENT 7.0
.IP \(bu 2
\fBbucket\-name\fP (\fIstr\fP) bucket name to upload artifacts
(required)
.IP \(bu 2
\fBdays\-to\-retain\fP (\fIint\fP) days to keep artifacts
(required)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBbuild\-log\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B params
.INDENT 7.0
.IP \(bu 2
\fBlog\-name\fP (\fIstr\fP) name of the file that the Jenkins
console log to be named (required)
.IP \(bu 2
\fBstorage\-location\fP (\fIstr\fP) bucket name to upload
artifacts (required)
.IP \(bu 2
\fBshare\-publicly\fP (\fIbool\fP) whether to share uploaded
share uploaded artifacts with everyone (default false)
.IP \(bu 2
\fBupload\-for\-failed\-jobs\fP (\fIbool\fP) whether to upload
artifacts even if the build fails (default false)
.IP \(bu 2
\fBshow\-inline\fP (\fIbool\fP) whether to show uploaded build
log inline in web browsers, rather than forcing it to be
downloaded (default true)
.IP \(bu 2
\fBstrip\-prefix\fP (\fIstr\fP) strip this prefix off the
file names (default not set)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBclassic\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B params
.INDENT 7.0
.IP \(bu 2
\fBfile\-pattern\fP (\fIstr\fP) ant style globs to match the
files to upload (required)
.IP \(bu 2
\fBstorage\-location\fP (\fIstr\fP) bucket name to upload
artifacts (required)
.IP \(bu 2
\fBshare\-publicly\fP (\fIbool\fP) whether to share uploaded
share uploaded artifacts with everyone (default false)
.IP \(bu 2
\fBupload\-for\-failed\-jobs\fP (\fIbool\fP) whether to upload
artifacts even if the build fails (default false)
.IP \(bu 2
\fBshow\-inline\fP (\fIbool\fP) whether to show uploaded
artifacts inline in web browsers, rather than forcing
them to be downloaded (default false)
.IP \(bu 2
\fBstrip\-prefix\fP (\fIstr\fP) strip this prefix off the
file names (default not set)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- google\-cloud\-storage:
        credentials\-id: \(aqmyCredentials\(aq
        uploads:
            \- expiring\-elements:
                bucket\-name: \(aqgs://myBucket\(aq
                days\-to\-retain: 7

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- google\-cloud\-storage:
        credentials\-id: \(aqmyCredentials\(aq
        uploads:
            \- expiring\-elements:
                bucket\-name: \(aqgs://myBucket\(aq
                days\-to\-retain: 7
            \- build\-log:
                log\-name: \(aqconsole.log\(aq
                storage\-location: \(aqgs://myBucket\(aq
                upload\-for\-failed\-jobs: true
                share\-publicly: true
            \- classic:
                file\-pattern: \(aqtarget/*.war\(aq
                storage\-location: \(aqgs://myBucket\(aq
                upload\-for\-failed\-jobs: true
            \- classic:
                file\-pattern: \(aq**/build/*.iso\(aq
                storage\-location: \(aqgs://myBucket/artifacts/\(aq
                share\-publicly: true
                strip\-prefix: \(aqpath/to/\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B groovy\-postbuild()
Execute a groovy script.
Requires the Jenkins \fI\%Groovy Postbuild Plugin\fP\&.
.sp
Please pay attention on version of plugin you have installed.
There were incompatible changes between 1.x and 2.x. Please see
\fI\%home page\fP of this plugin
for full information including migration process.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBscript\fP (\fIstr\fP) \-\- The groovy script to execute
.IP \(bu 2
\fBclasspath\fP (\fIlist\fP) \-\- List of additional classpaths (>=1.6)
.IP \(bu 2
\fBon\-failure\fP (\fIstr\fP) \-\- In case of script failure leave build as it is
for \(dqnothing\(dq option, mark build as unstable
for \(dqunstable\(dq and mark job as failure for \(dqfailed\(dq
(default \(aqnothing\(aq)
.IP \(bu 2
\fBmatrix\-parent\fP (\fIbool\fP) \-\- Run script for matrix parent only (>=1.9)
(default false)
.IP \(bu 2
\fBsandbox\fP (\fIbool\fP) \-\- Execute script inside of groovy sandbox (>=2.0)
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- groovy\-postbuild:
        script: \(dqmanager.buildFailure()\(dq
        classpath:
            \- \(dqfile:///path/to/your/lib\(dq
            \- \(dqfile:///path/to/your/lib\(dq
        on\-failure: \(dqfailed\(dq
        matrix\-parent: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B growl()
Push notifications to growl client.
Requires the Jenkins \fI\%Growl Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBip\fP (\fIstr\fP) \-\- IP address to send growl notifications to (required)
.IP \(bu 2
\fBnotify\-only\-on\-fail\-or\-recovery\fP (\fIbool\fP) \-\- send a growl only when build
fails or recovers from a failure (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- growl:
      ip: foo.ip.address

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- growl:
      ip: foo.ip.address
      notify\-only\-on\-fail\-or\-recovery: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B hipchat()
Publisher that sends hipchat notifications on job events
Requires the Jenkins \fI\%Hipchat Plugin\fP version >=1.9
.sp
Please see documentation for older plugin version
\fI\%https://jenkins\-job\-builder.readthedocs.io/en/latest/hipchat.html\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtoken\fP (\fIstr\fP) \-\- This will override the default auth token (optional)
.IP \(bu 2
\fBrooms\fP (\fIlist\fP) \-\- list of HipChat rooms to post messages to, overrides
global default (optional)
.IP \(bu 2
\fBnotify\-start\fP (\fIbool\fP) \-\- post messages about build start event
(default false)
.IP \(bu 2
\fBnotify\-success\fP (\fIbool\fP) \-\- post messages about successful build event
(default false)
.IP \(bu 2
\fBnotify\-aborted\fP (\fIbool\fP) \-\- post messages about aborted build event
(default false)
.IP \(bu 2
\fBnotify\-not\-built\fP (\fIbool\fP) \-\- post messages about build set to NOT_BUILT.
This status code is used in a multi\-stage build where a problem in
earlier stage prevented later stages from building. (default false)
.IP \(bu 2
\fBnotify\-unstable\fP (\fIbool\fP) \-\- post messages about unstable build event
(default false)
.IP \(bu 2
\fBnotify\-failure\fP (\fIbool\fP) \-\- post messages about build failure event
(default false)
.IP \(bu 2
\fBnotify\-back\-to\-normal\fP (\fIbool\fP) \-\- post messages about build being back to
normal after being unstable or failed (default false)
.IP \(bu 2
\fBstart\-message\fP (\fIstr\fP) \-\- This will override the default start message
(optional)
.IP \(bu 2
\fBcomplete\-message\fP (\fIstr\fP) \-\- This will override the default complete message
(optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- hipchat:
      token: auth
      rooms:
        \- room1
        \- room2
      notify\-start: true
      notify\-aborted: true
      start\-message: job started
      complete\-message: job completed

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B hp\-alm()
Publish test results to HP\-ALM.
.sp
Requires the Jenkins \fI\%Micro Focus Application Automation
Tools\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBserver\-name\fP (\fIstr\fP) \-\- The name of the ALM Server. (required)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- credentials\-id of the user (default \(aq\(aq)
.IP \(bu 2
\fBdomaine\fP (\fIstr\fP) \-\- The Domain of the project to be used. (required)
.IP \(bu 2
\fBclient\-type\fP (\fIstr\fP) \-\- Client type is required for some ALM above 12.60
in authentication.(default \(aq\(aq)
.IP \(bu 2
\fBproject\fP (\fIstr\fP) \-\- The project to be used. (required)
.IP \(bu 2
\fBtesting\-framework\fP (\fIstr\fP) \-\- The testing framework that is used when
generate the testing result file. (default Junit)
.IP \(bu 2
\fBtesting\-tool\fP (\fIstr\fP) \-\- The testing tool that is used when generate
the testing result file. (default \(aq\(aq)
.IP \(bu 2
\fBfolder\fP (\fIstr\fP) \-\- The path of the test folder that will contain
the uploaded test.
The path doesn\(aqt include the Root test folder (Subject).
For example, sampletestfolder/subfolder means, the tests will be
uploaded to test folder named \(aqsubfolder\(aq, which is under
the test folder named \(aqsampletestfolder\(aq, and \(aqsampletestfolder\(aq
is under the root test folder \(aqSubject\(aq. (required)
.IP \(bu 2
\fBset\-folder\fP (\fIstr\fP) \-\- The path of the testset folder that will contain
the uploaded testset. The path doesn\(aqt include the Root testset folder.
For example, sampletestsetfolder/subfolder means, the testsets will be
uploaded to testset folder named \(aqsubfolder\(aq, which is under
the testset folder named \(aqsampletestsetfolder\(aq,
and \(aqsampletestsetfolder\(aq is under the root testset folder \(aqRoot\(aq.
(required)
.IP \(bu 2
\fBtesting\-result\-file\fP (\fIstr\fP) \-\- The condition to find the testing
result file, start from the root path of the job.
For example, \fB**/junitResult.xml\fP to find testing result file
for Junit Plugin, \fB**/testng\-results.xml\fP to find
testing result file for TestNG plugin. (required)
.IP \(bu 2
\fBjenkins\-server\-url\fP (\fIstr\fP) \-\- The HTTP URL of the Jenkins Server,
form example, \fI\%http://jenkins.example.org:8080\fP . (optional)
.UNINDENT
.UNINDENT
.sp
Minimal example using defaults:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- hp\-alm:
      server\-name: HP\-ALM
      domain: FOO_COMPANY
      project: foo_project
      folder: \(aqALM/foo/release1/test_case1\(aq
      set\-folder: \(aqALM/foo/release1/test_case1/$env\(aq
      testing\-result\-file: \(aq**/junitResult.xml\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- hp\-alm:
      server\-name: HP\-ALM
      credentials\-id: cba09876\-4321\-4567\-890a\-bcde12345678
      domain: FOO_COMPANY
      project: foo_project
      client\-type: foo_client
      testing\-framework: JUnit
      testing\-tool: foo_tool
      folder: \(aqALM/foo/release1/test_case1\(aq
      set\-folder: \(aqALM/foo/release1/test_case1/$env\(aq
      testing\-result\-file: \(aq**/junitResult.xml\(aq
      jenkins\-server\-url: \(aqhttp://myjenkinsserver.test.com:8080\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B html\-publisher()
This plugin publishes HTML reports.
.sp
Requires the Jenkins \fI\%HTML Publisher Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Report name (required)
.IP \(bu 2
\fBdir\fP (\fIstr\fP) \-\- HTML directory to archive (required)
.IP \(bu 2
\fBfiles\fP (\fIstr\fP) \-\- Specify the pages to display (required)
.IP \(bu 2
\fBkeep\-all\fP (\fIbool\fP) \-\- keep HTML reports for each past build (default false)
.IP \(bu 2
\fBallow\-missing\fP (\fIbool\fP) \-\- Allow missing HTML reports (default false)
.IP \(bu 2
\fBlink\-to\-last\-build\fP (\fIbool\fP) \-\- If this and \(aqkeep\-all\(aq both are true, it
publishes the link on project level even if build failed.
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- html\-publisher:
      name: \(dqsome name\(dq
      dir: \(dqpath/\(dq
      files: \(dqindex.html\(dq
      keep\-all: true
      allow\-missing: true
      link\-to\-last\-build: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B hue\-light()
This plugin shows the state of your builds using the awesome Philips hue
lights.
.sp
Requires the Jenkins \fI\%hue\-light Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlight\-id\fP (\fIint\fP) \-\- ID of light. Define multiple lights by a comma as a
separator (required)
.IP \(bu 2
\fBpre\-build\fP (\fIstr\fP) \-\- Colour of building state (default \(aqblue\(aq)
.IP \(bu 2
\fBgood\-build\fP (\fIstr\fP) \-\- Colour of successful state (default \(aqgreen\(aq)
.IP \(bu 2
\fBunstable\-build\fP (\fIstr\fP) \-\- Colour of unstable state (default \(aqyellow\(aq)
.IP \(bu 2
\fBbad\-build\fP (\fIstr\fP) \-\- Colour of unsuccessful state (default \(aqred\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- hue\-light:
      light\-id: 123
      pre\-build: yellow
      good\-build: red
      unstable\-build: blue
      bad\-build: green

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- hue\-light:
      light\-id: 123

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B image\-gallery()
Produce an image gallery using Javascript library. Requires the Jenkins
\fI\%Image Gallery Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgallery\-type\fP (\fIstr\fP) \-\- .INDENT 2.0
.TP
.B gallery\-type values
.INDENT 7.0
.IP \(bu 2
\fBarchived\-images\-gallery\fP (default)
.IP \(bu 2
\fBin\-folder\-comparative\-gallery\fP
.IP \(bu 2
\fBmultiple\-folder\-comparative\-gallery\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtitle\fP (\fIstr\fP) \-\- gallery title (optional)
.IP \(bu 2
\fBimage\-width\fP (\fIint\fP) \-\- width of the image (optional)
.IP \(bu 2
\fBunstable\-if\-no\-artifacts\fP (\fIbool\fP) \-\- mark build as unstable
if no archived artifacts were found (default false)
.IP \(bu 2
\fBincludes\fP (\fIstr\fP) \-\- include pattern (valid for archived\-images\-gallery
gallery)
.IP \(bu 2
\fBbase\-root\-folder\fP (\fIstr\fP) \-\- base root dir (valid for comparative gallery)
.IP \(bu 2
\fBimage\-inner\-width\fP (\fIint\fP) \-\- width of the image displayed in the inner
gallery popup (valid for comparative gallery, optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- image\-gallery:
        \- gallery\-type: archived\-images\-gallery
          title: Gallery 1
          includes: path/images
          image\-width: 100
          unstable\-if\-no\-artifacts: true
        \- gallery\-type: in\-folder\-comparative\-gallery
          title: Gallery 2
          base\-root\-folder: path/images2
          image\-width: 321
          image\-inner\-width: 111
          unstable\-if\-no\-artifacts: false
        \- gallery\-type: multiple\-folder\-comparative\-gallery
          title: Gallery 3
          base\-root\-folder: path/images3
          image\-width: 222
          image\-inner\-width: 1

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B influx\-db()
Requires the Jenkins :jenkins\-plugins: \fIInflux DB
<influxdb>\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B ircbot()
ircbot enables Jenkins to send build notifications via IRC and lets you
interact with Jenkins via an IRC bot.
.sp
Requires the Jenkins \fI\%IRC Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstrategy\fP (\fIstr\fP) \-\- 
.sp
When to send notifications
.INDENT 2.0
.TP
.B strategy values
.INDENT 7.0
.IP \(bu 2
\fBall\fP always (default)
.IP \(bu 2
\fBany\-failure\fP on any failure
.IP \(bu 2
\fBfailure\-and\-fixed\fP on failure and fixes
.IP \(bu 2
\fBnew\-failure\-and\-fixed\fP on new failure and fixes
.IP \(bu 2
\fBstatechange\-only\fP only on state change
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBnotify\-start\fP (\fIbool\fP) \-\- Whether to send notifications to channels when a
build starts (default false)
.IP \(bu 2
\fBnotify\-committers\fP (\fIbool\fP) \-\- Whether to send notifications to the users
that are suspected of having broken this build (default false)
.IP \(bu 2
\fBnotify\-culprits\fP (\fIbool\fP) \-\- Also send notifications to \(aqculprits\(aq from
previous unstable/failed builds (default false)
.IP \(bu 2
\fBnotify\-upstream\fP (\fIbool\fP) \-\- Whether to send notifications to upstream
committers if no committers were found for a broken build
(default false)
.IP \(bu 2
\fBnotify\-fixers\fP (\fIbool\fP) \-\- Whether to send notifications to the users that
have fixed a broken build (default false)
.IP \(bu 2
\fBmessage\-type\fP (\fIstr\fP) \-\- 
.sp
Channel Notification Message.
.INDENT 2.0
.TP
.B message\-type values
.INDENT 7.0
.IP \(bu 2
\fBsummary\-scm\fP for summary and SCM changes (default)
.IP \(bu 2
\fBsummary\fP for summary only
.IP \(bu 2
\fBsummary\-params\fP for summary and build parameters
.IP \(bu 2
\fBsummary\-scm\-fail\fP for summary, SCM changes, failures)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBchannels\fP (\fIlist\fP) \-\- 
.sp
list channels definitions
If empty, it takes channel from Jenkins configuration.
(default empty)
WARNING: the IRC plugin requires the channel to be configured in the
system wide configuration or the jobs will fail to emit notifications
to the channel
.INDENT 2.0
.TP
.B Channel
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) Channel name
.IP \(bu 2
\fBpassword\fP (\fIstr\fP) Channel password (optional)
.IP \(bu 2
\fBnotify\-only\fP (\fIbool\fP) Set to true if you want to
disallow bot commands (default false)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBmatrix\-notifier\fP (\fIstr\fP) \-\- 
.sp
notify for matrix projects
instant\-messaging\-plugin injects an additional
field in the configuration form whenever the
project is a multi\-configuration project
.INDENT 2.0
.TP
.B matrix\-notifier values
.INDENT 7.0
.IP \(bu 2
\fBall\fP
.IP \(bu 2
\fBonly\-configurations\fP (default)
.IP \(bu 2
\fBonly\-parent\fP
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- ircbot

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- ircbot:
      strategy: failure\-and\-fixed
      notify\-start: true
      notify\-committers: true
      notify\-culprits: true
      notify\-upstream: true
      notify\-fixers: true
      message\-type: summary
      channels:
          \- name: \(aq#jenkins\-channel1\(aq
            password: secrete
            notify\-only: false
          \- name: \(aq#jenkins\-channel2\(aq
            notify\-only: true
      matrix\-notifier: all

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jabber()
Integrates Jenkins with the Jabber/XMPP instant messaging protocol
Requires the Jenkins \fI\%Jabber Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBnotify\-on\-build\-start\fP (\fIbool\fP) \-\- Whether to send notifications
to channels when a build starts (default false)
.IP \(bu 2
\fBnotify\-scm\-committers\fP (\fIbool\fP) \-\- Whether to send notifications
to the users that are suspected of having broken this build
(default false)
.IP \(bu 2
\fBnotify\-scm\-culprits\fP (\fIbool\fP) \-\- Also send notifications to \(aqculprits\(aq
from previous unstable/failed builds (default false)
.IP \(bu 2
\fBnotify\-upstream\-committers\fP (\fIbool\fP) \-\- Whether to send notifications to
upstream committers if no committers were found for a broken build
(default false)
.IP \(bu 2
\fBnotify\-scm\-fixers\fP (\fIbool\fP) \-\- Whether to send notifications to the users
that have fixed a broken build (default false)
.IP \(bu 2
\fBgroup\-targets\fP (\fIlist\fP) \-\- List of group targets to notify
.IP \(bu 2
\fBindividual\-targets\fP (\fIlist\fP) \-\- List of individual targets to notify
.IP \(bu 2
\fBstrategy\fP (\fIdict\fP) \-\- 
.sp
When to send notifications (default all)
.INDENT 2.0
.TP
.B strategy values
.INDENT 7.0
.IP \(bu 2
\fBall\fP \-\- Always
.IP \(bu 2
\fBfailure\fP \-\- On any failure
.IP \(bu 2
\fBfailure\-fixed\fP \-\- On failure and fixes
.IP \(bu 2
\fBnew\-failure\-fixed\fP \-\- On new failure and fixes
.IP \(bu 2
\fBchange\fP \-\- Only on state change
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBmessage\fP (\fIdict\fP) \-\- 
.sp
Channel notification message (default summary\-scm)
.INDENT 2.0
.TP
.B message  values
.INDENT 7.0
.IP \(bu 2
\fBsummary\-scm\fP \-\- Summary + SCM changes
.IP \(bu 2
\fBsummary\fP \-\- Just summary
.IP \(bu 2
\fBsummary\-build\fP \-\- Summary and build parameters
.IP \(bu 2
\fBsummary\-scm\-fail\fP \-\- Summary, SCM changes, and failed tests
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- jabber

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- jabber:
      notify\-on\-build\-start: true
      notify\-scm\-committers: true
      notify\-scm\-culprits: true
      notify\-upstream\-committers: true
      notify\-scm\-fixers: true
      group\-targets:
        \- \(dqfoo\-room@conference\-2\-fooserver.foo.com\(dq
      individual\-targets:
        \- \(dqfoo\-user@conference\-2\-fooserver.foo.com\(dq
      strategy: new\-failure\-fixed
      message: summary

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jacoco()
Generate a JaCoCo coverage report.
Requires the Jenkins \fI\%JaCoCo Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBexec\-pattern\fP (\fIstr\fP) \-\- This is a file name pattern that can be used to
locate the jacoco report files (default \fB**/**.exec\fP)
.IP \(bu 2
\fBclass\-pattern\fP (\fIstr\fP) \-\- This is a file name pattern that can be used
to locate class files (default \fB**/classes\fP)
.IP \(bu 2
\fBsource\-pattern\fP (\fIstr\fP) \-\- This is a file name pattern that can be used
to locate source files (default \fB**/src/main/java\fP)
.IP \(bu 2
\fBsource\-inclusion\-pattern\fP (\fIstr\fP) \-\- This is a file name pattern that can
be used to include certain source files (default \fB**/*.java\fP)
.IP \(bu 2
\fBupdate\-build\-status\fP (\fIbool\fP) \-\- Update the build according to the results
(default false)
.IP \(bu 2
\fBinclusion\-pattern\fP (\fIstr\fP) \-\- This is a file name pattern that can be used
to include certain class files (default \(aq\(aq)
.IP \(bu 2
\fBexclusion\-pattern\fP (\fIstr\fP) \-\- This is a file name pattern that can be used
to exclude certain class files (default \(aq\(aq)
.IP \(bu 2
\fBtargets\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B targets
(instruction, branch, complexity, line, method, class)
.INDENT 7.0
.IP \(bu 2
\fBhealthy\fP (\fIint\fP): Healthy threshold (default 0)
.IP \(bu 2
\fBunhealthy\fP (\fIint\fP): Unhealthy threshold (default 0)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- jacoco

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- jacoco:
      exec\-pattern: \(aq**/**.exec\(aq
      class\-pattern: \(aq**/classes\(aq
      source\-pattern: \(aq**/src/main/java\(aq
      source\-inclusion\-pattern: \(aq**/*.java,**/*.kt\(aq
      update\-build\-status: true
      inclusion\-pattern: \(aq**/*.class\(aq
      exclusion\-pattern: \(aq**/*Test*.class\(aq
      targets:
        \- instruction:
            healthy: 7
            unhealthy: 1
        \- branch:
            healthy: 8
            unhealthy: 2
        \- complexity:
            healthy: 9
            unhealthy: 3
        \- line:
            healthy: 10
            unhealthy: 4
        \- method:
            healthy: 11
            unhealthy: 5
        \- class:
            healthy: 12
            unhealthy: 6

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B javadoc()
Publish Javadoc
Requires the Jenkins \fI\%Javadoc Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdirectory\fP (\fIstr\fP) \-\- Directory relative to the root of the workspace,
such as \(aqmyproject/build/javadoc\(aq (optional)
.IP \(bu 2
\fBkeep\-all\-successful\fP (\fIbool\fP) \-\- When true, it will retain Javadoc for each
successful build. This allows you to browse Javadoc for older builds,
at the expense of additional disk space requirement. If false, it will
only keep the latest Javadoc, so older Javadoc will be overwritten as
new builds succeed. (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- javadoc:
      directory: myproject/build/javadoc
      keep\-all\-successful: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jclouds()
JClouds Cloud Storage Settings provides a way to store artifacts on
JClouds supported storage providers. Requires the Jenkins
\fI\%JClouds Plugin\fP\&.
.sp
JClouds Cloud Storage Settings must be configured for the Jenkins instance.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprofile\fP (\fIstr\fP) \-\- preconfigured storage profile (required)
.IP \(bu 2
\fBfiles\fP (\fIstr\fP) \-\- files to upload (regex) (required)
.IP \(bu 2
\fBbasedir\fP (\fIstr\fP) \-\- the source file path (relative to workspace, Optional)
.IP \(bu 2
\fBcontainer\fP (\fIstr\fP) \-\- the destination container name (required)
.IP \(bu 2
\fBhierarchy\fP (\fIbool\fP) \-\- keep hierarchy (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- jclouds:
      profile: hp
      files: \(aq*.tar.gz\(aq
      container: jenkins
      basedir: test base dir

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jdepend()
Publish jdepend report
Requires the \fI\%JDepend Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBfile\fP (\fIstr\fP) \-\- path to jdepend file (required)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- jdepend:
      file: build/jdepend/main.xml

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jira()
Update relevant JIRA issues
Requires the Jenkins \fI\%JIRA Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- jira

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jms\-messaging()
.INDENT 7.0
.TP
.B The JMS Messaging Plugin provides the following functionality:
.INDENT 7.0
.IP \(bu 2
A build trigger to submit jenkins jobs upon receipt
of a matching message.
.IP \(bu 2
A builder that may be used to submit a message to the topic
upon the completion of a job
.IP \(bu 2
A post\-build action that may be used to submit a message to the topic
upon the completion of a job
.UNINDENT
.TP
.B JMS Messaging provider types supported:
.INDENT 7.0
.IP \(bu 2
ActiveMQ
.IP \(bu 2
FedMsg
.UNINDENT
.UNINDENT
.sp
Requires the Jenkins \fI\%JMS Messaging Plugin
Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBoverride\-topic\fP (\fIstr\fP) \-\- If you need to override the default topic.
(default \(aq\(aq)
.IP \(bu 2
\fBprovider\-name\fP (\fIstr\fP) \-\- Name of message provider setup in the
global config. (default \(aq\(aq)
.IP \(bu 2
\fBmsg\-type\fP (\fIstr\fP) \-\- A message type
(default \(aqCodeQualityChecksDone\(aq)
.IP \(bu 2
\fBmsg\-props\fP (\fIstr\fP) \-\- Message header to publish. (default \(aq\(aq)
.IP \(bu 2
\fBmsg\-content\fP (\fIstr\fP) \-\- Message body to publish. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- jms\-messaging:
      override\-topic: org.centos.stage.ci.pipeline.compose.complete
      provider\-name: fedmsg
      msg\-type: Custom
      msg\-props: |
        topic=org.centos.prod.ci.pipeline.compose.complete
        username=fedora\-atomic
      msg\-content: |
        {
          \(dqbuild_url\(dq: \(dq${BUILD_URL}\(dq,
          \(dqcompose_url\(dq: \(dq<full\-url\-to\-compose>\(dq,
          \(dqbuild_id\(dq: \(dq${BUILD_ID}\(dq,
          \(dqref\(dq: \(dqfedora/rawhide/${basearch}/atomic\-host\(dq,
          \(dqrev\(dq: \(dq<sha of the commit from dist\-git>\(dq,
          \(dqnamespace\(dq: \(dqrpms\(dq,
          \(dqrepo\(dq: \(dqphp\-simplepie\(dq,
          \(dqstatus\(dq: \(dq<success/failure/aborted>\(dq,
          \(dqtest_guidance\(dq: \(dq<comma\-separated\-list\-of\-test\-suites\-to\-run>\(dq}

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- jms\-messaging:
      provider\-name: fedmsg
      msg\-type: CodeQualityChecksDone
      msg\-props: test
      msg\-content: test

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B join\-trigger()
Trigger a job after all the immediate downstream jobs have completed.
Requires the Jenkins \fI\%Join Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprojects\fP (\fIlist\fP) \-\- list of projects to trigger
.IP \(bu 2
\fBpublishers\fP (\fIlist\fP) \-\- list of triggers from publishers module that
defines projects that need to be triggered
.IP \(bu 2
\fBthreshold\fP (\fIstr\fP) \-\- result threshold to trigger jobs (optional).
Valid values are \(dqsuccess\(dq, \(dqunstable\(dq, \(dqfailure\(dq, and \(dqaborted\(dq.
.IP \(bu 2
\fBeven\-if\-unstable\fP (\fIbool\fP) \-\- if true jobs will trigger even if some
downstream jobs are marked as unstable (default false) (DEPRECATED)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- join\-trigger:
      projects:
        \- project\-one
        \- project\-two
      threshold: unstable
      publishers:
        \- trigger\-parameterized\-builds:
          \- project: archive
            current\-parameters: true
            trigger\-from\-child\-projects: true
            trigger\-with\-no\-params: true
          \- project: cleanup
            current\-parameters: true
            trigger\-with\-no\-params: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B junit()
Publish JUnit test results. Requires the Jenkins \fI\%JUnit
Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBresults\fP (\fIstr\fP) \-\- results filename (required)
.IP \(bu 2
\fBkeep\-long\-stdio\fP (\fIbool\fP) \-\- Retain long standard output/error in test
results (default true).
.IP \(bu 2
\fBhealth\-scale\-factor\fP (\fIfloat\fP) \-\- Amplification factor to apply to test
failures when computing the test result contribution to the build
health score. (default 1.0)
.IP \(bu 2
\fBallow\-empty\-results\fP (\fIbool\fP) \-\- Do not fail the build on empty test results
(default false)
.IP \(bu 2
\fBskip\-publishing\-checks\fP (\fIbool\fP) \-\- Do not publish issues to SCM provider
platforms (default false)
.IP \(bu 2
\fBskip\-marking\-build\-unstable\fP (\fIbool\fP) \-\- Do not mark build as unstable on
test failure (default false)
.IP \(bu 2
\fBtest\-stability\fP (\fIbool\fP) \-\- Add historical information about test
results stability (default false).
Requires the Jenkins \fI\%Test stability Plugin\fP\&.
.IP \(bu 2
\fBclaim\-build\fP (\fIbool\fP) \-\- Allow claiming of failed tests (default false)
Requires the Jenkins \fI\%Claim Plugin\fP\&.
.IP \(bu 2
\fBmeasurement\-plots\fP (\fIbool\fP) \-\- Create measurement plots (default false)
Requires the Jenkins \fI\%Measurement Plots Plugin\fP\&.
.IP \(bu 2
\fBflaky\-test\-reports\fP (\fIbool\fP) \-\- Publish flaky test reports (default false).
Requires the Jenkins \fI\%Flaky Test Handler Plugin\fP\&.
.IP \(bu 2
\fBjunit\-attachments\fP (\fIbool\fP) \-\- Publish test attachments (default false).
Requires the Jenkins \fI\%JUnit Attachments Plugin\fP\&.
.UNINDENT
.UNINDENT
.sp
Minimal example using defaults:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- junit:
    results: nosetests.xml

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- junit:
    results: nosetests\-example.xml
    keep\-long\-stdio: false
    health\-scale\-factor: 2.0
    allow\-empty\-results: true
    skip\-publishing\-checks: true
    skip\-marking\-build\-unstable: true
    test\-stability: true
    claim\-build: true
    measurement\-plots: true
    flaky\-test\-reports: true
    junit\-attachments: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B logparser()
Requires the Jenkins \fI\%Log Parser Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparse\-rules\fP (\fIstr\fP) \-\- full path to parse rules (default \(aq\(aq)
.IP \(bu 2
\fBuse\-project\-rules\fP (\fIbool\fP) \-\- use project rules instead of global
(default true)
.IP \(bu 2
\fBunstable\-on\-warning\fP (\fIbool\fP) \-\- mark build unstable on warning
(default false)
.IP \(bu 2
\fBfail\-on\-error\fP (\fIbool\fP) \-\- mark build failed on error (default false)
.IP \(bu 2
\fBshow\-graphs\fP (\fIbool\fP) \-\- show parser trend graphs (default true)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- logparser:
      parse\-rules: \(dqproject\-log\-parser\-rules.txt\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- logparser:
      use\-project\-rules: false
      parse\-rules: \(dq/path/to/global\-rules\(dq
      unstable\-on\-warning: true
      fail\-on\-error: true
      show\-graphs: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B logstash()
Send job\(aqs console log to Logstash for processing and analyis of
your job data. Also stores test metrics from Junit.
Requires the Jenkins \fI\%Logstash Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmax\-lines\fP (\fIint\fP) \-\- The maximum number of log lines to send to Logstash.
(default 1000)
.IP \(bu 2
\fBfail\-build\fP (\fIbool\fP) \-\- Mark build as failed if this step fails.
(default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- logstash

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- logstash:
      max\-lines: 2000
      fail\-build: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maven\-deploy()
Deploy artifacts to Maven repository.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBid\fP (\fIstr\fP) \-\- Repository ID
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- Repository URL (optional)
.IP \(bu 2
\fBunique\-version\fP (\fIbool\fP) \-\- Assign unique versions to snapshots
(default true)
.IP \(bu 2
\fBdeploy\-unstable\fP (\fIbool\fP) \-\- Deploy even if the build is unstable
(default false)
.IP \(bu 2
\fBrelease\-env\-var\fP (\fIstr\fP) \-\- If the given variable name is set to \(dqtrue\(dq,
the deploy steps are skipped. (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- maven\-deploy:
      id: example
      url: http://repo.example.com/maven2/
      unique\-version: true
      deploy\-unstable: false
      release\-env\-var: TIMER

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B mqtt()
This plugin lets you send build notifications to a MQTT message queue.
Requires the \fI\%MQTT Notification Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBbroker\-url\fP (\fIstr\fP) \-\- the broker URL, as protocol://address:port (required)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- credentials to use to connect to the broker
(optional)
.IP \(bu 2
\fBtopic\fP (\fIstr\fP) \-\- the message topic (default \(dqjenkins/$PROJECT_URL\(dq)
.IP \(bu 2
\fBmessage\fP (\fIstr\fP) \-\- the message itself (default \(dq$BUILD_RESULT\(dq)
.IP \(bu 2
\fBqos\fP (\fIstr\fP) \-\- one of AT_MOST_ONCE, AT_LEAST_ONCE, or EXACTLY_ONCE
(default AT_MOST_ONCE)
.IP \(bu 2
\fBretain\-message\fP (\fIbool\fP) \-\- whether to resend message or not when a new
client connects (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- mqtt:
      broker\-url: tcp://localhost:1883

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- mqtt:
      broker\-url: tcp://localhost:1883
      topic: hello
      message: world
      qos: EXACTLY_ONCE
      retain\-message: true
      credentials\-id: abcde

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B naginator()
Automatically reschedule a build after a build failure
Requires the Jenkins \fI\%Naginator Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrerun\-unstable\-builds\fP (\fIbool\fP) \-\- Rerun build for unstable builds as well
as failures (default false)
.IP \(bu 2
\fBrerun\-matrix\-part\fP (\fIbool\fP) \-\- Rerun build only for failed parts on the
matrix (>=1.12) (default false)
.IP \(bu 2
\fBfixed\-delay\fP (\fIint\fP) \-\- Fixed delay in seconds before retrying build (cannot
be used with progressive\-delay\-increment or progressive\-delay\-maximum.
This is the default delay type.  (default 0)
.IP \(bu 2
\fBprogressive\-delay\-increment\fP (\fIint\fP) \-\- Progressive delay in seconds before
retrying build increment (cannot be used when fixed\-delay is being
used) (default 0)
.IP \(bu 2
\fBprogressive\-delay\-maximum\fP (\fIint\fP) \-\- Progressive delay in seconds before
retrying maximum delay (cannot be used when fixed\-delay is being used)
(default 0)
.IP \(bu 2
\fBmax\-failed\-builds\fP (\fIint\fP) \-\- Maximum number of successive failed builds
(default 0)
.IP \(bu 2
\fBregular\-expression\fP (\fIstr\fP) \-\- Only rerun build if regular expression is
found in output (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- naginator:
      rerun\-unstable\-builds: true
      rerun\-matrix\-part: true
      progressive\-delay\-increment: 5
      progressive\-delay\-maximum: 15
      max\-failed\-builds: 6
      regular\-expression: \(dqfoo\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-build\-canceller()
This action is intended to provide cleanup for a Jenkins job which failed
because a build is hung (instead of terminating with a failure code);
this step will allow you to perform the equivalent of a oc cancel\-build
for the provided build config; any builds under that build config which
are not previously terminated (either successfully or unsuccessfully)
or cancelled will be cancelled.
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default \(aqhttps://openshift.default.svc.cluster.local\(aq)
.IP \(bu 2
\fBbld\-cfg\fP (\fIstr\fP) \-\- The value here should be whatever was the output
form \fIoc project\fP when you created the BuildConfig you
want to run a Build on (default \(aqfrontend\(aq)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default \(aqtest\(aq)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- openshift\-build\-canceller:
      api\-url: https://openshift.example.local.url/
      bld\-cfg: front
      namespace: test\-build
      auth\-token: ose\-key\-canceller1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- openshift\-build\-canceller

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-deploy\-canceller()
This action is intended to provide cleanup for any OpenShift deployments
left running when the Job completes; this step will allow you to perform
the equivalent of a oc deploy \-\-cancel for the provided deployment config.
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- this would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default \(aqhttps://openshift.default.svc.cluster.local\(aq)
.IP \(bu 2
\fBdep\-cfg\fP (\fIstr\fP) \-\- The value here should be whatever was the output
form \fIoc project\fP when you created the BuildConfig you want to run a
Build on (default frontend)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- If you run \fIoc get bc\fP for the project listed in
\(dqnamespace\(dq, that is the value you want to put here. (default \(aqtest\(aq)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- openshift\-deploy\-canceller:
      api\-url: https://openshift.example.local.url/
      dep\-cfg: front
      namespace: test6
      auth\-token: ose\-key\-dep\-canceller1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- openshift\-deploy\-canceller

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B opsgenie()
OpsGenie notification on build completion,
Requires the \fI\%OpsGenie Notifier Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenable\-sending\-alerts\fP (\fIbool\fP) \-\- Send alerts to opsgenie. (default false)
.IP \(bu 2
\fBnotify\-build\-start\fP (\fIbool\fP) \-\- Send a notification when the build starts. (default false)
.IP \(bu 2
\fBapi\-key\fP (\fIstr\fP) \-\- This token is used to verify requests between OpsGenie and Jenkins. You can copy this key from your OpsGenie\-Jenkins Integration page. (default \(aq\(aq)
.IP \(bu 2
\fBtags\fP (\fIstr\fP) \-\- Comma\-separated list of tags you want to add on alert. (default \(aq\(aq)
.IP \(bu 2
\fBteams\fP (\fIstr\fP) \-\- Comma\-separated list of teams that get notified from alert. (default \(aq\(aq)
.IP \(bu 2
\fBpriority\fP (\fIstr\fP) \-\- Set the priority of the alert that\(aqs going to be created at OpsGenie, if job\(aqs build fails. (default \(aqP3\(aq)
.IP \(bu 2
\fBbuild\-starts\-alerts\-priority\fP (\fIstr\fP) \-\- Set the priority of the build started alert that\(aqs going to be created at OpsGenie. (default \(aqP3\(aq)
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- Api url that collects the webhook. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- opsgenie

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- opsgenie:
    enable\-sending\-alerts: true
    notify\-build\-start: true
    api\-key: \(dqtest api key\(dq
    priority: \(dqP1\(dq
    build\-starts\-alerts\-priority: \(dqP2\(dq
    api\-url: \(dqanother\-opsgenie\-instance.com\(dq
    tags: \(dqa,b,c\(dq
    teams: \(dqteam a, team b\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B packer()
This plugin allows for a job to publish an image generated Packer
Requires the Jenkins \fI\%Packer Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of the packer installation (required)
.IP \(bu 2
\fBjson\-template\fP (\fIstr\fP) \-\- Path to a Packer JSON template file (default \(aq\(aq)
.IP \(bu 2
\fBjson\-template\-text\fP (\fIstr\fP) \-\- Text of Packer JSON template (default \(aq\(aq)
.IP \(bu 2
\fBadd\-params\fP (\fIstr\fP) \-\- Specify which additional parameters
to pass to packer (default \(aq\(aq)
.IP \(bu 2
\fBuse\-debug\fP (\fIbool\fP) \-\- adds \-debug argument when packer executes
(default false)
.IP \(bu 2
\fBchange\-dir\fP (\fIstr\fP) \-\- If set, the current directory will be changed
to this before starting packer (default \(aq\(aq)
.IP \(bu 2
\fBtemplate\-mode\fP (\fIstr\fP) \-\- 
.sp
Packer template option used (default global)
.INDENT 2.0
.TP
.B template\-mode values
.INDENT 7.0
.IP \(bu 2
\fBglobal\fP
.IP \(bu 2
\fBfile\fP
.IP \(bu 2
\fBtext\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfile\-entries\fP (\fIlist\fP) \-\- File entries for the packer
configuration (default [])
.IP \(bu 2
\fBvariable\-name\fP (\fIstr\fP) \-\- Variable name for a file to used in the
configuration JSON (default \(aq\(aq)
.IP \(bu 2
\fBcontents\fP (\fIstr\fP) \-\- File contents of the configuration JSON (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- packer:
      name: test name

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- packer:
      name: test name
      json\-template: test template
      json\-template\-text: test template text
      add\-params: additional params
      use\-debug: true
      change\-dir: change to directory
      template\-mode: global
      file\-entries:
        \- files:
            variable\-name: test var
            contents: test content
        \- files:
            variable\-name: test var 2
            contents: test content 2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B performance()
Publish performance test results from jmeter and junit.
Requires the Jenkins \fI\%Performance Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfailed\-threshold\fP (\fIint\fP) \-\- Specify the error percentage threshold that
set the build failed. A negative value means don\(aqt use this threshold
(default 0)
.IP \(bu 2
\fBunstable\-threshold\fP (\fIint\fP) \-\- Specify the error percentage threshold that
set the build unstable. A negative value means don\(aqt use this threshold
(default 0)
.IP \(bu 2
\fBunstable\-response\-time\-threshold\fP (\fIstr\fP) \-\- Average response time threshold
(default \(aq\(aq)
.IP \(bu 2
\fBfailed\-threshold\-positive\fP (\fIfloat\fP) \-\- Maximum failed percentage for build
comparison (default 0.0)
.IP \(bu 2
\fBfailed\-threshold\-negative\fP (\fIfloat\fP) \-\- Minimum failed percentage for build
comparison (default 0.0)
.IP \(bu 2
\fBunstable\-threshold\-positive\fP (\fIfloat\fP) \-\- Maximum unstable percentage for
build comparison (default 0.0)
.IP \(bu 2
\fBunstable\-threshold\-negative\fP (\fIfloat\fP) \-\- Minimum unstable percentage for
build comparison (default 0.0)
.IP \(bu 2
\fBnth\-build\-number\fP (\fIint\fP) \-\- Build number for build comparison (default 0)
.IP \(bu 2
\fBmode\-relative\-thresholds\fP (\fIbool\fP) \-\- Relative threshold mode (default false)
.IP \(bu 2
\fBconfig\-type\fP (\fIstr\fP) \-\- 
.sp
Compare based on (default \(aqART\(aq)
.INDENT 2.0
.TP
.B config\-type values
.INDENT 7.0
.IP \(bu 2
\fBART\fP \-\- Average Response Time
.IP \(bu 2
\fBMRT\fP \-\- Median Response Time
.IP \(bu 2
\fBPRT\fP \-\- Percentile Response Time
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBmode\-of\-threshold\fP (\fIbool\fP) \-\- Mode of threshold, true for relative threshold
and false for error threshold (default false)
.IP \(bu 2
\fBfail\-build\fP (\fIbool\fP) \-\- Fail build when result files are not present
(default false)
.IP \(bu 2
\fBcompare\-build\-previous\fP (\fIbool\fP) \-\- Compare with previous build
(default false)
.IP \(bu 2
\fBmode\-performance\-per\-test\-case\fP (\fIbool\fP) \-\- Performance Per Test Case Mode
(default true)
.IP \(bu 2
\fBmode\-thoughput\fP (\fIbool\fP) \-\- Show Throughput Chart (default false)
.IP \(bu 2
\fBreport\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B (jmeter or junit)
(\fIdict\fP or \fIstr\fP): Specify a custom report file
(optional; jmeter default **/\fI\&.jtl, junit default *\fP/TEST\-*.xml)
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- performance

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- performance:
      failed\-threshold: 85
      unstable\-threshold: \-1
      unstable\-response\-time\-threshold: \(dqJMeterResultsOrders.jtl:2000\(dq
      failed\-threshold\-positive: 90.0
      failed\-threshold\-negative: 10.0
      unstable\-threshold\-positive: 80.0
      unstable\-threshold\-negative: 20.0
      nth\-build\-number: 10
      mode\-relative\-thresholds: true
      config\-type: \(dqPRT\(dq
      mode\-of\-threshold: true
      fail\-build: true
      compare\-build\-previous: true
      mode\-performance\-per\-test\-case: false
      mode\-thoughput: true
      report:
        \- jmeter: \(dq/special/file.jtl\(dq
        \- junit: \(dq/special/file.xml\(dq
        \- jmeter
        \- junit

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B phabricator()
Integrate with \fI\%Phabricator\fP
.sp
Requires the Jenkins \fI\%Phabricator Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcomment\-on\-success\fP (\fIbool\fP) \-\- Post a \fIcomment\fP when the build
succeeds. (optional)
.IP \(bu 2
\fBuberalls\-enabled\fP (\fIbool\fP) \-\- Integrate with uberalls. (optional)
.IP \(bu 2
\fBcomment\-file\fP (\fIstr\fP) \-\- Include contents of given file if
commenting is enabled. (optional)
.IP \(bu 2
\fBcomment\-size\fP (\fIint\fP) \-\- Maximum comment character length. (optional)
.IP \(bu 2
\fBcomment\-with\-console\-link\-on\-failure\fP (\fIbool\fP) \-\- Post a \fIcomment\fP
when the build fails. (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- phabricator:
      comment\-on\-success: false
      uberalls\-enabled: false
      comment\-with\-console\-link\-on\-failure: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pipeline()
Specify a downstream project in a pipeline.
Requires the Jenkins \fI\%Build Pipeline Plugin\fP\&.
.sp
Use of the \fInode\-label\-name\fP or \fInode\-label\fP parameters
requires the Jenkins \fI\%NodeLabel Parameter Plugin\fP\&.
Note: \(aqnode\-parameters\(aq overrides the Node that the triggered
project is tied to.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBprojects\fP (\fIlist\fP) \-\- list the jobs to trigger, will generate comma\-separated
string containing the named jobs.
.IP \(bu 2
\fBpredefined\-parameters\fP (\fIstr\fP) \-\- parameters to pass to the other
job (optional)
.IP \(bu 2
\fBcurrent\-parameters\fP (\fIbool\fP) \-\- Whether to include the parameters passed
to the current build to the triggered job (optional)
.IP \(bu 2
\fBnode\-parameters\fP (\fIbool\fP) \-\- Use the same Node for the triggered builds
that was used for this build. (optional)
.IP \(bu 2
\fBsvn\-revision\fP (\fIbool\fP) \-\- Pass svn revision to the triggered job (optional)
.IP \(bu 2
\fBinclude\-upstream\fP (\fIbool\fP) \-\- Include/pass through Upstream SVN Revisons.
Only valid when \(aqsvn\-revision\(aq is true. (default false)
.IP \(bu 2
\fBgit\-revision\fP (\fIdict\fP) \-\- 
.sp
Passes git revision to the triggered job
(optional).
.INDENT 2.0
.IP \(bu 2
\fBcombine\-queued\-commits\fP (bool): Whether to combine queued git
hashes or not (default false)
.UNINDENT

.IP \(bu 2
\fBboolean\-parameters\fP (\fIdict\fP) \-\- Pass boolean parameters to the downstream
jobs. Specify the name and boolean value mapping of the parameters.
(optional)
.IP \(bu 2
\fBproperty\-file\fP (\fIstr\fP) \-\- Use properties from file (optional)
.IP \(bu 2
\fBfail\-on\-missing\fP (\fIbool\fP) \-\- Blocks the triggering of the downstream jobs
if any of the property files are not found in the workspace.
Only valid when \(aqproperty\-file\(aq is specified.
(default false)
.IP \(bu 2
\fBfile\-encoding\fP (\fIstr\fP) \-\- Encoding of contents of the files. If not
specified, default encoding of the platform is used. Only valid when
\(aqproperty\-file\(aq is specified. (optional)
.IP \(bu 2
\fBrestrict\-matrix\-project\fP (\fIstr\fP) \-\- Filter that restricts the subset
of the combinations that the downstream project will run (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- pipeline:
      project: test_project
      current\-parameters: true
      predefined\-parameters: foo=bar

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- pipeline:
      projects:
        \- test_project
      predefined\-parameters: BUILD_NUM=${BUILD_NUMBER}
      current\-parameters: true
      property\-file: vars.txt
      git\-revision:
        combine\-queued\-commits: true
      fail\-on\-missing: true
      file\-encoding: UTF\-8
      boolean\-parameters:
          p1: true
          p2: false
      svn\-revision: true
      include\-upstream: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can build pipeline jobs that are re\-usable in different pipelines by
using a \fI\%Job Template\fP to define the pipeline jobs,
and variable substitution to specify the name of
the downstream job in the pipeline.
Job\-specific substitutions are useful here (see \fI\%Project\fP).
.sp
See \(aqsamples/pipeline.yaml\(aq for an example pipeline implementation.
.UNINDENT
.INDENT 0.0
.TP
.B plot()
Plot provides generic plotting (or graphing).
.sp
Requires the Jenkins \fI\%Plot Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtitle\fP (\fIstr\fP) \-\- title for the graph (default \(aq\(aq)
.IP \(bu 2
\fByaxis\fP (\fIstr\fP) \-\- title of Y axis (default \(aq\(aq)
.IP \(bu 2
\fBwidth\fP (\fIint\fP) \-\- the width of the plot in pixels (default 750)
.IP \(bu 2
\fBheight\fP (\fIint\fP) \-\- the height of the plot in pixels (default 450)
.IP \(bu 2
\fBgroup\fP (\fIstr\fP) \-\- name of the group to which the plot belongs (required)
.IP \(bu 2
\fBnum\-builds\fP (\fIint\fP) \-\- number of builds to plot across
(default plot all builds)
.IP \(bu 2
\fBstyle\fP (\fIstr\fP) \-\- Specifies the graph style of the plot
Can be: area, bar, bar3d, line, line3d, stackedArea, stackedbar,
stackedbar3d, waterfall (default \(aqline\(aq)
.IP \(bu 2
\fBuse\-description\fP (\fIbool\fP) \-\- When false, the X\-axis labels are formed using
build numbers and dates, and the corresponding tooltips contain the
build descriptions. When enabled, the contents of the labels and
tooltips are swapped, with the descriptions used as X\-axis labels and
the build number and date used for tooltips. (default false)
.IP \(bu 2
\fBexclude\-zero\-yaxis\fP (\fIbool\fP) \-\- When false, Y\-axis contains the value zero
even if it is not included in the data series. When true, the value
zero is not automatically included. (default false)
.IP \(bu 2
\fBlogarithmic\-yaxis\fP (\fIbool\fP) \-\- When true, the Y\-axis will use a logarithmic
scale. By default, the Y\-axis uses a linear scale. (default false)
.IP \(bu 2
\fBkeep\-records\fP (\fIbool\fP) \-\- When true, show all builds up to \(aqNumber of
builds to include\(aq. (default false)
.IP \(bu 2
\fBcsv\-file\-name\fP (\fIstr\fP) \-\- Use for choosing the file name in which the data
will be persisted. If none specified and random name is generated as
done in the Jenkins Plot plugin. (default random generated .csv
filename, same behaviour as the Jenkins Plot plugin)
.IP \(bu 2
\fBseries\fP (\fIlist\fP) \-\- 
.sp
list data series definitions
.INDENT 2.0
.TP
.B Series
.INDENT 7.0
.IP \(bu 2
\fBfile\fP (\fIstr\fP) : files to include
.IP \(bu 2
\fBinclusion\-flag\fP filtering mode for CSV files. Possible
values are:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBoff\fP (default)
.IP \(bu 2
\fBinclude\-by\-string\fP
.IP \(bu 2
\fBexclude\-by\-string\fP
.IP \(bu 2
\fBinclude\-by\-column\fP
.IP \(bu 2
\fBexclude\-by\-column\fP
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBexclude\fP (\fIstr\fP) : exclude pattern for CSV file.
.IP \(bu 2
\fBurl\fP (\fIstr\fP) : for \(aqcsv\(aq and \(aqxml\(aq file types
used when you click on a point (default empty)
.IP \(bu 2
\fBdisplay\-table\fP (\fIbool\fP) : for \(aqcsv\(aq file type
if true, original CSV will be shown above plot (default false)
.IP \(bu 2
\fBlabel\fP (\fIstr\fP) : used by \(aqproperties\(aq file type
Specifies the legend label for this data series.
(default empty)
.IP \(bu 2
\fBformat\fP (\fIstr\fP) : Type of file where we get datas.
Can be: properties, csv, xml
.IP \(bu 2
\fBxpath\-type\fP (\fIstr\fP) : The result type of the expression must
be supplied due to limitations in the java.xml.xpath parsing.
The result can be: node, nodeset, boolean, string, or number.
Strings and numbers will be converted to double. Boolean will
be converted to 1 for true, and 0 for false. (default \(aqnode\(aq)
.IP \(bu 2
\fBxpath\fP (\fIstr\fP) : used by \(aqxml\(aq file type
Xpath which selects the values that should be plotted.
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- plot:
      \- yaxis: \(aq\(aq
        group: \(aqbench\(aq
        series:
            \- file: \(aqdata.csv\(aq
              format: \(aqcsv\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- plot:
    \- title: MyPlot
      yaxis: Y
      width: 900
      height: 1000
      csv\-file\-name: myplot.csv
      group: PlotGroup
      num\-builds: \(aq1\(aq
      style: line
      exclude\-zero\-yaxis: true
      logarithmic\-yaxis: true
      use\-description: true
      keep\-records: true
      series:
        \- file: graph\-me\-second.properties
          label: MyLabel
          format: properties
        \- file: graph\-me\-first.csv
          url: \(aqhttp://srv1\(aq
          inclusion\-flag: \(aqinclude\-by\-string\(aq
          exclude: \(aqColumn 1,Column 2,Column 3\(aq
          display\-table: true
          format: csv
    \- title: MyPlot2
      yaxis: Y
      csv\-file\-name: myplot2.csv
      group: PlotGroup
      style: bar
      use\-description: false
      series:
        \- file: graph\-me\-third.xml
          url: \(aqhttp://srv2\(aq
          format: xml
          xpath\-type: \(aqstring\(aq
          xpath: \(aq/*\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pmd()
Publish trend reports with PMD.
.sp
Requires the Jenkins PMD Plugin (\fI\%https://github.com/jenkinsci/pmd\-plugin\fP).
.sp
The PMD component accepts a dictionary with the following values:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- Report filename pattern (optional)
.IP \(bu 2
\fBcan\-run\-on\-failed\fP (\fIbool\fP) \-\- Also runs for failed builds, instead of just
stable or unstable builds (default false)
.IP \(bu 2
\fBshould\-detect\-modules\fP (\fIbool\fP) \-\- Determines if Ant or Maven modules should
be detected for all files that contain warnings (default false)
.IP \(bu 2
\fBhealthy\fP (\fIint\fP) \-\- Sunny threshold (optional)
.IP \(bu 2
\fBunhealthy\fP (\fIint\fP) \-\- Stormy threshold (optional)
.IP \(bu 2
\fBhealth\-threshold\fP (\fIstr\fP) \-\- Threshold priority for health status
(\(aqlow\(aq, \(aqnormal\(aq or \(aqhigh\(aq, defaulted to \(aqlow\(aq)
.IP \(bu 2
\fBthresholds\fP (\fIdict\fP) \-\- 
.sp
Mark build as failed or unstable if the number of
errors exceeds a threshold. (optional)
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B thresholds
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBunstable\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unstable
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfailed\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B failed
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBdefault\-encoding\fP (\fIstr\fP) \-\- Encoding for parsing or showing files (optional)
.IP \(bu 2
\fBdo\-not\-resolve\-relative\-paths\fP (\fIbool\fP) \-\- (default false)
.IP \(bu 2
\fBdont\-compute\-new\fP (\fIbool\fP) \-\- If set to false, computes new warnings based on
the reference build (default true)
.IP \(bu 2
\fBuse\-previous\-build\-as\-reference\fP (\fIbool\fP) \-\- determines whether to always
use the previous build as the reference build (default false)
.IP \(bu 2
\fBuse\-stable\-build\-as\-reference\fP (\fIbool\fP) \-\- The number of new warnings will be
calculated based on the last stable build, allowing reverts of unstable
builds where the number of warnings was decreased. (default false)
.IP \(bu 2
\fBuse\-delta\-values\fP (\fIbool\fP) \-\- If set then the number of new warnings is
calculated by subtracting the total number of warnings of the current
build from the reference build.
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
 \- pmd:
    pattern: \(aq**/pmd\-result.xml\(aq
    healthy: 0
    unhealthy: 100
    health\-threshold: \(aqhigh\(aq
    thresholds:
        unstable:
            total\-high: 10
        failed:
            total\-high: 1

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
 \- pmd:
    pattern: \(aq**/pmd\-result.xml\(aq
    can\-run\-on\-failed: true
    should\-detect\-modules: true
    healthy: 0
    unhealthy: 100
    health\-threshold: \(aqhigh\(aq
    thresholds:
        unstable:
            total\-all: 90
            total\-high: 80
            total\-normal: 70
            total\-low: 60
        failed:
            total\-all: 90
            total\-high: 80
            total\-normal: 70
            total\-low: 60
    default\-encoding: \(aqutf\-8\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B post\-tasks()
Adds support to post build task plugin
.sp
Requires the Jenkins \fI\%Post Build Task plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtask\fP (\fIdict\fP) \-\- Post build task definition
.IP \(bu 2
\fBtask\fP\fB[\fP\fBmatches\fP\fB]\fP (\fIlist\fP) \-\- list of matches when to run the task
.IP \(bu 2
\fBtask\fP\fB[\fP\fBmatches\fP\fB]\fP\fB[\fP\fB*\fP\fB]\fP (\fIdict\fP) \-\- match definition
.IP \(bu 2
\fBtask\fP\fB[\fP\fBmatches\fP\fB]\fP\fB[\fP\fB*\fP\fB]\fP\fB[\fP\fBlog\-text\fP\fB]\fP (\fIstr\fP) \-\- text to match against the log
.IP \(bu 2
\fBtask\fP\fB[\fP\fBmatches\fP\fB]\fP\fB[\fP\fB*\fP\fB]\fP\fB[\fP\fBoperator\fP\fB]\fP (\fIstr\fP) \-\- 
.sp
operator to apply with the next match
.INDENT 2.0
.TP
.B task[matches][*][operator] values (default \(aqAND\(aq)
.INDENT 7.0
.IP \(bu 2
\fBAND\fP
.IP \(bu 2
\fBOR\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtask\fP\fB[\fP\fBescalate\-status\fP\fB]\fP (\fIbool\fP) \-\- Escalate the task status to the job
(default \(aqfalse\(aq)
.IP \(bu 2
\fBtask\fP\fB[\fP\fBrun\-if\-job\-successful\fP\fB]\fP (\fIbool\fP) \-\- Run only if the job was successful
(default \(aqfalse\(aq)
.IP \(bu 2
\fBtask\fP\fB[\fP\fBscript\fP\fB]\fP (\fIstr\fP) \-\- Shell script to run (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- post\-tasks:
    \- matches:
      \- log\-text: line to match
        operator: AND
      \- log\-text: line to match
        operator: OR
      \- log\-text: line to match
        operator: AND
      escalate\-status: true
      run\-if\-job\-successful: true
      script: |
        echo \(dqHere goes the task script\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B postbuildscript()
Executes additional builders, script or Groovy after the build is
complete.
.sp
Requires the Jenkins \fI\%Post Build Script plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgeneric\-script\fP (\fIlist\fP) \-\- 
.sp
Series of Batch/Shell scripts to to run
.INDENT 2.0
.TP
.B generic\-script
.INDENT 7.0
.IP \(bu 2
\fBfile\-path\fP (\fIstr\fP) \- Path to Batch/Shell scripts
.IP \(bu 2
\fBrole\fP (\fIstr\fP) \- Execute scripts on. One of
MASTER / SLAVE / BOTH. (default \(aqBOTH\(aq)
.IP \(bu 2
\fBbuild\-on\fP (\fIlist\fP) \- Build statuses which trigger
the scripts. Valid options:
SUCCESS / UNSTABLE / FAILURE / NOT_BUILT / ABORTED
(default \(aqSUCCESS\(aq)
.IP \(bu 2
** execute\-on (\fIstr\fP) \- For matrix projects, scripts
can be run after each axis is built (\fIaxes\fP), after
all axis of the matrix are built (\fImatrix\fP) or after
each axis AND the matrix are built (\fIboth\fP). (default \fIboth\fP)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBgroovy\-script\fP (\fIlist\fP) \-\- 
.sp
Paths to Groovy scripts
.INDENT 2.0
.TP
.B groovy\-script
.INDENT 7.0
.IP \(bu 2
\fBfile\-path\fP (\fIstr\fP) \- Path to Groovy scripts
.IP \(bu 2
\fBrole\fP (\fIstr\fP) \- Execute scripts on. One of
MASTER / SLAVE / BOTH. (default \(aqBOTH\(aq)
.IP \(bu 2
\fBbuild\-on\fP (\fIlist\fP) \- Build statuses which trigger
the scripts. Valid options:
SUCCESS / UNSTABLE / FAILURE / NOT_BUILT / ABORTED
(default \(aqSUCCESS\(aq)
.IP \(bu 2
** execute\-on (\fIstr\fP) \- For matrix projects, scripts
can be run after each axis is built (\fIaxes\fP), after
all axis of the matrix are built (\fImatrix\fP) or after
each axis AND the matrix are built (\fIboth\fP). (default \fIboth\fP)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBgroovy\fP (\fIlist\fP) \-\- 
.sp
Inline Groovy
.INDENT 2.0
.TP
.B groovy
.INDENT 7.0
.IP \(bu 2
\fBcontent\fP (\fIstr\fP) \- Inline Groovy script.
.IP \(bu 2
\fBrole\fP (\fIstr\fP) \- Execute scripts on. One of
MASTER / SLAVE / BOTH. (default \(aqBOTH\(aq)
.IP \(bu 2
\fBbuild\-on\fP (\fIlist\fP) \- Build statuses which trigger
the scripts. Valid options:
SUCCESS / UNSTABLE / FAILURE / NOT_BUILT / ABORTED
(default \(aqSUCCESS\(aq)
.IP \(bu 2
** execute\-on (\fIstr\fP) \- For matrix projects, scripts
can be run after each axis is built (\fIaxes\fP), after
all axis of the matrix are built (\fImatrix\fP) or after
each axis AND the matrix are built (\fIboth\fP). (default \fIboth\fP)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbuilders\fP (\fIlist\fP) \-\- 
.sp
Execute any number of supported Jenkins builders.
.INDENT 2.0
.TP
.B builders
.INDENT 7.0
.IP \(bu 2
\fBbuild\-steps\fP (\fIstr\fP) \- Any supported builders,
see \fI\%Builders\fP\&.
.IP \(bu 2
\fBrole\fP (\fIstr\fP) \- Execute scripts on. One of
MASTER / SLAVE / BOTH. (default \(aqBOTH\(aq)
.IP \(bu 2
\fBbuild\-on\fP (\fIlist\fP) \- Build statuses which trigger
the scripts. Valid options:
SUCCESS / UNSTABLE / FAILURE / NOT_BUILT / ABORTED
(default \(aqSUCCESS\(aq)
.IP \(bu 2
** execute\-on (\fIstr\fP) \- For matrix projects, scripts
can be run after each axis is built (\fIaxes\fP), after
all axis of the matrix are built (\fImatrix\fP) or after
each axis AND the matrix are built (\fIboth\fP). (default \fIboth\fP)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBmark\-unstable\-if\-failed\fP (\fIbool\fP) \-\- Build will be marked unstable
if job will be successfully completed but publishing script will return
non zero exit code (default false)
.UNINDENT
.UNINDENT
.sp
Deprecated Options for versions < 2.0 of plugin:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBonsuccess\fP (\fIbool\fP) \-\- Deprecated, replaced with script\-only\-if\-succeeded
.IP \(bu 2
\fBscript\-only\-if\-succeeded\fP (\fIbool\fP) \-\- Scripts and builders are run only if
the build succeeded (default true)
.IP \(bu 2
\fBonfailure\fP (\fIbool\fP) \-\- Deprecated, replaced with script\-only\-if\-failed
.IP \(bu 2
\fBscript\-only\-if\-failed\fP (\fIbool\fP) \-\- Scripts and builders are run only if the
build failed (default false)
.IP \(bu 2
\fBexecute\-on\fP (\fIstr\fP) \-\- For matrix projects, scripts can be run after each
axis is built (\fIaxes\fP), after all axis of the matrix are built
(\fImatrix\fP) or after each axis AND the matrix are built (\fIboth\fP).
.UNINDENT
.UNINDENT
.sp
The \fIscript\-only\-if\-succeeded\fP and \fIbool script\-only\-if\-failed\fP options are
confusing. If you want the post build to always run regardless of the build
status, you should set them both to \fIfalse\fP\&.
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- postbuildscript

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- postbuildscript:
        mark\-unstable\-if\-failed: true
        generic\-script:
            \- file\-path: \(aq/fakepath/generic\(aq
              role: MASTER
              build\-on:
                  \- SUCCESS
                  \- UNSTABLE
            \- file\-path: \(aq/fakepath/generic\-two\(aq
              role: SLAVE
              build\-on:
                  \- NOT_BUILT
                  \- ABORTED
                  \- FAILURE
              execute\-on: matrix
        groovy\-script:
            \- file\-path: \(aq/fakepath/groovy\(aq
              role: MASTER
              build\-on:
                  \- SUCCESS
                  \- UNSTABLE
              execute\-on: axes
            \- file\-path: \(aq/fakepath/groovy\-too\(aq
              role: SLAVE
              build\-on:
                  \- NOT_BUILT
                  \- ABORTED
                  \- FAILURE
        groovy:
            \- role: MASTER
              build\-on:
                  \- SUCCESS
                  \- UNSTABLE
              execute\-on: matrix
              content: \(aqprintln \(dqHello world!\(dq\(aq
            \- role: SLAVE
              build\-on:
                  \- NOT_BUILT
                  \- ABORTED
                  \- FAILURE
              content: |
                  println \(dqHello world!\(dq
                  println \(dqMulti\-line script\(dq

        builders:
            \- role: MASTER
              build\-on:
                  \- SUCCESS
                  \- UNSTABLE
              execute\-on: axes
              build\-steps:
                  \- shell: \(aqecho \(dqHello world!\(dq\(aq
            \- role: SLAVE
              build\-on:
                  \- NOT_BUILT
                  \- ABORTED
                  \- FAILURE
              execute\-on: both
              build\-steps:
                  \- shell: \(aqecho \(dqHello world!\(dq\(aq
                  \- shell: \(aqecho \(dqGoodbye world!\(dq\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example(s) versions < 2.0:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- postbuildscript:
        generic\-script:
            \- \(aq/tmp/one.sh\(aq
            \- \(aq/tmp/two.sh\(aq
        groovy\-script:
            \- \(aq/tmp/one.groovy\(aq
            \- \(aq/tmp/two.groovy\(aq
        groovy:
            \- \(dq/** This is some inlined groovy */\(dq
            \- \(dq/** Some more inlined groovy */\(dq
        script\-only\-if\-succeeded: False
        script\-only\-if\-failed: True
        mark\-unstable\-if\-failed: True

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can also execute \fI\%builders\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- postbuildscript:
        builders:
            \- shell: \(aqecho \(dqShell execution\(dq\(aq
            \- ant: \(aqant_target\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Run once after the whole matrix (all axes) is built:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- postbuildscript:
        execute\-on: \(aqmatrix\(aq
        builders:
            \- shell: \(aqecho \(dqShell execution\(dq\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B publishers\-from()
Use publishers from another project.
Requires the Jenkins \fI\%Template Project Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBproject\-name\fP (\fIstr\fP) \-\- The name of the other project.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- publishers\-from:
      project\-name: base\-build

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B rich\-text\-publisher()
This plugin puts custom rich text message to the Build pages and Job main
page.
.sp
Requires the Jenkins \fI\%Rich Text Publisher Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBstable\-text\fP (\fIstr\fP) \-\- The stable text (required)
.IP \(bu 2
\fBunstable\-text\fP (\fIstr\fP) \-\- The unstable text if different from stable
(default \(aq\(aq)
.IP \(bu 2
\fBunstable\-as\-stable\fP (\fIbool\fP) \-\- The same text block is used for stable and
unstable builds (default true)
.IP \(bu 2
\fBfailed\-text\fP (\fIstr\fP) \-\- The failed text if different from stable (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-as\-stable\fP (\fIbool\fP) \-\- The same text block is used for stable and
failed builds (default true)
.IP \(bu 2
\fBparser\-name\fP (\fIstr\fP) \-\- HTML, Confluence or WikiText (default \(aqWikiText\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- rich\-text\-publisher:
        stable\-text: testing

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- rich\-text\-publisher:
        stable\-text: the stable text
        unstable\-text: the unstable text
        failed\-text: the failed text
        unstable\-as\-stable: false
        failed\-as\-stable: false
        parser\-name: HTML

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B robot()
Adds support for the Robot Framework Plugin
.sp
Requires the Jenkins \fI\%Robot Framework Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBoutput\-path\fP (\fIstr\fP) \-\- Path to directory containing robot xml and html files
relative to build workspace. (required)
.IP \(bu 2
\fBlog\-file\-link\fP (\fIstr\fP) \-\- Name of log or report file to be linked on jobs
front page (default \(aq\(aq)
.IP \(bu 2
\fBreport\-html\fP (\fIstr\fP) \-\- Name of the html file containing robot test report
(default \(aqreport.html\(aq)
.IP \(bu 2
\fBlog\-html\fP (\fIstr\fP) \-\- Name of the html file containing detailed robot test log
(default \(aqlog.html\(aq)
.IP \(bu 2
\fBoutput\-xml\fP (\fIstr\fP) \-\- Name of the xml file containing robot output
(default \(aqoutput.xml\(aq)
.IP \(bu 2
\fBpass\-threshold\fP (\fIstr\fP) \-\- Minimum percentage of passed tests to consider
the build successful (default 0.0)
.IP \(bu 2
\fBunstable\-threshold\fP (\fIstr\fP) \-\- Minimum percentage of passed test to
consider the build as not failed (default 0.0)
.IP \(bu 2
\fBonly\-critical\fP (\fIbool\fP) \-\- Take only critical tests into account when
checking the thresholds (default true)
.IP \(bu 2
\fBother\-files\fP (\fIlist\fP) \-\- list other files to archive (default \(aq\(aq)
.IP \(bu 2
\fBarchive\-output\-xml\fP (\fIbool\fP) \-\- Archive output xml file to server
(default true)
.IP \(bu 2
\fBenable\-cache\fP (\fIbool\fP) \-\- Enable cache for test results (default true)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- robot:
      output\-path: reports/robot

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- robot:
      output\-path: reports/robot
      log\-file\-link: report.html
      report\-html: custom\-report.html
      log\-html: custom\-log.html
      output\-xml: custom\-output.xml
      pass\-threshold: 80.0
      unstable\-threshold: 60.0
      only\-critical: false
      enable\-cache: false
      other\-files:
        \- extra\-file1.html
        \- extra\-file2.txt
      archive\-output\-xml: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B rocket()
RocketChat notification on build completion,
Requires the \fI\%RocketChat Notifier Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBchannel\fP (\fIstr\fP) \-\- Comma separated list of rooms (e.g. #project)
or persons (e.g. @john)
.IP \(bu 2
\fBabort\fP (\fIbool\fP) \-\- Notify abort (default false)
.IP \(bu 2
\fBstart\fP (\fIbool\fP) \-\- Notify start (default false)
.IP \(bu 2
\fBsuccess\fP (\fIbool\fP) \-\- Notify success (default false)
.IP \(bu 2
\fBfailure\fP (\fIbool\fP) \-\- Notify failure (default false)
.IP \(bu 2
\fBrepeated\-failure\fP (\fIbool\fP) \-\- Notify repeated failure (default false)
.IP \(bu 2
\fBback\-to\-normal\fP (\fIbool\fP) \-\- Notify back to normal (default false)
.IP \(bu 2
\fBnot\-built\fP (\fIbool\fP) \-\- Notify if not built (default false)
.IP \(bu 2
\fBunstable\fP (\fIbool\fP) \-\- Notify if unstable (default false)
.IP \(bu 2
\fBwebhook\-token\fP (\fIstr\fP) \-\- Webhook token for posting messages.
Overrides global authentication data and channel
.IP \(bu 2
\fBcommit\-info\fP (\fIstr\fP) \-\- 
.sp
What commit information to include into
notification message.
.INDENT 2.0
.TP
.B commit\-info values
.INDENT 7.0
.IP \(bu 2
\fBnone\fP
.IP \(bu 2
\fBauthors\fP
.IP \(bu 2
\fBauthors\-and\-titles\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBcustom\-message\fP (\fIstr\fP) \-\- Custom text message (default \(aq\(aq)
.IP \(bu 2
\fBtrust\-ssl\fP (\fIbool\fP) \-\- Trust RocketChat server certificate, if checked,
the SSL certificate will not be checked (default false)
.IP \(bu 2
\fBbuild\-server\fP (\fIstr\fP) \-\- Build Server URL
.IP \(bu 2
\fBattachments\fP (\fIlist\fP) \-\- 
.sp
Optional list of attachments
.INDENT 2.0
.TP
.B attachments
.INDENT 7.0
.IP \(bu 2
\fBtitle\fP (\fIstr\fP) Attachment title (required)
.IP \(bu 2
\fBtitle\-link\fP (\fIstr\fP)
.IP \(bu 2
\fBtitle\-link\-download\fP (\fIbool\fP)
.IP \(bu 2
\fBcolor\fP (\fIstr\fP)
.IP \(bu 2
\fBtext\fP (\fIstr\fP)
.IP \(bu 2
\fBcollapsed\fP (\fIbool\fP)
.IP \(bu 2
\fBmessage\-link\fP (\fIstr\fP)
.IP \(bu 2
\fBauthor\-name\fP (\fIstr\fP)
.IP \(bu 2
\fBauthor\-link\fP (\fIstr\fP)
.IP \(bu 2
\fBauthor\-icon\fP (\fIstr\fP)
.IP \(bu 2
\fBthumb\fP (\fIstr\fP) Thumb URL
.IP \(bu 2
\fBimage\fP (\fIstr\fP) Image URL
.IP \(bu 2
\fBaudio\fP (\fIstr\fP) Audio URL
.IP \(bu 2
\fBvideo\fP (\fIstr\fP) Video URL
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal example using defaults:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- rocket:
    channel: \(aq\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- rocket:
    channel: \(aq#channel,@user\(aq
    abort: true
    back\-to\-normal: true
    failure: true
    not\-built: true
    repeated\-failure: true
    start: true
    success: true
    unstable: true
    trust\-ssl: true
    build\-server: \(aqhttp://localhost:8080/\(aq
    webhook\-token: \(aqnon\-secure\-webhook\-token\(aq
    webhook\-token\-credential\-id: \(aqsecret\-text\-id\(aq
    commit\-info: \(aqauthors\-and\-titles\(aq
    include\-custom\-message: true
    include\-test\-log: true
    include\-test\-summary: true
    custom\-message: \(aqHello World!\(aq
    raw\-message: true
    attachments:
        \- title: The Black
        \- title: The Red
          color: red
        \- title: The Blue
          color: blue
          text: The navy blue
        \- title: The White
          title\-link: title_link
          title\-link\-download: true
          message\-link: message_link
          color: white
          text: \(aqAll&all\(aq
          collapsed: true
          author\-name: author_name
          author\-link: author_link
          author\-icon: author_icon
          thumb: \(aqhttp://hostname/thumb.png\(aq
          image: \(aqhttp://hostname/image.jpg\(aq
          audio: \(aqhttp://hostname/audio.mp3\(aq
          video: \(aqhttp://hostname/video.avi\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ruby\-metrics()
Rcov plugin parses rcov html report files and
shows it in Jenkins with a trend graph.
.sp
Requires the Jenkins \fI\%Ruby metrics plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreport\-dir\fP (\fIstr\fP) \-\- Relative path to the coverage report directory
.IP \(bu 2
\fBtargets\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B targets
(total\-coverage, code\-coverage)
.INDENT 7.0
.IP \(bu 2
\fBhealthy\fP (\fIint\fP): Healthy threshold
.IP \(bu 2
\fBunhealthy\fP (\fIint\fP): Unhealthy threshold
.IP \(bu 2
\fBunstable\fP (\fIint\fP): Unstable threshold
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- ruby\-metrics:
      report\-dir: \(dqcoverage/rcov\(dq
      target:
        \- total\-coverage:
             healthy: 80
             unhealthy: 0
             unstable: 0
        \- code\-coverage:
             healthy: 80
             unhealthy: 0
             unstable: 0

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B rundeck()
Trigger a rundeck job when the build is complete.
.sp
Requires the Jenkins \fI\%RunDeck Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBjob\-id\fP (\fIstr\fP) \-\- The RunDeck job identifier. (required)
This could be:
* ID example : \(dq42\(dq
* UUID example : \(dq2027ce89\-7924\-4ecf\-a963\-30090ada834f\(dq
* reference, in the format : \(dqproject:group/job\(dq
.IP \(bu 2
\fBoptions\fP (\fIstr\fP) \-\- List of options for the Rundeck job, in Java\-Properties
format: key=value (default \(dq\(dq)
.IP \(bu 2
\fBnode\-filters\fP (\fIstr\fP) \-\- List of filters to optionally filter the nodes
included by the job. (default \(dq\(dq)
.IP \(bu 2
\fBtag\fP (\fIstr\fP) \-\- Used for on\-demand job scheduling on rundeck: if a tag is
specified, the job will only execute if the given tag is present in the
SCM changelog. (default \(dq\(dq)
.IP \(bu 2
\fBwait\-for\-rundeck\fP (\fIbool\fP) \-\- If true Jenkins will wait for the job to
complete, if false the job will be started and Jenkins will move on.
(default false)
.IP \(bu 2
\fBfail\-the\-build\fP (\fIbool\fP) \-\- If true a RunDeck job failure will cause the
Jenkins build to fail. (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
 \- rundeck:
    job\-id: testproject:group/jobname

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
 \- rundeck:
    job\-id: testproject:group/jobname
    options: |
      STUFF_FOR_THE_JOB=stuff
      ANOTHER_VAR=more_stuff
    node\-filters: dev
    tag: master
    wait\-for\-rundeck: true
    fail\-the\-build: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B s3()
Upload build artifacts to Amazon S3.
.sp
Requires the Jenkins \fI\%S3 plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBs3\-profile\fP (\fIstr\fP) \-\- Globally\-defined S3 profile to use
.IP \(bu 2
\fBdont\-wait\-for\-concurrent\-builds\fP (\fIbool\fP) \-\- Don\(aqt wait
for completion of concurrent builds before publishing to S3
(default false)
.IP \(bu 2
\fBentries\fP (\fIlist\fP) \-\- .INDENT 2.0
.TP
.B entries
.INDENT 7.0
.IP \(bu 2
\fBdestination\-bucket\fP (\fIstr\fP) \- Destination S3 bucket
.IP \(bu 2
\fBsource\-files\fP (\fIstr\fP) \- Source files (Ant glob syntax)
.IP \(bu 2
\fBstorage\-class\fP (\fIstr\fP) \- S3 storage class; one of \(dqSTANDARD\(dq
or \(dqREDUCED_REDUNDANCY\(dq
.IP \(bu 2
\fBbucket\-region\fP (\fIstr\fP) \- S3 bucket region (capitalized with
underscores)
.IP \(bu 2
\fBupload\-on\-failure\fP (\fIbool\fP) \- Upload files even if the build
failed (default false)
.IP \(bu 2
\fBupload\-from\-slave\fP (\fIbool\fP) \- Perform the upload directly from
the Jenkins slave rather than the master node. (default false)
.IP \(bu 2
\fBmanaged\-artifacts\fP (\fIbool\fP) \- Let Jenkins fully manage the
published artifacts, similar to when artifacts are published to
the Jenkins master. (default false)
.IP \(bu 2
\fBs3\-encryption\fP (\fIbool\fP) \- Use S3 AES\-256 server side encryption
support. (default false)
.IP \(bu 2
\fBflatten\fP (\fIbool\fP) \- Ignore the directory structure of the
artifacts in the source project and copy all matching artifacts
directly into the specified bucket. (default false)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBmetadata\-tags\fP (\fIlist\fP) \-\- .INDENT 2.0
.TP
.B metadata\-tags
.INDENT 7.0
.IP \(bu 2
\fBkey\fP Metadata key for files from this build. It will be
prefixed by \(dqx\-amz\-meta\-\(dq when uploaded to S3. Can contain macros
(e.g. environment variables).
.IP \(bu 2
\fBvalue\fP Metadata value associated with the key. Can contain macros.
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- s3:
      s3\-profile: banana
      dont\-wait\-for\-concurrent\-builds: true
      entries:
        \- destination\-bucket: herp\-derp
          source\-files: \(aqbargle_${BUILD_ID}.tgz\(aq
          storage\-class: STANDARD
          bucket\-region: US_EAST_1
          upload\-on\-failure: false
          upload\-from\-slave: true
          managed\-artifacts: true
          s3\-encryption: true
          flatten: true
      metadata\-tags:
        \- key: warbl ${garbl}
          value: herp derp weevils
        \- key: hurrdurr
          value: wharrgarbl blee ${FANCY_VARIABLE}

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B scan\-build()
Publishes results from the Clang scan\-build static analyzer.
.sp
The scan\-build report has to be generated in the directory
\fB${WORKSPACE}/clangScanBuildReports\fP for the publisher to find it.
.sp
Requires the Jenkins \fI\%Clang Scan\-Build Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmark\-unstable\fP (\fIbool\fP) \-\- Mark build as unstable if the number of bugs
exceeds a threshold (default false)
.IP \(bu 2
\fBthreshold\fP (\fIint\fP) \-\- Threshold for marking builds as unstable (default 0)
.IP \(bu 2
\fBexclude\-paths\fP (\fIstr\fP) \-\- Comma separated paths to exclude from reports
(>=1.5) (default \(aq\(aq)
.IP \(bu 2
\fBreport\-folder\fP (\fIstr\fP) \-\- Folder where generated reports are located
(>=1.7) (default \(aqclangScanBuildReports\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- scan\-build:
      mark\-unstable: true
      threshold: 50
      exclude\-paths: external\-lib
      report\-folder: scan\-build\-report

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- scan\-build

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B scoverage()
Publish scoverage results as a trend graph.
Requires the Jenkins \fI\%Scoverage Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreport\-directory\fP (\fIstr\fP) \-\- This is a directory that specifies the locations
where the xml scoverage report is generated (required)
.IP \(bu 2
\fBreport\-file\fP (\fIstr\fP) \-\- This is a file name that is given to the xml
scoverage report (required)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- scoverage:
      report\-directory: target/scala\-2.10/scoverage\-report/
      report\-file: scoverage.xml

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B scp()
Upload files via SCP
Requires the Jenkins \fI\%SCP Plugin\fP\&.
.sp
When writing a publisher macro, it is important to keep in mind that
Jenkins uses Ant\(aqs \fI\%SCP Task\fP via the Jenkins
\fI\%SCP Plugin\fP which relies on \fI\%FileSet\fP
and \fI\%DirSet\fP patterns.
The relevant piece of documentation is excerpted below:
.INDENT 7.0
.INDENT 3.5
Source points to files which will be uploaded. You can use ant
includes syntax, eg. \fBfolder/dist/*.jar\fP\&. Path is constructed from
workspace root. Note that you cannot point files outside the workspace
directory.  For example providing: \fB\&../myfile.txt\fP won\(aqt work...
Destination points to destination folder on remote site. It will be
created if doesn\(aqt exists and relative to root repository path. You
can define multiple blocks of source/destination pairs.
.UNINDENT
.UNINDENT
.sp
This means that absolute paths, e.g., \fB/var/log/**\fP will not work and
will fail to compile. All paths need to be relative to the directory that
the publisher runs and the paths have to be contained inside of that
directory. The relative working directory is usually:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
/home/jenkins/workspace/${JOB_NAME}
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fIstr\fP) \-\- name of the scp site (required)
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- destination directory (required)
.IP \(bu 2
\fBsource\fP (\fIstr\fP) \-\- source path specifier (default \(aq\(aq)
.IP \(bu 2
\fBkeep\-hierarchy\fP (\fIbool\fP) \-\- keep the file hierarchy when uploading
(default false)
.IP \(bu 2
\fBcopy\-after\-failure\fP (\fIbool\fP) \-\- copy files even if the job fails
(default false)
.IP \(bu 2
\fBcopy\-console\fP (\fIbool\fP) \-\- copy the console log (default false); if
specified, omit \(aqsource\(aq
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- scp:
      site: \(aqexample.com\(aq
      files:
        \- target: \(aqdest/dir\(aq
          source: \(aqbase/source/dir/**\(aq
          keep\-hierarchy: true
          copy\-after\-failure: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B shining\-panda()
Publish coverage.py results. Requires the Jenkins
\fI\%ShiningPanda Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBhtml\-reports\-directory\fP (\fIstr\fP) \-\- path to coverage.py html results
(optional)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- shining\-panda:
      html\-reports\-directory: foo/bar/coveragepy_html_report/

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sitemonitor()
This plugin checks the availability of an url.
.sp
It requires the \fI\%sitemonitor plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBsites\fP (\fIlist\fP) \-\- List of URLs to check
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- sitemonitor

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- sitemonitor:
      sites:
        \- url: http://foo.example.com
        \- url: http://bar.example.com:8080/

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B slack()
Publisher that sends slack notifications on job events.
.sp
Requires the Jenkins \fI\%Slack Plugin\fP
.sp
When using Slack Plugin version < 2.0, Slack Plugin itself requires a
publisher as well as properties please note that you have to create those
too.  When using Slack Plugin version >= 2.0, you should only configure the
publisher.
.sp
For backward compatibility, the publisher needs to query version of the
Slack Plugin. Hence the \fBquery_plugins_info\fP parameter shouldn\(aqt be set
to \fBFalse\fP in the \fBjenkins\fP section of the configuration file.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBteam\-domain\fP (\fIstr\fP) \-\- Your team\(aqs domain at slack. (default \(aq\(aq)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The integration token to be used when sending
notifications. (default \(aq\(aq)
.IP \(bu 2
\fBauth\-token\-id\fP (\fIstr\fP) \-\- Allows credentials to be stored in Jenkins.
(default \(aq\(aq)
.IP \(bu 2
\fBbuild\-server\-url\fP (\fIstr\fP) \-\- Specify the URL for your server installation.
(default \(aq/\(aq)
.IP \(bu 2
\fBroom\fP (\fIstr\fP) \-\- A comma separated list of rooms / channels to post the
notifications to. (default \(aq\(aq)
.IP \(bu 2
\fBnotify\-start\fP (\fIbool\fP) \-\- Send notification when the job starts (>=2.0).
(default false)
.IP \(bu 2
\fBnotify\-success\fP (\fIbool\fP) \-\- Send notification on success (>=2.0).
(default false)
.IP \(bu 2
\fBnotify\-aborted\fP (\fIbool\fP) \-\- Send notification when job is aborted (>=2.0).
(default false)
.IP \(bu 2
\fBnotify\-not\-built\fP (\fIbool\fP) \-\- Send notification when job set to NOT_BUILT
status (>=2.0). (default false)
.IP \(bu 2
\fBnotify\-unstable\fP (\fIbool\fP) \-\- Send notification when job becomes unstable
(>=2.0). (default false)
.IP \(bu 2
\fBnotify\-failure\fP (\fIbool\fP) \-\- Send notification when job fails for the first
time (previous build was a success) (>=2.0).  (default false)
.IP \(bu 2
\fBnotify\-every\-failure\fP (\fIbool\fP) \-\- Send notification every time a job fails
(>=2.23). (default false)
.IP \(bu 2
\fBnotify\-back\-to\-normal\fP (\fIbool\fP) \-\- Send notification when job is succeeding
again after being unstable or failed (>=2.0). (default false)
.IP \(bu 2
\fBnotify\-repeated\-failure\fP (\fIbool\fP) \-\- Send notification when job fails
successively (previous build was also a failure) (>=2.0).
(default false)
.IP \(bu 2
\fBnotify\-regression\fP (\fIbool\fP) \-\- Send notification when number of failed tests
increased or the failed tests are different than previous build
(>=2.2). (default false)
.IP \(bu 2
\fBinclude\-failed\-tests\fP (\fIbool\fP) \-\- includes all failed tests when some tests
failed. does nothing if no failed tests were found (>=2.2).
(default false)
.IP \(bu 2
\fBinclude\-test\-summary\fP (\fIbool\fP) \-\- Include the test summary (>=2.0).
(default false)
.IP \(bu 2
\fBcommit\-info\-choice\fP (\fIstr\fP) \-\- What commit information to include into
notification message, \(dqNONE\(dq includes nothing about commits, \(dqAUTHORS\(dq
includes commit list with authors only, and \(dqAUTHORS_AND_TITLES\(dq
includes commit list with authors and titles (>=2.0). (default \(dqNONE\(dq)
.IP \(bu 2
\fBinclude\-custom\-message\fP (\fIbool\fP) \-\- Include a custom message into the
notification (>=2.0). (default false)
.IP \(bu 2
\fBcustom\-message\fP (\fIstr\fP) \-\- Custom message to be included for all statuses
(>=2.0). (default \(aq\(aq)
.IP \(bu 2
\fBcustom\-message\-success\fP (\fIstr\fP) \-\- Custom message for succesful builds
(>=2.10). (default \(aq\(aq)
.IP \(bu 2
\fBcustom\-message\-aborted\fP (\fIstr\fP) \-\- Custom message for aborted builds
(>=2.10). (default \(aq\(aq)
.IP \(bu 2
\fBcustom\-message\-not\-built\fP (\fIstr\fP) \-\- Custom message for not\-built
(>=2.10). (default \(aq\(aq)
.IP \(bu 2
\fBcustom\-message\-unstable\fP (\fIstr\fP) \-\- Custom message for unstable builds
(>=2.10). (default \(aq\(aq)
.IP \(bu 2
\fBcustom\-message\-failure\fP (\fIstr\fP) \-\- Custom message for failed builds
(>=2.10). (default \(aq\(aq)
.IP \(bu 2
\fBauth\-token\-credential\-id\fP (\fIstr\fP) \-\- The ID for the integration token from
the Credentials plugin to be used to send notifications to Slack.
(>=2.1) (default \(aq\(aq)
.IP \(bu 2
\fBbot\-user\fP (\fIbool\fP) \-\- This option indicates the token belongs to a bot user
in Slack. (>=2.2) (default False)
.IP \(bu 2
\fBbase\-url\fP (\fIstr\fP) \-\- Your Slack compatible Base URL. \fBbot\-user\fP is not
supported with Base URL. (>=2.2) (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example (version < 2.0):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- slack:
      room: \(aq#builds\(aq
      team\-domain: \(aqteamname\(aq
      auth\-token: \(aqyourauthtoken\(aq
      auth\-token\-id: \(aqyourauthtokenid\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal example (version >= 2.0):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- slack

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example (version >= 2.10):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- slack:
      team\-domain: \(aqteamname\(aq
      auth\-token: \(aqyourauthtoken\(aq
      auth\-token\-id: \(aqyourauthtokenid\(aq
      build\-server\-url: \(aqhttp://localhost:8081\(aq
      room: \(aq#builds\(aq
      notify\-start: True
      notify\-success: True
      notify\-aborted: True
      notify\-not\-built: True
      notify\-unstable: True
      notify\-failure: True
      notify\-every\-failure: True
      notify\-back\-to\-normal: True
      notify\-repeated\-failure: True
      notify\-regression: True
      include\-test\-summary: True
      include\-failed\-tests: True
      commit\-info\-choice: \(aqAUTHORS_AND_TITLES\(aq
      include\-custom\-message: True
      custom\-message: \(aqA custom message.\(aq
      custom\-message\-success: \(aqA custom message for sucessful builds.\(aq
      custom\-message\-aborted: \(aqA custom message for aborted builds.\(aq
      custom\-message\-not\-built: \(aqA custom message for not\-built.\(aq
      custom\-message\-unstable: \(aqA custom message for unstable builds.\(aq
      custom\-message\-failure: \(aqA custom message for failed builds.\(aq
      auth\-token\-credential\-id: yourauthtoken
      bot\-user: True
      base\-url: https://hooks.slack.com/services/

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sloccount()
Generates the trend report for SLOCCount
.sp
Requires the Jenkins \fI\%SLOCCount Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreport\-files\fP (\fIstr\fP) \-\- Setting that specifies the generated raw
SLOCCount report files. Be sure not to include any non\-report files
into this pattern. The report files must have been generated by
sloccount using the \(dq\-\-wide \-\-details\(dq options.
(default \(aq**/sloccount.sc\(aq)
.IP \(bu 2
\fBcharset\fP (\fIstr\fP) \-\- The character encoding to be used to read the SLOCCount
result files. (default \(aqUTF\-8\(aq)
.IP \(bu 2
\fBbuilds\-in\-graph\fP (\fIint\fP) \-\- Maximal number of last successful builds, that
are displayed in the trend graphs. (default 0)
.IP \(bu 2
\fBcomment\-is\-code\fP (\fIbool\fP) \-\- This option is considered only in the cloc
report parser and is ignored in the SLOCCount one. (default false)
.IP \(bu 2
\fBignore\-build\-failure\fP (\fIbool\fP) \-\- Try to process the report files even if
the build is not successful. (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- sloccount

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- sloccount:
      report\-files: sloccount.sc
      charset: latin\-1
      builds\-in\-graph: 1
      comment\-is\-code: true
      ignore\-build\-failure: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sonar()
Sonar plugin support.
Requires the Jenkins \fI\%Sonar Plugin.\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinstallation\-name\fP (\fIstr\fP) \-\- name of the Sonar instance to use (optional)
.IP \(bu 2
\fBjdk\fP (\fIstr\fP) \-\- JDK to use (inherited from the job if omitted). (optional)
.IP \(bu 2
\fBbranch\fP (\fIstr\fP) \-\- branch onto which the analysis will be posted (default \(aq\(aq)
.IP \(bu 2
\fBlanguage\fP (\fIstr\fP) \-\- source code language (default \(aq\(aq)
.IP \(bu 2
\fBroot\-pom\fP (\fIstr\fP) \-\- Root POM (default \(aqpom.xml\(aq)
.IP \(bu 2
\fBprivate\-maven\-repo\fP (\fIbool\fP) \-\- If true, use private Maven repository.
(default false)
.IP \(bu 2
\fBmaven\-opts\fP (\fIstr\fP) \-\- options given to maven (default \(aq\(aq)
.IP \(bu 2
\fBadditional\-properties\fP (\fIstr\fP) \-\- sonar analysis parameters (default \(aq\(aq)
.IP \(bu 2
\fBmaven\-installation\-name\fP (\fIstr\fP) \-\- the name of the Maven installation
to use (optional)
.IP \(bu 2
\fBskip\-global\-triggers\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B Triggers
.INDENT 7.0
.IP \(bu 2
\fBskip\-when\-scm\-change\fP (\fIbool\fP): skip analysis when
build triggered by scm (default false)
.IP \(bu 2
\fBskip\-when\-upstream\-build\fP (\fIbool\fP): skip analysis when
build triggered by an upstream build (default false)
.IP \(bu 2
\fBskip\-when\-envvar\-defined\fP (\fIstr\fP): skip analysis when
the specified environment variable is set to true
(default \(aq\(aq)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBsettings\fP (\fIstr\fP) \-\- Path to use as user settings.xml. It is possible to
provide a ConfigFileProvider settings file, see Example below.
(optional)
.IP \(bu 2
\fBglobal\-settings\fP (\fIstr\fP) \-\- Path to use as global settings.xml. It is
possible to provide a ConfigFileProvider settings file, see Example
below. (optional)
.UNINDENT
.UNINDENT
.sp
Requires the Jenkins \fI\%Config File Provider Plugin\fP
for the Config File Provider \(dqsettings\(dq and \(dqglobal\-settings\(dq config.
.sp
This publisher supports the post\-build action exposed by the Jenkins
Sonar Plugin, which is triggering a Sonar Analysis with Maven.
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- sonar

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- sonar:
      installation\-name: MySonar
      jdk: MyJdk
      branch: myBranch
      language: java
      root\-pom: mypom.xml
      private\-maven\-repo: true
      maven\-installation\-name: Maven3.3.3
      maven\-opts: \-DskipTests
      additional\-properties: \-DsonarHostURL=http://example.com/
      skip\-global\-triggers:
        skip\-when\-scm\-change: true
        skip\-when\-upstream\-build: true
        skip\-when\-envvar\-defined: SKIP_SONAR
      settings: org.jenkinsci.plugins.configfiles.maven.MavenSettingsConfig0123456789012
      global\-settings: org.jenkinsci.plugins.configfiles.maven.GlobalMavenSettingsConfig0123456789012

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sounds()
Play audio clips locally through sound hardware,
remotely by piping them through an operating system command,
or simultaneously through all browsers on a Jenkins page.
.sp
Requires the Jenkins \fI\%Jenkins Sounds plugin\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsuccess\fP (\fIdict\fP) \-\- 
.sp
Play on success
.INDENT 2.0
.TP
.B success
.INDENT 7.0
.IP \(bu 2
\fBsound\fP (\fIstr\fP) \- Sound name
.IP \(bu 2
.INDENT 2.0
.TP
\fBfrom\fP (\fIlist\fP) \- Previous build result (default is all)
.INDENT 7.0
.TP
.B from values
.INDENT 7.0
.IP \(bu 2
\fBsuccess\fP
.IP \(bu 2
\fBunstable\fP
.IP \(bu 2
\fBfailure\fP
.IP \(bu 2
\fBnot_build\fP
.IP \(bu 2
\fBaborted\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBunstable\fP (\fIdict\fP) \-\- Play on unstable.
Specifying sound and conditions see \fI\%above\fP\&.
.IP \(bu 2
\fBfailure\fP (\fIdict\fP) \-\- Play on failure.
Specifying sound and conditions see \fI\%above\fP\&.
.IP \(bu 2
\fBnot_build\fP (\fIdict\fP) \-\- Play on not build.
Specifying sound and conditions see \fI\%above\fP\&.
.IP \(bu 2
\fBaborted\fP (\fIdict\fP) \-\- Play on aborted.
Specifying sound and conditions see \fI\%above\fP\&.
.UNINDENT
.UNINDENT
.sp
Minimal example using defaults:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- sounds:
    failure:
      sound: EXPLODE

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
\- sounds:
    failure:
      sound: EXPLODE
      from:
        \- not_build
        \- aborted
    success:
      sound: Yahoo.Yodel
      from:
        \- unstable
        \- success
        \- failure

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ssh()
Upload files via SCP.
Requires the Jenkins \fI\%Publish over SSH Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsite\fP (\fIstr\fP) \-\- name of the ssh site
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- destination directory
.IP \(bu 2
\fBtarget\-is\-date\-format\fP (\fIbool\fP) \-\- whether target is a date format. If true,
raw text should be quoted (default false)
.IP \(bu 2
\fBclean\-remote\fP (\fIbool\fP) \-\- should the remote directory be deleted before
transferring files (default false)
.IP \(bu 2
\fBsource\fP (\fIstr\fP) \-\- source path specifier
.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- a command to execute on the remote server (optional)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \-\- timeout in milliseconds for the Exec command (optional)
.IP \(bu 2
\fBuse\-pty\fP (\fIbool\fP) \-\- run the exec command in pseudo TTY (default false)
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \-\- excluded file pattern (optional)
.IP \(bu 2
\fBremove\-prefix\fP (\fIstr\fP) \-\- prefix to remove from uploaded file paths
(optional)
.IP \(bu 2
\fBfail\-on\-error\fP (\fIbool\fP) \-\- fail the build if an error occurs (default false).
.IP \(bu 2
\fBalways\-publish\-from\-master\fP (\fIbool\fP) \-\- transfer the files through the master
before being sent to the remote server (defaults false)
.IP \(bu 2
\fBflatten\fP (\fIbool\fP) \-\- only create files on the server, don\(aqt create
directories (default false).
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- adds lots of detail useful for debug to the console
but generally should be left off (default false)
.IP \(bu 2
\fBretries\fP (\fIint\fP) \-\- the number of times to retry this server in the event of
failure (optional)
.IP \(bu 2
\fBretry\-delay\fP (\fIint\fP) \-\- the time to wait, in milliseconds, before attempting
another transfer (default 10000)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- ssh:
      site: \(aqserver.example.com\(aq
      target: \(aqdest/dir/\(aq
      source: \(aqbase/source/dir/**\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- ssh:
      site: \(aqserver.example.com\(aq
      target: \(dq\(aqdest/dir/\(aqyyyyMMddHHmmss\(dq
      target\-is\-date\-format: true
      clean\-remote: true
      source: \(aqbase/source/dir/**\(aq
      command: \(aqrm \-r jenkins_$BUILD_NUMBER\(aq
      timeout: 1800000
      use\-pty: true
      excludes: \(aq**/*.excludedfiletype\(aq
      remove\-prefix: \(aqbase/source/dir\(aq
      fail\-on\-error: true
      always\-publish\-from\-master: true
      flatten: true
      verbose: true
      retries: 99
      retry\-delay: 12345

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B stash()
This plugin will configure the Jenkins BitBucket Server Notifier plugin to
notify Atlassian BitBucket after job completes.
.sp
Requires the Jenkins \fI\%Bitbucket Server Notifier Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- Base url of Stash Server (default \(dq\(dq)
.IP \(bu 2
\fBusername\fP (\fIstr\fP) \-\- Username of Stash Server (default \(dq\(dq)
.IP \(bu 2
\fBpassword\fP (\fIstr\fP) \-\- Password of Stash Server (default \(dq\(dq)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- Credentials of Stash Server (optional)
.IP \(bu 2
\fBignore\-ssl\fP (\fIbool\fP) \-\- Ignore unverified SSL certificate (default false)
.IP \(bu 2
\fBcommit\-sha1\fP (\fIstr\fP) \-\- Commit SHA1 to notify (default \(dq\(dq)
.IP \(bu 2
\fBinclude\-build\-number\fP (\fIbool\fP) \-\- Include build number in key
(default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- stash

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- stash:
      url: \(dqhttps://mystash\(dq
      username: a
      password: b
      ignore\-ssl: true
      commit\-sha1: c
      include\-build\-number: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B tap()
Adds support to TAP test result files
.sp
Requires the Jenkins \fI\%TAP Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBresults\fP (\fIstr\fP) \-\- TAP test result files (required)
.IP \(bu 2
\fBfail\-if\-no\-results\fP (\fIbool\fP) \-\- Fail if no result (default false)
.IP \(bu 2
\fBfailed\-tests\-mark\-build\-as\-failure\fP (\fIbool\fP) \-\- Mark build as failure if test fails (default false)
.IP \(bu 2
\fBoutput\-tap\-to\-console\fP (\fIbool\fP) \-\- Output tap to console (default true)
.IP \(bu 2
\fBenable\-subtests\fP (\fIbool\fP) \-\- Enable subtests (default true)
.IP \(bu 2
\fBdiscard\-old\-reports\fP (\fIbool\fP) \-\- Discard old reports (default false)
.IP \(bu 2
\fBtodo\-is\-failure\fP (\fIbool\fP) \-\- Handle TODO\(aqs as failures (default true)
.IP \(bu 2
\fBinclude\-comment\-diagnostics\fP (\fIbool\fP) \-\- Include comment diagnostics (#) in
the results table (>=1.12) (default false)
.IP \(bu 2
\fBvalidate\-tests\fP (\fIbool\fP) \-\- Validate number of tests (>=1.13) (default false)
.IP \(bu 2
\fBplan\-required\fP (\fIbool\fP) \-\- TAP plan required? (>=1.17) (default true)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- Print a message for each TAP stream file (>=1.17)
(default true)
.IP \(bu 2
\fBshow\-only\-failures\fP (\fIbool\fP) \-\- show only test failures (>=1.17)
(default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- tap:
      results: puiparts.tap
      fail\-if\-no\-results: true
      failed\-tests\-mark\-build\-as\-failure: true
      output\-tap\-to\-console: false
      enable\-subtests: false
      discard\-old\-reports: true
      todo\-is\-failure: false
      include\-comment\-diagnostics: true
      validate\-tests: true
      plan\-required: false
      verbose: false
      show\-only\-failures: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- tap:
      results: puiparts.tap

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B tasks()
Scans the workspace files for open tasks and generates a trend report.
.sp
Requires the Jenkins Task Scanner Plugin
(\fI\%https://github.com/jenkinsci/tasks\-plugin\fP).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfiles\-to\-scan\fP (\fIlist\fP) \-\- Fileset includes setting that specifies the
workspace files to scan for tasks, such as \fB**/*.java\fP\&. Basedir of
the fileset is the workspace root. (default \(aq\fB**/*.java\fP\(aq)
.IP \(bu 2
\fBfiles\-to\-exclude\fP (\fIlist\fP) \-\- Fileset excludes setting that specifies the
workspace files to exclude scanning for tasks, such as library source
files. Basedir of the fileset is the workspace root. (default \(aq\(aq)
.IP \(bu 2
\fBtasks\-tags\-high\fP (\fIlist\fP) \-\- Tags identifiers for high priority that should
be looked for in the workspace files. Only alphanumerical characters
are allowed as tags as these strings are pasted into a regular
expression. (default \(aq\(aq)
.IP \(bu 2
\fBtasks\-tags\-normal\fP (\fIlist\fP) \-\- Tags identifiers for normal priority that
should be looked for in the workspace files. Only alphanumerical
characters are allowed as tags as these strings are pasted into a
regular expression. (default \(aq\(aq)
.IP \(bu 2
\fBtasks\-tags\-low\fP (\fIlist\fP) \-\- Tags identifiers for low priority that should be
looked for in the workspace files. Only alphanumerical characters are
allowed as tags as these strings are pasted into a regular expression.
(default \(aq\(aq)
.IP \(bu 2
\fBignore\-case\fP (\fIbool\fP) \-\- Ignore the case of the the tag identifiers. (default
false)
.IP \(bu 2
\fBregular\-expression\fP (\fIbool\fP) \-\- Treat the tag identifiers as regular
expression. Note that the regular expression must contain two capturing
groups, the first one is interpreted as tag name, the second one as
message. An example of such a regular expression would be
\fB^.*(TODO(?:[0\-9]*))(.*)$\fP\&. (default false)
.IP \(bu 2
\fBrun\-always\fP (\fIbool\fP) \-\- By default, this plug\-in runs only for stable or
unstable builds, but not for failed builds. If this plug\-in should run
even for failed builds then activate this check box. (default false)
.IP \(bu 2
\fBdetect\-module\fP (\fIbool\fP) \-\- Determines if Ant or Maven modules should be
detected for all files that contain warnings. Activating this option
may increase your build time since the detector scans the whole
workspace for \fBbuild.xml\fP or \fBpom.xml\fP files in order to assign the
correct module names. (default false)
.IP \(bu 2
\fBhealth\-thresholds\-100\fP (\fIint\fP) \-\- Configure the upper thresholds for the
build health. If left empty then no health report is created. If the
actual number of warnings is between the provided thresholds then the
build health is interpolated. (default \(aq\(aq)
.IP \(bu 2
\fBhealth\-thresholds\-0\fP (\fIstr\fP) \-\- Configure the lower thresholds for the build
health. If left empty then no health report is created. If the actual
number of warnings is between the provided thresholds then the build
health is interpolated. (default \(aq\(aq)
.IP \(bu 2
\fBhealth\-priorities\fP (\fIstr\fP) \-\- Determines which warning priorities should be
considered when evaluating the build health. Can be \fBhigh\fP (only
priority high), \fBnormal\fP (priorities high and normal) or \fBlow\fP (all
priorities). (default \(aqlow\(aq)
.IP \(bu 2
\fBstatus\-thresholds\fP (\fIdict\fP) \-\- 
.sp
Configure the build status and health. If the
number of total or new warnings is greater than one of these thresholds
then a build is considered as unstable or failed, respectively. I.e., a
value of 0 means that the build status is changed if there is at least
one warning found. Leave this field empty if the state of the build
should not depend on the number of warnings. Note that for new
warnings, you need to enable the next option
(\fBcompute\-new\-warnings\fP).
.INDENT 2.0
.TP
.B status\-thresholds
.INDENT 7.0
.IP \(bu 2
\fBunstable\-total\-all\fP (\fIstr\fP): Total number for all priorities,
unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBunstable\-total\-high\fP (\fIstr\fP): Total number for high priority,
unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBunstable\-total\-normal\fP (\fIstr\fP): Total number for normal
priority, unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBunstable\-total\-low\fP (\fIstr\fP): Total number for low priority,
unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-total\-all\fP (\fIstr\fP): Total number for all priorities,
failure threshold (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-total\-high\fP (\fIstr\fP): Total number for high priority,
failure threshold (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-total\-normal\fP (\fIstr\fP): Total number for normal
priority, failure threshold (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-total\-low\fP (\fIstr\fP): Total number for low priority,
failure threshold (default \(aq\(aq)
.IP \(bu 2
\fBunstable\-new\-all\fP (\fIstr\fP): New number for all priorities,
unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBunstable\-new\-high\fP (\fIstr\fP): New number for high priority,
unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBunstable\-new\-normal\fP (\fIstr\fP): New number for normal priority,
unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBunstable\-new\-low\fP (\fIstr\fP): New number for low priority,
unstable threshold (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-new\-all\fP (\fIstr\fP): New number for all priorities,
failure threshold (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-new\-high\fP (\fIstr\fP): New number for high priority,
failure threshold (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-new\-normal\fP (\fIstr\fP): New number for normal priority,
failure threshold (default \(aq\(aq)
.IP \(bu 2
\fBfailed\-new\-low\fP (\fIstr\fP): New number for low priority, failure
threshold (default \(aq\(aq)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBcompute\-new\-warnings\fP (\fIbool\fP) \-\- Compute new warnings (based on the last
successful build unless another reference build is chosen below).
(default false)
.IP \(bu 2
\fBuse\-delta\fP (\fIbool\fP) \-\- If set the number of new warnings is computed by
subtracting the total number of warnings of the reference build from
the total number of warnings of the current build. This may lead to
wrong results if you have both fixed and new warnings in a build. If
unset the number of new warnings is computed by a more sophisticated
algorithm: instead of using totals an asymmetric set difference of the
warnings in the current build and the warnings in the reference build
is used. This will find all new warnings even if the number of total
warnings has decreased. Note that sometimes false positives will be
reported due to minor changes in a warning (e.g. refactoring of
variables or method names). It is recommended to uncheck this option in
order to get the most accurate results for new warnings. Depends on
\fBcompute\-new\-warnings\fP option. (default false)
.IP \(bu 2
\fBuse\-prev\-build\-as\-ref\fP (\fIbool\fP) \-\- If set the number of new warnings will
always be computed based on the previous build, even if that build is
unstable (due to a violated warning threshold). Otherwise the last
build that did not violate any given threshold will be used as
reference. It is recommended to uncheck this option if the plug\-in
should ensure that all new warnings will be finally fixed in subsequent
builds. Depends on \fBcompute\-new\-warnings\fP option. (default false)
.IP \(bu 2
\fBonly\-use\-stable\-as\-ref\fP (\fIbool\fP) \-\- Use the last stable build as the
reference to compute the number of new warnings against. This allows
you to ignore interim unstable builds for which the number of warnings
decreased. Note that the last stable build is evaluated only by
inspecting the unit test failures. The static analysis results are not
considered. Depends on \fBcompute\-new\-warnings\fP option. (default false)
.IP \(bu 2
\fBdefault\-encoding\fP (\fIstr\fP) \-\- Default encoding when parsing or showing files.
Leave this field empty to use the default encoding of the platform.
(default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- tasks

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- tasks:
      files\-to\-scan:
        \- \(dq**/*.java\(dq
        \- \(dq**/*.c\(dq
      files\-to\-exclude:
        \- \(dqspecific/file.java\(dq
      tasks\-tags\-high:
        \- \(dqFIXME\(dq
        \- \(dqXXX\(dq
      tasks\-tags\-normal:
        \- \(dqTODO\(dq
      tasks\-tags\-low:
        \- \(dqNICETOHAVE\(dq
      ignore\-case: false
      regular\-expression: false
      run\-always: false
      detect\-module: false
      health\-thresholds\-100: 100
      health\-thresholds\-0: 0
      health\-priorities: \(aqlow\(aq
      status\-thresholds:
        unstable\-total\-all: 0
        unstable\-total\-high: 0
        unstable\-total\-normal: 0
        unstable\-total\-low: 0
        failed\-total\-all: 0
        failed\-total\-high: 0
        failed\-total\-normal: 0
        failed\-total\-low: 0
        unstable\-new\-all: 0
        unstable\-new\-high: 0
        unstable\-new\-normal: 0
        unstable\-new\-low: 0
        failed\-new\-all: 0
        failed\-new\-high: 0
        failed\-new\-normal: 0
        failed\-new\-low: 0
      compute\-new\-warnings: false
      use\-delta: false
      use\-prev\-build\-as\-ref: false
      only\-use\-stable\-as\-ref: false
      default\-encoding: \(dqUTF\-8\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B test\-fairy()
This plugin helps you to upload Android APKs or iOS IPA files to
www.testfairy.com.
.sp
Requires the Jenkins \fI\%Test Fairy Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBplatform\fP (\fIstr\fP) \-\- Select platform to upload to, \fBandroid\fP or \fBios\fP
(required)
.UNINDENT
.sp
Android Only:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproguard\-file\fP (\fIstr\fP) \-\- Path to Proguard file. Path of mapping.txt from
your proguard output directory. (default \(aq\(aq)
.IP \(bu 2
\fBstorepass\fP (\fIstr\fP) \-\- Password for the keystore (default android)
.IP \(bu 2
\fBalias\fP (\fIstr\fP) \-\- alias for key (default androiddebugkey)
.IP \(bu 2
\fBkeypass\fP (\fIstr\fP) \-\- password for the key (default \(aq\(aq)
.IP \(bu 2
\fBkeystorepath\fP (\fIstr\fP) \-\- Path to Keystore file (required)
.UNINDENT
.UNINDENT
.sp
IOS Only:
.INDENT 7.0
.TP
.B Parameters
\fBdSYM\-file\fP (\fIstr\fP) \-\- Path to .dSYM.zip file (default \(aq\(aq)
.UNINDENT
.sp
All:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBapikey\fP (\fIstr\fP) \-\- TestFairy API_KEY. Find it in your TestFairy account
settings (required)
.IP \(bu 2
\fBappfile\fP (\fIstr\fP) \-\- Path to App file (.apk) or (.ipa). For example:
$WORKSPACE/[YOUR_FILE_NAME].apk or full path to the apk file.
(required)
.IP \(bu 2
\fBtester\-groups\fP (\fIstr\fP) \-\- Tester groups to notify (default \(aq\(aq)
.IP \(bu 2
\fBnotify\-testers\fP (\fIbool\fP) \-\- Send email with changelogs to testers
(default false)
.IP \(bu 2
\fBautoupdate\fP (\fIbool\fP) \-\- Automatic update (default false)
.IP \(bu 2
\fBmax\-duration\fP (\fIstr\fP) \-\- 
.sp
Duration of the session (default 10m)
.INDENT 2.0
.TP
.B max\-duration values
.INDENT 7.0
.IP \(bu 2
\fB10m\fP
.IP \(bu 2
\fB60m\fP
.IP \(bu 2
\fB300m\fP
.IP \(bu 2
\fB1440m\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrecord\-on\-background\fP (\fIbool\fP) \-\- Record on background (default false)
.IP \(bu 2
\fBdata\-only\-wifi\fP (\fIbool\fP) \-\- Record data only in wifi (default false)
.IP \(bu 2
\fBvideo\-enabled\fP (\fIbool\fP) \-\- Record video (default true)
.IP \(bu 2
\fBscreenshot\-interval\fP (\fIint\fP) \-\- 
.sp
Time interval between screenshots
(default 1)
.INDENT 2.0
.TP
.B screenshot\-interval values
.INDENT 7.0
.IP \(bu 2
\fB1\fP
.IP \(bu 2
\fB2\fP
.IP \(bu 2
\fB5\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBvideo\-quality\fP (\fIstr\fP) \-\- 
.sp
Video quality (default high)
.INDENT 2.0
.TP
.B video\-quality values
.INDENT 7.0
.IP \(bu 2
\fBhigh\fP
.IP \(bu 2
\fBmedium\fP
.IP \(bu 2
\fBlow\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBcpu\fP (\fIbool\fP) \-\- Enable CPU metrics (default true)
.IP \(bu 2
\fBmemory\fP (\fIbool\fP) \-\- Enable memory metrics (default true)
.IP \(bu 2
\fBlogs\fP (\fIbool\fP) \-\- Enable logs metrics (default true)
.IP \(bu 2
\fBnetwork\fP (\fIbool\fP) \-\- Enable network metrics (default false)
.IP \(bu 2
\fBphone\-signal\fP (\fIbool\fP) \-\- Enable phone signal metrics (default false)
.IP \(bu 2
\fBwifi\fP (\fIbool\fP) \-\- Enable wifi metrics (default false)
.IP \(bu 2
\fBgps\fP (\fIbool\fP) \-\- Enable gps metrics (default false)
.IP \(bu 2
\fBbattery\fP (\fIbool\fP) \-\- Enable battery metrics (default false)
.IP \(bu 2
\fBopengl\fP (\fIbool\fP) \-\- Enable opengl metrics (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- test\-fairy:
      platform: android
      apikey: apikey
      appfile: /tmp/appfile.apk
      keystorepath: /tmp/keystorefile

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- test\-fairy:
      platform: android
      apikey: apikey
      appfile: /tmp/appfile.apk
      proguard\-file: /tmp/proguardfile
      keystorepath: /tmp/keystorefile
      storepass: android
      alias: androiddebugkey
      keypass: keypass
      tester\-groups: testergroups
      notify\-testers: true
      autoupdate: true

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- test\-fairy:
      platform: ios
      apikey: apikey
      appfile: /tmp/appfile.ipa

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- test\-fairy:
      platform: ios
      apikey: apikey
      appfile: /tmp/appfile.ipa
      dSYM\-file: /tmp/dsym.zip
      tester\-groups: testergroups
      notify\-testers: true
      autoupdate: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B testng()
This plugin publishes TestNG test reports.
.sp
Requires the Jenkins \fI\%TestNG Results Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- filename pattern to locate the TestNG XML report files
(required)
.IP \(bu 2
\fBescape\-test\-description\fP (\fIbool\fP) \-\- escapes the description string
associated with the test method while displaying test method details
(default true)
.IP \(bu 2
\fBescape\-exception\-msg\fP (\fIbool\fP) \-\- escapes the test method\(aqs exception
messages. (default true)
.IP \(bu 2
\fBfail\-on\-failed\-test\-config\fP (\fIbool\fP) \-\- Allows for a distinction between
failing tests and failing configuration methods (>=1.10) (default
false)
.IP \(bu 2
\fBshow\-failed\-builds\fP (\fIbool\fP) \-\- include results from failed builds in the
trend graph (>=1.6) (default false)
.IP \(bu 2
\fBunstable\-skips\fP (\fIint\fP) \-\- Build is marked UNSTABLE if the number/percentage
of skipped tests exceeds the specified threshold (>=1.11) (default 100)
.IP \(bu 2
\fBunstable\-fails\fP (\fIint\fP) \-\- Build is marked UNSTABLE if the number/percentage
of failed tests exceeds the specified threshold (>=1.11) (default 0)
.IP \(bu 2
\fBfailed\-skips\fP (\fIint\fP) \-\- Build is marked FAILURE if the number/percentage of
skipped tests exceeds the specified threshold (>=1.11) (default 100)
.IP \(bu 2
\fBfailed\-fails\fP (\fIint\fP) \-\- Build is marked FAILURE if the number/percentage of
failed tests exceeds the specified threshold (>=1.11) (default 100)
.IP \(bu 2
\fBthreshold\-mode\fP (\fIstr\fP) \-\- Interpret threshold as number of tests or
percentage of tests (>=1.11) (default percentage)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
    \- testng:
        pattern: \(dq**/testng\-results.xml\(dq
        escape\-test\-description: false
        escape\-exception\-msg: false
        fail\-on\-failed\-test\-config: true
        show\-failed\-builds: true
        unstable\-skips: 50
        unstable\-fails: 25
        failed\-skips: 75
        failed\-fails: 66
        threshold\-mode: number

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- testng:
      pattern: \(dq**/testng\-results.xml\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B testselector()
This plugin allows you to choose specific tests you want to run.
.sp
Requires the Jenkins \fI\%Tests Selector Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Environment variable in which selected tests are saved
(required)
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Description
(default \(dq\(dq)
.IP \(bu 2
\fBproperties\-file\fP (\fIstr\fP) \-\- Contain all your tests
(required)
.IP \(bu 2
\fBenable\-field\fP (\fIstr\fP) \-\- Imply if the test is enabled or not
(default \(dq\(dq)
.IP \(bu 2
\fBgroupby\fP (\fIstr\fP) \-\- Plugin will group the tests by
(default \(dq\(dq)
.IP \(bu 2
\fBfield\-sperator\fP (\fIstr\fP) \-\- Separate between the fields in the tests tree
(default \(dq\(dq)
.IP \(bu 2
\fBshow\-fields\fP (\fIstr\fP) \-\- Shown in the tests tree
(default \(dq\(dq)
.IP \(bu 2
\fBmultiplicity\-field\fP (\fIstr\fP) \-\- Number of times the test should run
(default \(dq\(dq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- testselector:
      name: tests
      description: integration
      properties\-file: example.properties
      enable\-field: enabled
      groupby: testgroup
      field\-separator: .
      show\-fields: testsuite,testcase
      multiplicity\-field: multiplicity

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B text\-finder()
This plugin lets you search keywords in the files you specified and
additionally check build status
.sp
Requires the Jenkins \fI\%Text\-finder Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBregexp\fP (\fIstr\fP) \-\- Specify a regular expression (required)
.IP \(bu 2
\fBfileset\fP (\fIstr\fP) \-\- Specify the path to search (optional)
.IP \(bu 2
\fBalso\-check\-console\-output\fP (\fIbool\fP) \-\- Search the console output (default false)
.IP \(bu 2
\fBsucceed\-if\-found\fP (\fIbool\fP) \-\- Force a build to succeed if a string was found (default false)
.IP \(bu 2
\fBunstable\-if\-found\fP (\fIbool\fP) \-\- Set build unstable instead of failing the build (default false)
.IP \(bu 2
\fBnot\-built\-if\-found\fP (\fIbool\fP) \-\- Set build to \(dqNot Built\(dq instead of failing the build (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- text\-finder:
      regexp: \(dqsome string\(dq
      fileset: \(dqfile.txt\(dq
      also\-check\-console\-output: true
      succeed\-if\-found: false
      unstable\-if\-found: false
      not\-built\-if\-found: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B trigger()
Trigger non\-parametrised builds of other jobs.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproject\fP (\fIstr\fP) \-\- name of the job to trigger
.IP \(bu 2
\fBthreshold\fP (\fIstr\fP) \-\- when to trigger the other job (default \(aqSUCCESS\(aq),
alternatives: SUCCESS, UNSTABLE, FAILURE
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- trigger:
      project: other_job
      threshold: SUCCESS

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B trigger\-parameterized\-builds()
Trigger parameterized builds of other jobs.
Requires the Jenkins \fI\%Parameterized Trigger Plugin\fP\&.
.sp
Use of the \fInode\-label\-name\fP or \fInode\-label\fP parameters
requires the Jenkins \fI\%NodeLabel Parameter Plugin\fP\&.
Note: \(aqnode\-parameters\(aq overrides the Node that the triggered
project is tied to.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproject\fP (\fIlist\fP) \-\- list the jobs to trigger, will generate comma\-separated
string containing the named jobs.
.IP \(bu 2
\fBpredefined\-parameters\fP (\fIstr\fP) \-\- parameters to pass to the other
job (optional)
.IP \(bu 2
\fBcurrent\-parameters\fP (\fIbool\fP) \-\- Whether to include the parameters passed
to the current build to the triggered job (optional)
.IP \(bu 2
\fBnode\-parameters\fP (\fIbool\fP) \-\- Use the same Node for the triggered builds
that was used for this build. (optional)
.IP \(bu 2
\fBsvn\-revision\fP (\fIbool\fP) \-\- Pass svn revision to the triggered job (optional)
.IP \(bu 2
\fBinclude\-upstream\fP (\fIbool\fP) \-\- Include/pass through Upstream SVN Revisons.
Only valid when \(aqsvn\-revision\(aq is true. (default false)
.IP \(bu 2
\fBgit\-revision\fP (\fIdict\fP) \-\- 
.sp
Passes git revision to the triggered job
(optional).
.INDENT 2.0
.IP \(bu 2
\fBcombine\-queued\-commits\fP (bool): Whether to combine queued git
hashes or not (default false)
.UNINDENT

.IP \(bu 2
\fBcombine\-queued\-commits\fP (\fIbool\fP) \-\- 
.sp
Combine Queued git hashes. Only valid
when \(aqgit\-revision\(aq is true. (default false)
.sp
Deprecated since version 1.5.0: Please use \fIcombine\-queued\-commits\fP under the
\fIgit\-revision\fP argument instead.


.IP \(bu 2
\fBboolean\-parameters\fP (\fIdict\fP) \-\- Pass boolean parameters to the downstream
jobs. Specify the name and boolean value mapping of the parameters.
(optional)
.IP \(bu 2
\fBcondition\fP (\fIstr\fP) \-\- when to trigger the other job. Can be: \(aqSUCCESS\(aq,
\(aqUNSTABLE\(aq, \(aqFAILED_OR_BETTER\(aq, \(aqUNSTABLE_OR_BETTER\(aq,
\(aqUNSTABLE_OR_WORSE\(aq, \(aqFAILED\(aq, \(aqALWAYS\(aq. (default \(aqALWAYS\(aq)
.IP \(bu 2
\fBproperty\-file\fP (\fIstr\fP) \-\- Use properties from file (optional)
.IP \(bu 2
\fBfail\-on\-missing\fP (\fIbool\fP) \-\- Blocks the triggering of the downstream jobs
if any of the property files are not found in the workspace.
Only valid when \(aqproperty\-file\(aq is specified.
(default \(aqFalse\(aq)
.IP \(bu 2
\fBproperty\-multiline\fP (\fIbool\fP) \-\- When enabled properties containing
newline character(s) are propagated as TextParameterValue which is
a specialized StringParameterValue commonly used for handling
multi\-line strings in Jenkins. When disabled (default)
all properties are propagated as StringParameterValue. (default
\(aqFalse\(aq) (>=2.35.2)
.IP \(bu 2
\fBtrigger\-from\-child\-projects\fP (\fIbool\fP) \-\- Trigger build from child projects.
Used for matrix projects. (default \(aqFalse\(aq)
.IP \(bu 2
\fBuse\-matrix\-child\-files\fP (\fIbool\fP) \-\- Use files in workspaces of child
builds (default \(aqFalse\(aq)
.IP \(bu 2
\fBmatrix\-child\-combination\-filter\fP (\fIstr\fP) \-\- A Groovy expression to filter
the child builds to look in for files
.IP \(bu 2
\fBonly\-exact\-matrix\-child\-runs\fP (\fIbool\fP) \-\- Use only child builds triggered
exactly by the parent.
.IP \(bu 2
\fBfile\-encoding\fP (\fIstr\fP) \-\- Encoding of contents of the files. If not
specified, default encoding of the platform is used. Only valid when
\(aqproperty\-file\(aq is specified. (optional)
.IP \(bu 2
\fBtrigger\-with\-no\-params\fP (\fIbool\fP) \-\- Trigger a build even when there are
currently no parameters defined (default \(aqFalse\(aq)
.IP \(bu 2
\fBrestrict\-matrix\-project\fP (\fIstr\fP) \-\- Filter that restricts the subset
of the combinations that the downstream project will run (optional)
.IP \(bu 2
\fBnode\-label\-name\fP (\fIstr\fP) \-\- Specify the Name for the NodeLabel parameter.
(optional)
.IP \(bu 2
\fBnode\-label\fP (\fIstr\fP) \-\- Specify the Node for the NodeLabel parameter.
(optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- trigger\-parameterized\-builds:
    \- project:
        \- other_job
        \- foo
        \- bar
      predefined\-parameters: |
        foo=bar
        bar=foo
    \- project: other_job1, other_job2
      predefined\-parameters: BUILD_NUM=${BUILD_NUMBER}
      git\-revision: true
      property\-file: version.prop
      fail\-on\-missing: true
      property\-multiline: true
    \- project: yet_another_job
      predefined\-parameters: foo=bar
      git\-revision:
        combine\-queued\-commits: true
      restrict\-matrix\-project: label==\(dqx86\(dq
    \- project: yet_another_job_2
      node\-label\-name: foo
    \- project: yet_another_job_3
      node\-label: node\-label\-foo || node\-label\-bar
    \- project: \(aqtest\-project\-same\-node\(aq
      node\-parameters: true
      current\-parameters: true

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- trigger\-parameterized\-builds:
    \- project:
        \- other_job
        \- foo
        \- bar
      boolean\-parameters:
          p1: true
          p2: false
      svn\-revision: true
      include\-upstream: true
      git\-revision: true
      combine\-queued\-commits: true
      property\-file: version.prop
      file\-encoding: UTF\-8

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B valgrind()
This plugin publishes Valgrind Memcheck XML results.
.sp
Requires the Jenkins \fI\%Valgrind Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- Filename pattern to locate the Valgrind XML report files
(required)
.IP \(bu 2
\fBthresholds\fP (\fIdict\fP) \-\- 
.sp
Mark build as failed or unstable if the number of
errors exceeds a threshold. All threshold values are optional.
.INDENT 2.0
.TP
.B thresholds
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBunstable\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unstable
.INDENT 7.0
.IP \(bu 2
\fBinvalid\-read\-write\fP (\fIint\fP)
.IP \(bu 2
\fBdefinitely\-lost\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfailed\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B failed
.INDENT 7.0
.IP \(bu 2
\fBinvalid\-read\-write\fP (\fIint\fP)
.IP \(bu 2
\fBdefinitely\-lost\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfail\-no\-reports\fP (\fIbool\fP) \-\- Fail build if no reports are found
(default false)
.IP \(bu 2
\fBfail\-invalid\-reports\fP (\fIbool\fP) \-\- Fail build if reports are malformed
(default false)
.IP \(bu 2
\fBpublish\-if\-aborted\fP (\fIbool\fP) \-\- Publish results for aborted builds
(default false)
.IP \(bu 2
\fBpublish\-if\-failed\fP (\fIbool\fP) \-\- Publish results for failed builds
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- valgrind:
      pattern: \(dqtest.xml\(dq
      thresholds:
        unstable:
          invalid\-read\-write: 1
          definitely\-lost: 2
          total: 3
        failed:
          invalid\-read\-write: 4
          definitely\-lost: 5
          total: 6
      fail\-no\-reports: true
      fail\-invalid\-reports: true
      publish\-if\-aborted: true
      publish\-if\-failed: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B violations()
Publish code style violations.
Requires the Jenkins \fI\%Violations Plugin\fP\&.
.sp
The violations component accepts any number of dictionaries keyed
by the name of the violations system.  The dictionary has the
following values:
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmin\fP (\fIint\fP) \-\- sunny threshold
.IP \(bu 2
\fBmax\fP (\fIint\fP) \-\- stormy threshold
.IP \(bu 2
\fBunstable\fP (\fIint\fP) \-\- unstable threshold
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- report filename pattern
.UNINDENT
.UNINDENT
.sp
Any system without a dictionary provided will use default values.
.sp
Valid systems are:
.INDENT 7.0
.INDENT 3.5
checkstyle, codenarc, cpd, cpplint, csslint, findbugs, fxcop,
gendarme, jcreport, jslint, pep8, perlcritic, pmd, pylint,
simian, stylecop
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- violations:
      pep8:
        min: 0
        max: 1
        unstable: 1
        pattern: \(aq**/pep8.txt\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B warnings()
Generate trend report for compiler warnings in the console log or
in log files.
.sp
Requires the Jenkins Warnings Plugin
(\fI\%https://github.com/jenkinsci/warnings\-plugin\fP).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBconsole\-log\-parsers\fP (\fIlist\fP) \-\- The parser to use to scan the console
log (default \(aq\(aq)
.IP \(bu 2
\fBworkspace\-file\-scanners\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B workspace\-file\-scanners
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBfile\-pattern\fP (\fIstr\fP) \-\- Fileset \(aqincludes\(aq setting that
specifies the files to scan for warnings (required)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBscanner\fP (\fIstr\fP) \-\- The parser to use to scan the files
provided in workspace\-file\-pattern (default \(aq\(aq)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfiles\-to\-include\fP (\fIstr\fP) \-\- Comma separated list of regular
expressions that specifies the files to include in the report
(based on their absolute filename). By default all files are
included
.IP \(bu 2
\fBfiles\-to\-ignore\fP (\fIstr\fP) \-\- Comma separated list of regular expressions
that specifies the files to exclude from the report (based on their
absolute filename). (default \(aq\(aq)
.IP \(bu 2
\fBmessages\-to\-ignore\fP (\fIstr\fP) \-\- Newline separated list of regular
expressions that specifies the warning messages to exclude form the
report (based on the warning messages). By default all warning
messages are included
.IP \(bu 2
\fBcategories\-to\-ignore\fP (\fIstr\fP) \-\- Newline separated list of regular
expressions that specifies the warning messages to exclude form the
report (based on the warning categories). By default all warning
categories are included
.IP \(bu 2
\fBrun\-always\fP (\fIbool\fP) \-\- By default, this plug\-in runs only for stable or
unstable builds, but not for failed builds.  Set to true if the
plug\-in should run even for failed builds.  (default false)
.IP \(bu 2
\fBdetect\-modules\fP (\fIbool\fP) \-\- Determines if Ant or Maven modules should be
detected for all files that contain warnings.  Activating this
option may increase your build time since the detector scans
the whole workspace for \(aqbuild.xml\(aq or \(aqpom.xml\(aq files in order
to assign the correct module names. (default false)
.IP \(bu 2
\fBresolve\-relative\-paths\fP (\fIbool\fP) \-\- Determines if relative paths in
warnings should be resolved using a time expensive operation that
scans the whole workspace for matching files.  Deactivate this
option if you encounter performance problems.  (default false)
.IP \(bu 2
\fBhealth\-threshold\-high\fP (\fIint\fP) \-\- The upper threshold for the build
health.  If left empty then no health report is created.  If
the actual number of warnings is between the provided
thresholds then the build health is interpolated (default \(aq\(aq)
.IP \(bu 2
\fBhealth\-threshold\-low\fP (\fIint\fP) \-\- The lower threshold for the build
health.  See health\-threshold\-high.  (default \(aq\(aq)
.IP \(bu 2
\fBhealth\-priorities\fP (\fIdict\fP) \-\- 
.sp
Determines which warning priorities
should be considered when evaluating the build health (default
all\-priorities)
.INDENT 2.0
.TP
.B health\-priorities values
.INDENT 7.0
.IP \(bu 2
\fBpriority\-high\fP \-\- Only priority high
.IP \(bu 2
\fBhigh\-and\-normal\fP \-\- Priorities high and normal
.IP \(bu 2
\fBall\-priorities\fP \-\- All priorities
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtotal\-thresholds\fP (\fIdict\fP) \-\- 
.sp
If the number of total warnings is greater
than one of these thresholds then a build is considered as unstable
or failed, respectively. (default \(aq\(aq)
.INDENT 2.0
.TP
.B total\-thresholds
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBunstable\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unstable
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfailed\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B failed
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBnew\-thresholds\fP (\fIdict\fP) \-\- 
.sp
If the specified number of new warnings exceeds
one of these thresholds then a build is considered as unstable or
failed, respectively.  (default \(aq\(aq)
.INDENT 2.0
.TP
.B new\-thresholds
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBunstable\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unstable
.INDENT 7.0
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfailed\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B failed
.INDENT 7.0
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBuse\-delta\-for\-new\-warnings\fP (\fIbool\fP) \-\- If set then the number of new
warnings is calculated by subtracting the total number of warnings
of the current build from the reference build. This may lead to wrong
results if you have both fixed and new warnings in a build. If not set,
then the number of new warnings is calculated by an asymmetric set
difference of the warnings in the current and reference build. This
will find all new warnings even if the number of total warnings is
decreasing. However, sometimes false positives will be reported due
to minor changes in a warning (refactoring of variable of method
names, etc.) (default false)
.IP \(bu 2
\fBuse\-previous\-build\-as\-reference\fP (\fIbool\fP) \-\- If set the number of new
warnings will always be computed based on the previous build, even if
that build is unstable (due to a violated warning threshold).
Otherwise the last build that did not violate any given threshold will
be used as
reference. It is recommended to uncheck this option if the plug\-in
should ensure that all new warnings will be finally fixed in subsequent
builds. (default false)
.IP \(bu 2
\fBonly\-use\-stable\-builds\-as\-reference\fP (\fIbool\fP) \-\- The number of new warnings
will be calculated based on the last stable build, allowing reverts
of unstable builds where the number of warnings was decreased.
(default false)
.IP \(bu 2
\fBdefault\-encoding\fP (\fIstr\fP) \-\- Default encoding when parsing or showing files
Leave empty to use default encoding of platform (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- warnings

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- warnings:
      console\-log\-parsers:
        \- FxCop
        \- CodeAnalysis
      workspace\-file\-scanners:
        \- file\-pattern: \(aq**/*.out\(aq
          scanner: \(aqAcuCobol Compiler\(aq
        \- file\-pattern: \(aq**/*.warnings\(aq
          scanner: FxCop
      files\-to\-include: \(aq[a\-zA\-Z]\e.java,[a\-zA\-Z]\e.cpp\(aq
      files\-to\-ignore: \(aq[a\-zA\-Z]\e.html,[a\-zA\-Z]\e.js\(aq
      messages\-to\-ignore: |\-
        ^Test results:.*
        No sources found skipping Kotlin compile
      categories\-to\-ignore: |\-
        WARN.*
        ERROR
      run\-always: true
      detect\-modules: true
      resolve\-relative\-paths: true
      health\-threshold\-high: 50
      health\-threshold\-low: 25
      health\-priorities: high\-and\-normal
      total\-thresholds:
        unstable:
          total\-all: 90
          total\-high: 90
          total\-normal: 40
          total\-low: 30
        failed:
          total\-all: 100
          total\-high: 100
          total\-normal: 50
          total\-low: 40
      new\-thresholds:
        unstable:
          new\-all: 100
          new\-high: 50
          new\-normal: 30
          new\-low: 10
        failed:
          new\-all: 100
          new\-high: 60
          new\-normal: 50
          new\-low: 40
      use\-delta\-for\-new\-warnings: true
      use\-previous\-build\-as\-reference: true
      only\-use\-stable\-builds\-as\-reference: true
      default\-encoding: ISO\-8859\-9

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B whitesource()
This plugin brings automatic open source management to Jenkins users.
.sp
Requires the Jenkins \fI\%Whitesource Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproduct\-token\fP (\fIstr\fP) \-\- Product name or token to update (default \(aq\(aq)
.IP \(bu 2
\fBversion\fP (\fIstr\fP) \-\- Product version (default \(aq\(aq)
.IP \(bu 2
\fBoverride\-token\fP (\fIstr\fP) \-\- Override the api token from the global config
(default \(aq\(aq)
.IP \(bu 2
\fBproject\-token\fP (\fIstr\fP) \-\- Token uniquely identifying the project to update
(default \(aq\(aq)
.IP \(bu 2
\fBincludes\fP (\fIlist\fP) \-\- list of libraries to include (default \(aq[]\(aq)
.IP \(bu 2
\fBexcludes\fP (\fIlist\fP) \-\- list of libraries to exclude (default \(aq[]\(aq)
.IP \(bu 2
\fBpolicies\fP (\fIstr\fP) \-\- Whether to override the global settings.  Valid values:
global, enable, disable (default \(aqglobal\(aq)
.IP \(bu 2
\fBrequester\-email\fP (\fIstr\fP) \-\- Email of the WhiteSource user that requests to
update WhiteSource (>=1.5.1) (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- whitesource:
      product\-token: abcdefghijklmnopqrstuvwxyzabcdef
      version: 1.0.17
      policies: enable
      override\-token: \(dq1231424523412\(dq
      project\-token: sd;fkljsdfkljasdfkj
      requester\-email: foo@email.com
      includes:
        \- lib/*.jar
        \- test/lib/*.jar
      excludes:
        \- lib/ant*.jar
        \- test/lib/ant*.jar

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- whitesource

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B workspace\-cleanup (post\-build)()
Requires the Jenkins \fI\%Workspace Cleanup Plugin\fP\&.
.sp
The pre\-build workspace\-cleanup is available as a wrapper.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinclude\fP (\fIlist\fP) \-\- list of files to be included
.IP \(bu 2
\fBexclude\fP (\fIlist\fP) \-\- list of files to be excluded
.IP \(bu 2
\fBdirmatch\fP (\fIbool\fP) \-\- Apply pattern to directories too (default false)
.IP \(bu 2
\fBclean\-if\fP (\fIlist\fP) \-\- 
.sp
clean depending on build status
.INDENT 2.0
.TP
.B clean\-if values
.INDENT 7.0
.IP \(bu 2
\fBsuccess\fP (\fIbool\fP) (default true)
.IP \(bu 2
\fBunstable\fP (\fIbool\fP) (default true)
.IP \(bu 2
\fBfailure\fP (\fIbool\fP) (default true)
.IP \(bu 2
\fBaborted\fP (\fIbool\fP) (default true)
.IP \(bu 2
\fBnot\-built\fP (\fIbool\fP)  (default true)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfail\-build\fP (\fIbool\fP) \-\- Fail the build if the cleanup fails (default true)
.IP \(bu 2
\fBclean\-parent\fP (\fIbool\fP) \-\- Cleanup matrix parent workspace (default false)
.IP \(bu 2
\fBexternal\-deletion\-command\fP (\fIstr\fP) \-\- external deletion command to run
against files and directories
.IP \(bu 2
\fBdisable\-deferred\-wipeout\fP (\fIbool\fP) \-\- Disable improved deferred wipeout
method (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- workspace\-cleanup

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- workspace\-cleanup:
      include:
        \- \(dq*.zip\(dq
      exclude:
        \- \(dq*.txt\(dq
      clean\-if:
        \- success: false
        \- unstable: false
        \- failure: false
        \- aborted: false
        \- not\-built: false
      dirmatch: true
      fail\-build: false
      clean\-parent: true
      external\-deletion\-command: \(aqcommand\(aq
      disable\-deferred\-wipeout: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B xml\-summary()
Adds support for the Summary Display Plugin
.sp
Requires the Jenkins \fI\%Summary Display Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfiles\fP (\fIstr\fP) \-\- Files to parse (required)
.IP \(bu 2
\fBshown\-on\-project\-page\fP (\fIbool\fP) \-\- Display summary on project page
(default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- xml\-summary:
      files: \(aq*_summary_report.xml\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- xml\-summary:
      files: \(aq*_summary_report.xml\(aq
      shown\-on\-project\-page: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B xunit()
Publish tests results. Requires the Jenkins \fI\%xUnit Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBthresholdmode\fP (\fIstr\fP) \-\- Whether thresholds represents an absolute number
of tests or a percentage. Either \(aqnumber\(aq or \(aqpercent\(aq. (default
\(aqnumber\(aq)
.IP \(bu 2
\fBthresholds\fP (\fIlist\fP) \-\- 
.sp
Thresholds for both \(aqfailed\(aq and \(aqskipped\(aq tests.
.INDENT 2.0
.TP
.B threshold (\fIdict\fP)
Threshold values to set, where missing, xUnit
should default to an internal value of 0. Each test threshold
should contain the following:
.INDENT 7.0
.IP \(bu 2
\fBunstable\fP (\fIint\fP)
.IP \(bu 2
\fBunstablenew\fP (\fIint\fP)
.IP \(bu 2
\fBfailure\fP (\fIint\fP)
.IP \(bu 2
\fBfailurenew\fP (\fIint\fP)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtest\-time\-margin\fP (\fIint\fP) \-\- Give the report time margin value in ms, before
to fail if not new unless the option \fBrequireupdate\fP is set for the
configured framework. (default 3000)
.IP \(bu 2
\fBtypes\fP (\fIlist\fP) \-\- 
.sp
Frameworks to configure, and options. Supports the
following: \fBaunit\fP, \fBboosttest\fP, \fBchecktype\fP, \fBcpptest\fP,
\fBcppunit\fP, \fBctest\fP, \fBdotnettest\fP, \fBembunit\fP, \fBfpcunit\fP,
\fBgtest\fP, \fBjunit\fP, \fBmstest\fP, \fBnunit\fP, \fBphpunit\fP, \fBtusar\fP,
\fBunittest\fP, and \fBvalgrind\fP\&.
.sp
The \(aqcustom\(aq type is not supported.
.INDENT 2.0
.TP
.B type (\fIdict\fP)
each type can be configured using the following:
.INDENT 7.0
.IP \(bu 2
\fBpattern\fP (\fIstr\fP): An Ant pattern to look for Junit result
files, relative to the workspace root (default \(aq\(aq)
.IP \(bu 2
\fBrequireupdate\fP (\fIbool\fP): fail the build whenever fresh tests
results have not been found (default true).
.IP \(bu 2
\fBdeleteoutput\fP (\fIbool\fP): delete temporary JUnit files
(default true).
.IP \(bu 2
\fBskip\-if\-no\-test\-files\fP (\fIbool\fP): Skip parsing this xUnit type
report if there are no test reports files (default false).
.IP \(bu 2
\fBstoponerror\fP (\fIbool\fP): Fail the build whenever an error occur
during a result file processing (default true).
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- xunit:
      thresholdmode: \(aqpercent\(aq
      thresholds:
          \- failed:
                unstable: 0
                unstablenew: 0
                failure: 0
                failurenew: 0
          \- skipped:
                unstable: 0
                unstablenew: 0
                failure: 0
                failurenew: 0
      types:
          \- phpunit:
              pattern: \(dqjunit.log\(dq
              stoponerror: true
          \- cppunit:
              pattern: \(dqcppunit.log\(dq
          \- gtest:
              pattern: \(dqgtest.log\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B zulip()
Set build status on zulip.
Requires the Jenkins \fI\%Humbug Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
publishers:
  \- zulip

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Reporters
.sp
Reporters are like publishers but only applicable to Maven projects.
.INDENT 0.0
.TP
\fBComponent\fP: reporters
.INDENT 7.0
.TP
.B Macro
reporter
.TP
.B Entry Point
jenkins_jobs.reporters
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job:
  name: test_job
  project\-type: maven

  reporters:
    \- email:
        recipients: breakage@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  reporters.Reporters(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqreporters\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqreporter\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  55
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B email()
Email notifications on build failure.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrecipients\fP (\fIstr\fP) \-\- Recipient email addresses
.IP \(bu 2
\fBnotify\-every\-unstable\-build\fP (\fIbool\fP) \-\- Send an email for every
unstable build (default true)
.IP \(bu 2
\fBsend\-to\-individuals\fP (\fIbool\fP) \-\- Send an email to the individual
who broke the build (default false)
.IP \(bu 2
\fBnotify\-for\-each\-module\fP (\fIbool\fP) \-\- Send an email for each module
(e.g. failed, unstable). (default true)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
reporters:
  \- email:
      recipients: breakage@example.com
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B findbugs()
FindBugs reporting for builds
.sp
Requires the Jenkins FindBugs Plugin
(\fI\%https://github.com/jenkinsci/findbugs\-plugin\fP).
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrank\-priority\fP (\fIbool\fP) \-\- Use rank as priority (default false)
.IP \(bu 2
\fBinclude\-files\fP (\fIstr\fP) \-\- Comma separated list of files to include.
(Optional)
.IP \(bu 2
\fBexclude\-files\fP (\fIstr\fP) \-\- Comma separated list of files to exclude.
(Optional)
.IP \(bu 2
\fBcan\-run\-on\-failed\fP (\fIbool\fP) \-\- Weather or not to run plug\-in on failed builds
(default false)
.IP \(bu 2
\fBhealthy\fP (\fIint\fP) \-\- Sunny threshold (optional)
.IP \(bu 2
\fBunhealthy\fP (\fIint\fP) \-\- Stormy threshold (optional)
.IP \(bu 2
\fBhealth\-threshold\fP (\fIstr\fP) \-\- Threshold priority for health status
(\(aqlow\(aq, \(aqnormal\(aq or \(aqhigh\(aq, defaulted to \(aqlow\(aq)
.IP \(bu 2
\fBdont\-compute\-new\fP (\fIbool\fP) \-\- If set to false, computes new warnings based on
the reference build (default true)
.IP \(bu 2
\fBuse\-delta\-values\fP (\fIbool\fP) \-\- Use delta for new warnings. (default false)
.IP \(bu 2
\fBuse\-previous\-build\-as\-reference\fP (\fIbool\fP) \-\- If set then the number of new
warnings will always be calculated based on the previous build.
Otherwise the reference build. (default false)
.IP \(bu 2
\fBuse\-stable\-build\-as\-reference\fP (\fIbool\fP) \-\- The number of new warnings will be
calculated based on the last stable build, allowing reverts of unstable
builds where the number of warnings was decreased. (default false)
.IP \(bu 2
\fBthresholds\fP (\fIdict\fP) \-\- .INDENT 2.0
.TP
.B thresholds
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBunstable\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B unstable
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBfailed\fP (\fIdict\fP)
.INDENT 7.0
.TP
.B failed
.INDENT 7.0
.IP \(bu 2
\fBtotal\-all\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-high\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBtotal\-low\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-all\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-high\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-normal\fP (\fIint\fP)
.IP \(bu 2
\fBnew\-low\fP (\fIint\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
project\-type: maven
reporters:
    \- findbugs

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
project\-type: maven
reporters:
    \- findbugs:
        rank\-priority: true
        include\-files: \(aqf,d,e,.*\(aq
        exclude\-files: \(aqa,c,d,.*\(aq
        can\-run\-on\-failed: true
        healthy: 80
        unhealthy: 10
        use\-delta\-values: true
        health\-threshold: \(aqhigh\(aq
        thresholds:
            unstable:
                total\-all: 90
                total\-high: 80
                total\-normal: 50
                total\-low: 20
                new\-all: 95
                new\-high: 85
                new\-normal: 55
                new\-low: 25
            failed:
                total\-all: 80
                total\-high: 70
                total\-normal: 40
                total\-low: 10
                new\-all: 85
                new\-high: 75
                new\-normal: 45
                new\-low: 15
        dont\-compute\-new: false
        use\-delta\-values: true
        use\-previous\-build\-as\-reference: true
        use\-stable\-build\-as\-reference: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS SCM
.sp
The SCM module allows you to specify the source code location for the
project.  It adds the \fBscm\fP attribute to the \fI\%Job\fP definition,
which accepts any number of scm definitions. It is also possible to pass
\fB[]\fP to the \fBscm\fP attribute. This is useful when a set of configs has a
global default \fBscm\fP and you want to a particular job to override that
default with no SCM.
.INDENT 0.0
.TP
\fBComponent\fP: scm
.INDENT 7.0
.TP
.B Macro
scm
.TP
.B Entry Point
jenkins_jobs.scm
.UNINDENT
.UNINDENT
.sp
The scm module allows referencing multiple repositories in a Jenkins job.
Note: Adding more than one scm definition requires the Jenkins
\fI\%Multiple SCMs plugin\fP\&.
.INDENT 0.0
.TP
.B Example of multiple repositories in a single job:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- scm:
    name: first\-scm
    scm:
      \- git:
         url: ssh://jenkins@review.openstack.org:29418/first.git
         branches:
          \- origin/master

\- scm:
    name: second\-scm
    scm:
      \- git:
         url: ssh://jenkins@review.openstack.org:29418/second.git
         branches:
          \- origin/master

\- scm:
    name: first\-and\-second
    scm:
      \- first\-scm
      \- second\-scm

\- job:
    name: my\-job
    scm:
      \- first\-and\-second

.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B Example of an empty \fBscm\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm: []

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  scm.PipelineSCM(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqpipeline\-scm\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqpipeline\-scm\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  30
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  scm.SCM(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqscm\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqscm\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  30
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B accurev()
Specifies the AccuRev SCM repository for this job.
.sp
Requires the Jenkins \fI\%AccuRev Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBdepot\fP (\fIstr\fP) \-\- Depot you want to use for the current job (optional)
.IP \(bu 2
\fBstream\fP (\fIstr\fP) \-\- Stream where the build will be generated from (optional)
.IP \(bu 2
\fBserver\-name\fP (\fIstr\fP) \-\- AccuRev server you are using
for your builds (required)
.IP \(bu 2
\fBignore\-parent\-changes\fP (\fIbool\fP) \-\- Ignore possibility
of changes in the parent stream (default false)
.IP \(bu 2
\fBclean\-reference\-tree\fP (\fIbool\fP) \-\- Deletes any external files
in reference tree (default false)
.IP \(bu 2
\fBbuild\-from\-snapshot\fP (\fIbool\fP) \-\- Creates snapshot
of the target stream, then populates and
builds from that snapshot (default false)
.IP \(bu 2
\fBdo\-not\-pop\-content\fP (\fIbool\fP) \-\- If checkbox is on, elements
are not populating vice versa (default false)
.IP \(bu 2
\fBworkspace\fP (\fIstr\fP) \-\- Name of existing workspace (optional)
.IP \(bu 2
\fBreference\-tree\fP (\fIstr\fP) \-\- Name of the reference tree (optional)
.IP \(bu 2
\fBdirectory\-offset\fP (\fIstr\fP) \-\- Relative directory path from
the default Jenkins workspace location
where the files from the stream, workspace,
or reference tree should be retrieved from. (optional)
.IP \(bu 2
\fBsub\-path\fP (\fIstr\fP) \-\- Makes a \(dqbest effort\(dq to ensure
that only the sub\-path is populated (optional)
.IP \(bu 2
\fBfilter\-poll\-scm\fP (\fIstr\fP) \-\- Specify directories or
files you want Jenkins to check before starting a build (optional)
.IP \(bu 2
\fBsnapshot\-name\-format\fP (\fIstr\fP) \-\- Naming conventions
for the snapshot in this field (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- accurev:
      depot: Test depot
      stream: Test stream
      server\-name: Test server name
      ignore\-parent\-changes: true
      clean\-reference\-tree: true
      build\-from\-snapshot: true
      do\-not\-pop\-content: true
      workspace: Test workspace
      reference\-tree: Test reference tree
      directory\-offset: Test directory offset
      sub\-path: Test sub path
      filter\-poll\-scm: Test filter
      snapshot\-name\-format: Test snapshot name format

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B bzr()
Specifies the bzr SCM repository for this job.
.sp
Requires the Jenkins \fI\%Bazaar Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL of the bzr branch (required)
.IP \(bu 2
\fBclean\-tree\fP (\fIbool\fP) \-\- Clean up the workspace (using bzr) before pulling
the branch (default false)
.IP \(bu 2
\fBlightweight\-checkout\fP (\fIbool\fP) \-\- Use a lightweight checkout instead of a
full branch (default false)
.IP \(bu 2
\fBbrowser\fP (\fIstr\fP) \-\- 
.sp
The repository browser to use.
.INDENT 2.0
.TP
.B browsers supported
.INDENT 7.0
.IP \(bu 2
\fBauto\fP \- (default)
.IP \(bu 2
\fBloggerhead\fP \- as used by Launchpad
.IP \(bu 2
\fBopengrok\fP \- \fI\%https://opengrok.github.io/OpenGrok/\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbrowser\-url\fP (\fIstr\fP) \-\- URL for the repository browser (required if browser is set).
.IP \(bu 2
\fBopengrok\-root\-module\fP (\fIstr\fP) \-\- Root module for OpenGrok (required if browser is opengrok).
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- bzr:
      url: lp:test_project

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B cvs()
Specifies the CVS SCM repository for this job.
.sp
Requires the Jenkins \fI\%CVS Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrepos\fP (\fIlist\fP) \-\- 
.sp
List of CVS repositories. (required)
.INDENT 2.0
.TP
.B Repos
.INDENT 7.0
.IP \(bu 2
\fBroot\fP (\fIstr\fP) \-\- The CVS connection string Jenkins uses to
connect to the server. The format is :protocol:user@host:path
(required)
.IP \(bu 2
\fBlocations\fP (\fIlist\fP) \-\- List of locations. (required)
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Locations
.INDENT 7.0
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- Type of location.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B supported values
.INDENT 7.0
.IP \(bu 2
\fBHEAD\fP \- (default)
.IP \(bu 2
\fBBRANCH\fP
.IP \(bu 2
\fBTAG\fP
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name of location. Only valid in case
of \(aqBRANCH\(aq or \(aqTAG\(aq location type. (default \(aq\(aq)
.IP \(bu 2
\fBuse\-head\fP (\fIbool\fP) \-\- Use Head if not found. Only
valid in case of \(aqBRANCH\(aq or \(aqTAG\(aq location type.
(default false)
.IP \(bu 2
\fBmodules\fP (\fIlist\fP) \-\- List of modules. (required)
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Modules
.INDENT 7.0
.IP \(bu 2
\fBremote\fP \-\- The name of the module in the
repository at CVSROOT. (required)
.IP \(bu 2
\fBlocal\-name\fP \-\-  The name to be applied to
this module in the local workspace. If blank,
the remote module name will be used.
(default \(aq\(aq)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBexcluded\-regions\fP (\fIlist str\fP) \-\- Patterns for excluding
regions. (optional)
.IP \(bu 2
\fBcompression\-level\fP (\fIint\fP) \-\- Compression level. Must be a
number between \-1 and 9 inclusive. Choose \-1 for System Default.
(default \-1)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBuse\-update\fP (\fIbool\fP) \-\- If true, Jenkins will use \(aqcvs update\(aq whenever
possible for builds. This makes a build faster. But this also causes the
artifacts from the previous build to remain in the file system when a
new build starts, making it not a true clean build. (default true)
.IP \(bu 2
\fBprune\-empty\fP (\fIbool\fP) \-\- Remove empty directories after checkout using the
CVS \(aq\-P\(aq option. (default true)
.IP \(bu 2
\fBskip\-changelog\fP (\fIbool\fP) \-\- Prevent the changelog being generated after
checkout has completed. (default false)
.IP \(bu 2
\fBshow\-all\-output\fP (\fIbool\fP) \-\- Instructs CVS to show all logging output. CVS
normally runs in quiet mode but this option disables that.
(default false)
.IP \(bu 2
\fBclean\-checkout\fP (\fIbool\fP) \-\- Perform clean checkout on failed update.
(default false)
.IP \(bu 2
\fBclean\-copy\fP (\fIbool\fP) \-\- Force clean copy for locally modified files.
(default false)
.UNINDENT
.UNINDENT
.sp
Example
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- cvs:
      repos:
          \- root: \(dq:protocol:user@host1:path\(dq
            locations:
                \- modules:
                    \- remote: \(dqremote1\(dq
                    \- remote: \(dqremote2\(dq
          \- root: \(dq:protocol:user@host2:path\(dq
            locations:
                \- modules:
                    \- remote: \(dqremote1\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- cvs:
      repos:
          \- root: \(dq:protocol:user@host1:path\(dq
            compression\-level: \(dq1\(dq
            locations:
                \- type: TAG
                  name: \(dqtag name\(dq
                  use\-head: false
                  modules:
                    \- remote: \(dqremote1\(dq
                      local\-name: \(dqlocalName\(dq
                    \- remote: \(dqremote2\(dq
            excluded\-regions:
                \- \(dqpattern1\(dq
                \- \(dqpattern2\(dq
          \- root: \(dq:protocol:user@host2:path\(dq
            locations:
                \- modules:
                    \- remote: \(dqremote1\(dq
      use\-update: false
      prune\-empty: false
      skip\-changelog: true
      show\-all\-output: true
      clean\-checkout: true
      clean\-copy: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dimensions()
Specifies the Dimensions SCM repository for this job.
.sp
Requires Jenkins \fI\%Dimensions Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproject\fP (\fIstr\fP) \-\- Project name of format PRODUCT_ID:PROJECT_NAME (required)
.IP \(bu 2
\fBpermissions\fP (\fIstr\fP) \-\- 
.sp
Default Permissions for updated files
(default: DEFAULT)
.INDENT 2.0
.TP
.B Permissions
.INDENT 7.0
.IP \(bu 2
\fBDEFAULT\fP
.IP \(bu 2
\fBREADONLY\fP
.IP \(bu 2
\fBWRITABLE\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBeol\fP (\fIstr\fP) \-\- 
.sp
End of line (default: DEFAULT)
.INDENT 2.0
.TP
.B End of line
.INDENT 7.0
.IP \(bu 2
\fBDEFAULT\fP
.IP \(bu 2
\fBUNIX\fP
.IP \(bu 2
\fBWINDOWS\fP
.IP \(bu 2
\fBUNCHANGED\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBfolders\fP (\fIlist\fP) \-\- Folders to monitor (default /)
.IP \(bu 2
\fBexclude\fP (\fIlist\fP) \-\- Paths to exclude from monitor
.IP \(bu 2
\fBusername\fP (\fIstr\fP) \-\- Repository username for this job
.IP \(bu 2
\fBpassword\fP (\fIstr\fP) \-\- Repository password for this job
.IP \(bu 2
\fBserver\fP (\fIstr\fP) \-\- Dimensions server for this job
.IP \(bu 2
\fBdatabase\fP (\fIstr\fP) \-\- Dimensions database for this job.
Format must be \fI\%database@dsn\fP
.IP \(bu 2
\fBupdate\fP (\fIbool\fP) \-\- Use update (default false)
.IP \(bu 2
\fBclear\-workspace\fP (\fIbool\fP) \-\- Clear workspace prior to build (default false)
.IP \(bu 2
\fBforce\-build\fP (\fIbool\fP) \-\- Force build even if the repository SCM checkout
operation fails (default false)
.IP \(bu 2
\fBoverwrite\-modified\fP (\fIbool\fP) \-\- Overwrite files in worspace from
repository files (default false)
.IP \(bu 2
\fBexpand\-vars\fP (\fIbool\fP) \-\- Expand substitution variables (default false)
.IP \(bu 2
\fBno\-metadata\fP (\fIbool\fP) \-\- Checkout files with no metadata (default false)
.IP \(bu 2
\fBmaintain\-timestamp\fP (\fIbool\fP) \-\- Maintain file timestamp from Dimensions
(default false)
.IP \(bu 2
\fBslave\-checkout\fP (\fIbool\fP) \-\- Force slave based checkout (default false)
.IP \(bu 2
\fBtimezone\fP (\fIstr\fP) \-\- Server timezone
.IP \(bu 2
\fBweb\-url\fP (\fIstr\fP) \-\- Dimensions Web URL
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- dimensions:
      project: myProduct:myProject

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- dimensions:
      project: myProduct:myProject
      permissions: WRITABLE
      eol: UNIX
      folders:
        \- src
        \- test
      exclude:
        \- excluded_dir
        \- excluded_other_dir
      username: johnd
      password: passw0rd
      server: my.dmscm.server:1234
      database: myDatabase@myDsn
      update: true
      clear\-workspace: true
      force\-build: true
      overwrite\-modified: true
      expand\-vars: true
      no\-metadata: true
      maintain\-timestamp: true
      slave\-checkout: true
      timezone: Europe/Berlin
      web\-url: https://my.dmscm.weburl

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B git()
Specifies the git SCM repository for this job.
.sp
Requires the Jenkins \fI\%Git Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL of the git repository
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- ID of credential to use to connect, which is the
last field (a 32\-digit hexadecimal code) of the path of URL visible
after you clicked the credential under Jenkins Global credentials.
(optional)
.IP \(bu 2
\fBrefspec\fP (\fIstr\fP) \-\- refspec to fetch (default
\(aq+refs/heads/*:refs/remotes/remoteName/*\(aq)
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- name to fetch (default \(aqorigin\(aq)
.IP \(bu 2
\fBremotes\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- 
.sp
list of remotes to set up (optional, only needed if
multiple remotes need to be set up)
.INDENT 2.0
.TP
.B Remote
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstring\fP) \- url of remote repo
.IP \(bu 2
\fBrefspec\fP (\fIstring\fP) \- refspec to fetch (optional)
.IP \(bu 2
\fBcredentials\-id\fP \- ID of credential to use to connect, which
is the last field of the path of URL (a 32\-digit hexadecimal
code) visible after you clicked credential under Jenkins Global
credentials. (optional)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbranches\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- list of branch specifiers to build (default \(aq**\(aq)
.IP \(bu 2
\fBskip\-tag\fP (\fIbool\fP) \-\- 
.sp
Skip tagging (default true)
.sp
Deprecated since version 2.0.0.: Please use per\-build\-tag extension, which has
the inverse meaning.


.IP \(bu 2
\fBclean\fP (\fIbool\fP) \-\- 
.sp
Clean after checkout (default false)
.sp
Deprecated since version 1.1.1.: Please use clean extension format.


.IP \(bu 2
\fBfastpoll\fP (\fIbool\fP) \-\- Use fast remote polling (default false)
.IP \(bu 2
\fBdisable\-submodules\fP (\fIbool\fP) \-\- 
.sp
Disable submodules (default false)
.sp
Deprecated since version 1.1.1.: Please use submodule extension.


.IP \(bu 2
\fBrecursive\-submodules\fP (\fIbool\fP) \-\- 
.sp
Recursively update submodules (default
false)
.INDENT 2.0
.INDENT 3.5
Deprecated since version 1.1.1.: Please use submodule extension.

.UNINDENT
.UNINDENT

.IP \(bu 2
\fBgit\-tool\fP (\fIstr\fP) \-\- The name of the Git installation to use (default
\(aqDefault\(aq)
.IP \(bu 2
\fBreference\-repo\fP (\fIstr\fP) \-\- Path of the reference repo to use during clone
(optional)
.IP \(bu 2
\fBbrowser\fP (\fIstr\fP) \-\- 
.sp
what repository browser to use.
.INDENT 2.0
.TP
.B browsers supported
.INDENT 7.0
.IP \(bu 2
\fBauto\fP \- (default)
.IP \(bu 2
\fBassemblaweb\fP \- \fI\%https://www.assembla.com/home\fP
.IP \(bu 2
\fBbitbucketweb\fP \- \fI\%https://bitbucket.org/\fP
.IP \(bu 2
\fBcgit\fP \- \fI\%https://git.zx2c4.com/cgit/about/\fP
.IP \(bu 2
\fBfisheye\fP \- \fI\%https://www.atlassian.com/software/fisheye\fP
.IP \(bu 2
\fBgitblit\fP \- \fI\%http://gitblit.com/\fP
.IP \(bu 2
\fBgithubweb\fP \- \fI\%https://github.com/\fP
.IP \(bu 2
\fBgitiles\fP \- \fI\%https://code.google.com/archive/p/gitiles/\fP
.IP \(bu 2
\fBgitlab\fP \- \fI\%https://about.gitlab.com/\fP
.IP \(bu 2
\fBgitlist\fP \- \fI\%http://gitlist.org/\fP
.IP \(bu 2
\fBgitoriousweb\fP \- \fI\%https://gitorious.org/\fP
.IP \(bu 2
\fBgitweb\fP \- \fI\%https://git\-scm.com/docs/gitweb\fP
.IP \(bu 2
\fBkiln\fP \- \fI\%https://www.fogbugz.com/version\-control\fP
.IP \(bu 2
\fBmicrosoft\-tfs\-2013\fP \- \fI\%https://azure.microsoft.com/en\-us/services/devops/server\fP
.IP \(bu 2
\fBphabricator\fP \- \fI\%https://www.phacility.com/\fP
.IP \(bu 2
\fBredmineweb\fP \- \fI\%https://www.redmine.org/\fP
.IP \(bu 2
\fBrhodecode\fP \- \fI\%https://rhodecode.com/\fP
.IP \(bu 2
\fBstash\fP \- \fI\%https://www.atlassian.com/software/bitbucket/enterprise/data\-center\fP
.IP \(bu 2
\fBviewgit\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbrowser\-url\fP (\fIstr\fP) \-\- url for the repository browser (required if browser
is not \(aqauto\(aq, no default)
.IP \(bu 2
\fBbrowser\-version\fP (\fIstr\fP) \-\- version of the repository browser (GitLab only,
default \(aq0.0\(aq)
.IP \(bu 2
\fBproject\-name\fP (\fIstr\fP) \-\- project name in Gitblit and ViewGit repobrowser
(optional)
.IP \(bu 2
\fBrepo\-name\fP (\fIstr\fP) \-\- repository name in phabricator repobrowser (optional)
.IP \(bu 2
\fBgit\-config\-name\fP (\fIstr\fP) \-\- Configure name for Git clone (optional)
.IP \(bu 2
\fBgit\-config\-email\fP (\fIstr\fP) \-\- Configure email for Git clone (optional)
.UNINDENT
.TP
.B Extensions
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBbasedir\fP (\fIstring\fP) \- Location relative to the workspace root to
clone to (default workspace)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBchangelog\-against\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBremote\fP (\fIstring\fP) \- name of repo that contains branch to
create changelog against (default \(aqorigin\(aq)
.IP \(bu 2
\fBbranch\fP (\fIstring\fP) \- name of the branch to create changelog
against (default \(aqmaster\(aq)
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBchoosing\-strategy\fP: (\fIstring\fP) \- Jenkins class for selecting what
to build. Can be one of \fIdefault\fP,\(gainverse\(ga, or \fIgerrit\fP
(default \(aqdefault\(aq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBclean\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBafter\fP (\fIbool\fP) \- Clean the workspace after checkout
.IP \(bu 2
\fBbefore\fP (\fIbool\fP) \- Clean the workspace before checkout
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBcommitter\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \- Name to use as author of new commits
.IP \(bu 2
\fBemail\fP (\fIstr\fP) \- E\-mail address to use for new commits
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBexcluded\-users\fP: (\fIlist(string)\fP) \- list of users to ignore
revisions from when polling for changes.
(if polling is enabled, optional)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBincluded\-regions\fP: (\fIlist(string)\fP) \- list of file/folders to
include (optional)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBexcluded\-regions\fP: (\fIlist(string)\fP) \- list of file/folders to
exclude (optional)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBignore\-commits\-with\-messages\fP (\fIlist(str)\fP) \- Revisions committed
with messages matching these patterns will be ignored. (optional)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBignore\-notify\fP: (\fIbool\fP) \- Ignore notifyCommit URL accesses
(default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBforce\-polling\-using\-workspace\fP (\fIbool\fP) \- Force polling using
workspace (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBlocal\-branch\fP (\fIstring\fP) \- Checkout/merge to local branch
(optional)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBmerge\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBremote\fP (\fIstring\fP) \- name of repo that contains branch to
merge to (default \(aqorigin\(aq)
.IP \(bu 2
\fBbranch\fP (\fIstring\fP) \- name of the branch to merge to
.IP \(bu 2
\fBstrategy\fP (\fIstring\fP) \- merge strategy. Can be one of
\(aqdefault\(aq, \(aqresolve\(aq, \(aqrecursive\(aq, \(aqoctopus\(aq, \(aqours\(aq,
\(aqsubtree\(aq. (default \(aqdefault\(aq)
.IP \(bu 2
\fBfast\-forward\-mode\fP (\fIstring\fP) \- merge fast\-forward mode.
Can be one of \(aqFF\(aq, \(aqFF_ONLY\(aq or \(aqNO_FF\(aq. (default \(aqFF\(aq)
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBper\-build\-tag\fP (\fIbool\fP) \- Create a tag in the workspace for every
build. (default is inverse of skip\-tag if set, otherwise false)
.UNINDENT
.IP \(bu 2
\fBprune\fP (\fIbool\fP) \- Prune remote branches (default false)
.IP \(bu 2
.INDENT 2.0
.TP
\fBscm\-name\fP (\fIstring\fP) \- The unique scm name for this Git SCM
(optional)
.UNINDENT
.IP \(bu 2
\fBshallow\-clone\fP (\fIbool\fP) \- Perform shallow clone (default false)
.IP \(bu 2
\fBdepth\fP (\fIint\fP) \- Set shallow clone depth (default 1)
.IP \(bu 2
.INDENT 2.0
.TP
\fBdo\-not\-fetch\-tags\fP (\fIbool\fP) \- Perform a clone without tags
(default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBhonor\-refspec\fP (\fIbool\fP) \- Perform initial clone using the refspec
defined for the repository (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBskip\-notifications\fP (\fIbool\fP) \- Skip build status notifications
(default false). Requires the Jenkins
\fI\%Skip Notifications Trait Plugin\fP\&.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBsparse\-checkout\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBpaths\fP (\fIlist\fP) \- List of paths to sparse checkout. (optional)
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBsubmodule\fP (\fIdict\fP)
.INDENT 7.0
.IP \(bu 2
\fBdisable\fP (\fIbool\fP) \- By disabling support for submodules you
can still keep using basic git plugin functionality and just have
Jenkins to ignore submodules completely as if they didn\(aqt exist.
.IP \(bu 2
\fBrecursive\fP (\fIbool\fP) \- Retrieve all submodules recursively
(uses \(aq\-\-recursive\(aq option which requires git>=1.6.5)
.IP \(bu 2
\fBtracking\fP (\fIbool\fP) \- Retrieve the tip of the configured
branch in .gitmodules (Uses \(aq\-\-remote\(aq option which requires
git>=1.8.2)
.IP \(bu 2
\fBparent\-credentials\fP (\fIbool\fP) \- Use credentials from default
remote of parent repository (default false).
.IP \(bu 2
\fBreference\-repo\fP (\fIstr\fP) \- Path of the reference repo to use
during clone (optional)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \- Specify a timeout (in minutes) for
submodules operations (default 10).
.IP \(bu 2
\fBthreads\fP (\fIint\fP) \- Number of parallel processes to be used when
updating submodules. Default is to use a single thread for submodule updates.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBtimeout\fP (\fIstr\fP) \- Timeout for git commands in minutes (optional)
.IP \(bu 2
.INDENT 2.0
.TP
\fBuse\-author\fP (\fIbool\fP): Use author rather than committer in Jenkin\(aqs
build changeset (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBwipe\-workspace\fP (\fIbool\fP) \- Wipe out workspace before build
(default true)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBlfs\-pull\fP (\fIbool\fP) \- Call git lfs pull after checkout
(default false)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- git:
      url: https://example.com/project.git
      branches:
        \- master
        \- stable
      browser: githubweb
      browser\-url: http://github.com/foo/example.git
      timeout: 20

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B hg()
Specifies the mercurial SCM repository for this job.
.sp
Requires the Jenkins \fI\%Mercurial Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL of the hg repository (required)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- ID of credentials to use to connect (optional)
.IP \(bu 2
\fBrevision\-type\fP (\fIstr\fP) \-\- revision type to use (default \(aqbranch\(aq)
.IP \(bu 2
\fBrevision\fP (\fIstr\fP) \-\- the branch or tag name you would like to track
(default \(aqdefault\(aq)
.IP \(bu 2
\fBmodules\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- reduce unnecessary builds by specifying a list of
\(dqmodules\(dq within the repository. A module is a directory name within
the repository that this project lives in. (default \(aq\(aq)
.IP \(bu 2
\fBclean\fP (\fIbool\fP) \-\- wipe any local modifications or untracked files in the
repository checkout (default false)
.IP \(bu 2
\fBsubdir\fP (\fIstr\fP) \-\- check out the Mercurial repository into this
subdirectory of the job\(aqs workspace (optional)
.IP \(bu 2
\fBdisable\-changelog\fP (\fIbool\fP) \-\- do not calculate the Mercurial changelog
for each build (default false)
.IP \(bu 2
\fBbrowser\fP (\fIstr\fP) \-\- 
.sp
what repository browser to use
.INDENT 2.0
.TP
.B browsers supported
.INDENT 7.0
.IP \(bu 2
\fBauto\fP \- (default)
.IP \(bu 2
\fBbitbucketweb\fP \- \fI\%https://bitbucket.org/\fP
.IP \(bu 2
\fBfisheye\fP \- \fI\%https://www.atlassian.com/software/fisheye\fP
.IP \(bu 2
\fBgooglecode\fP \- \fI\%https://code.google.com/\fP
.IP \(bu 2
\fBhgweb\fP \- \fI\%https://www.mercurial\-scm.org/repo/hg/help/hgweb\fP
.IP \(bu 2
\fBkilnhg\fP \- \fI\%https://www.fogbugz.com/version\-control\fP
.IP \(bu 2
\fBrhodecode\fP \- \fI\%https://rhodecode.com/\fP (versions >= 1.2)
.IP \(bu 2
\fBrhodecode\-pre\-1.2.0\fP \- \fI\%https://rhodecode.com/\fP (versions < 1.2)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbrowser\-url\fP (\fIstr\fP) \-\- url for the repository browser
(required if browser is set)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- hg:
     revision: feature
     url: ssh://hg@hg/repo
     credentials\-id: \(dqabcdef01234567890\(dq
     modules:
       \- module1
       \- module2
     clean: true
     subdir: my/sources
     disable\-changelog: true
     browser: hgweb
     browser\-url: http://hg/repo

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openshift\-img\-streams()
Rather than a Build step extension plugin, this is an extension of the
Jenkins SCM plugin, where this baked\-in polling mechanism provided by
Jenkins is leveraged by exposing some of the common semantics between
OpenShift ImageStreams (which are abstractions of Docker repositories)
and SCMs \- versions / commit IDs of related artifacts
(images vs. programmatics files)
.sp
Requires the Jenkins \fI\%OpenShift Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBimage\-stream\-name\fP (\fIstr\fP) \-\- The name of the ImageStream is what shows up
in the NAME column if you dump all the ImageStream\(aqs with the
\fIoc get is\fP command invocation. (default nodejs\-010\-centos7)
.IP \(bu 2
\fBtag\fP (\fIstr\fP) \-\- The specific image tag within the ImageStream to monitor.
(default latest)
.IP \(bu 2
\fBapi\-url\fP (\fIstr\fP) \-\- This would be the value you specify if you leverage the
\-\-server option on the OpenShift \fIoc\fP command.
(default https://openshift.default.svc.cluster.local)
.IP \(bu 2
\fBnamespace\fP (\fIstr\fP) \-\- The value here should be whatever was the output
form \fIoc project\fP when you created the BuildConfig you want to run
a Build on. (default test)
.IP \(bu 2
\fBauth\-token\fP (\fIstr\fP) \-\- The value here is what you supply with the \-\-token
option when invoking the OpenShift \fIoc\fP command. (default \(aq\(aq)
.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- This flag is the toggle for
turning on or off detailed logging in this plug\-in. (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- openshift\-img\-streams:
      image\-stream\-name: nodejs\-010\-fedora
      tag: prod
      api\-url: https://openshift.example.local.url/
      namespace: test\-scm
      auth\-token: ose\-key\-img\-streams1
      verbose: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- openshift\-img\-streams

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B p4()
Specifies the Perforce (P4) repository for this job.
.sp
Requires the Jenkins \fI\%P4 Plugin\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B repo()
Specifies the repo SCM repository for this job.
.sp
Requires the Jenkins \fI\%Repo Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBmanifest\-url\fP (\fIstr\fP) \-\- URL of the repo manifest (required)
.IP \(bu 2
\fBmanifest\-branch\fP (\fIstr\fP) \-\- The branch of the manifest to use (optional)
.IP \(bu 2
\fBmanifest\-file\fP (\fIstr\fP) \-\- Initial manifest file to use when initialising
(optional)
.IP \(bu 2
\fBmanifest\-group\fP (\fIstr\fP) \-\- Only retrieve those projects in the manifest
tagged with the provided group name (optional)
.IP \(bu 2
\fBignore\-projects\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- a list of projects in which changes would
not be considered to trigger a build when pooling (optional)
.IP \(bu 2
\fBdestination\-dir\fP (\fIstr\fP) \-\- Location relative to the workspace root to clone
under (optional)
.IP \(bu 2
\fBrepo\-url\fP (\fIstr\fP) \-\- custom url to retrieve the repo application (optional)
.IP \(bu 2
\fBmirror\-dir\fP (\fIstr\fP) \-\- Path to mirror directory to reference when
initialising (optional)
.IP \(bu 2
\fBjobs\fP (\fIint\fP) \-\- Number of projects to fetch simultaneously (default 0)
.IP \(bu 2
\fBdepth\fP (\fIint\fP) \-\- Specify the depth in history to sync from the source. The
default is to sync all of the history. Use 1 to just sync the most
recent commit (default 0)
.IP \(bu 2
\fBcurrent\-branch\fP (\fIbool\fP) \-\- Fetch only the current branch from the server
(default true)
.IP \(bu 2
\fBreset\-first\fP (\fIbool\fP) \-\- Remove any commits that are not on the repositories
by running the following command before anything else (default false):
\fBrepo forall \-c \(dqgit reset \-\-hard\(dq\fP
.IP \(bu 2
\fBquiet\fP (\fIbool\fP) \-\- Make repo more quiet
(default true)
.IP \(bu 2
\fBforce\-sync\fP (\fIbool\fP) \-\- Continue sync even if a project fails to sync
(default false)
.IP \(bu 2
\fBno\-tags\fP (\fIbool\fP) \-\- Don\(aqt fetch tags (default false)
.IP \(bu 2
\fBtrace\fP (\fIbool\fP) \-\- Trace git command execution into the build logs. (default
false)
.IP \(bu 2
\fBshow\-all\-changes\fP (\fIbool\fP) \-\- When this is checked \-\-first\-parent is no
longer passed to git log when determining changesets (default false)
.IP \(bu 2
\fBlocal\-manifest\fP (\fIstr\fP) \-\- Contents of .repo/local_manifest.xml, written
prior to calling sync (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- repo:
      manifest\-url: https://example.com/project/
      manifest\-branch: stable
      manifest\-file: repo.xml
      manifest\-group: drivers
      ignore\-projects:
        \- static\-project
        \- unimportant\-project
      destination\-dir: build
      repo\-url: https://internal.net/projects/repo
      mirror\-dir: ~/git/project/
      jobs: 3
      current\-branch: false
      reset\-first: true
      quiet: false
      force\-sync: true
      no\-tags: true
      trace: true
      show\-all\-changes: true
      local\-manifest: |
        <?xml version=\(dq1.0\(dq encoding=\(dqUTF\-8\(dq?>
        <manifest>
          <project path=\(dqexternal/project\(dq name=\(dqorg/project\(dq
            remote=\(dqgerrit\(dq revision=\(dqmaster\(dq />
        </manifest>

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B store()
Specifies the Visualworks Smalltalk Store repository for this job.
.sp
Requires the Jenkins \fI\%Visualworks Smalltalk Store Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBscript\fP (\fIstr\fP) \-\- name of the Store script to run
.IP \(bu 2
\fBrepository\fP (\fIstr\fP) \-\- name of the Store repository
.IP \(bu 2
\fBversion\-regex\fP (\fIstr\fP) \-\- regular expression that specifies which pundle
versions should be considered (optional)
.IP \(bu 2
\fBminimum\-blessing\fP (\fIstr\fP) \-\- minimum blessing level to consider (optional)
.IP \(bu 2
\fBparcel\-builder\-file\fP (\fIstr\fP) \-\- name of the file to generate as input to
a later parcel building step (optional \- if not specified, then no
parcel builder file will be generated)
.IP \(bu 2
\fBpundles\fP (\fIlist\fP) \-\- .INDENT 2.0
.TP
.B (package or bundle)
(\fIdict\fP): A package or bundle to check
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- store:
      script: someStoreScript
      repository: StoreRepository
      version\-regex: \(dq[0\-9]+\(dq
      minimum\-blessing: Integrated
      parcel\-builder\-file: parcelBuilderInput
      pundles:
        \- package: SomePackage
        \- package: AnotherPackage
        \- bundle: SomeBundle

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B svn()
Specifies the svn SCM repository for this job.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL of the svn repository
.IP \(bu 2
\fBbasedir\fP (\fIstr\fP) \-\- location relative to the workspace root to checkout to
(default \(aq.\(aq)
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- optional argument to specify the ID of credentials
to use
.IP \(bu 2
\fBrepo\-depth\fP (\fIstr\fP) \-\- Repository depth. Can be one of \(aqinfinity\(aq, \(aqempty\(aq,
\(aqfiles\(aq, \(aqimmediates\(aq or \(aqunknown\(aq. (default \(aqinfinity\(aq)
.IP \(bu 2
\fBignore\-externals\fP (\fIbool\fP) \-\- Ignore Externals. (default false)
.IP \(bu 2
\fBworkspaceupdater\fP (\fIstr\fP) \-\- optional argument to specify
.IP \(bu 2
\fBworkspaceupdater\fP \-\- 
.sp
optional argument to specify how to update the
workspace (default wipeworkspace)
.INDENT 2.0
.TP
.B supported values
.INDENT 7.0
.IP \(bu 2
\fBwipeworkspace\fP \- deletes the workspace before checking out
.IP \(bu 2
\fBrevertupdate\fP \- do an svn revert then an svn update
.IP \(bu 2
\fBemulateclean\fP \- delete unversioned/ignored files then update
.IP \(bu 2
\fBupdate\fP \- do an svn update as much as possible
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBexcluded\-users\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- list of users to ignore revisions from
when polling for changes (if polling is enabled; parameter is optional)
.IP \(bu 2
\fBincluded\-regions\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- list of file/folders to include
(optional)
.IP \(bu 2
\fBexcluded\-regions\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- list of file/folders to exclude (optional)
.IP \(bu 2
\fBexcluded\-commit\-messages\fP (\fIlist\fP\fI(\fP\fIstr\fP\fI)\fP) \-\- list of commit messages to exclude
(optional)
.IP \(bu 2
\fBexclusion\-revprop\-name\fP (\fIstr\fP) \-\- revision svn\-property to ignore (optional)
.IP \(bu 2
\fBignore\-property\-changes\-on\-directories\fP (\fIbool\fP) \-\- ignore svn\-property only
changes of directories (default false)
.IP \(bu 2
\fBfilter\-changelog\fP (\fIbool\fP) \-\- If set Jenkins will apply the same inclusion
and exclusion patterns for displaying changelog entries as it does for
polling for changes (default false)
.IP \(bu 2
\fBrepos\fP (\fIlist\fP) \-\- list of repositories to checkout (optional)
.IP \(bu 2
\fBadditional\-credentials\fP (\fIlist\fP) \-\- 
.sp
list of additional credentials (optional)
:Additional\-Credentials:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBrealm\fP (\fIstr\fP) \-\-  realm to use
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- optional ID of credentials to use
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBviewvc\-url\fP (\fIstr\fP) \-\- 
.sp
URL of the svn web interface (optional)
.INDENT 2.0
.TP
.B Repo
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL for the repository
.IP \(bu 2
\fBbasedir\fP (\fIstr\fP) \-\- Location relative to the workspace root
to checkout to (default \(aq.\(aq)
.IP \(bu 2
\fBcredentials\-id\fP \- optional ID of credentials to use
.IP \(bu 2
\fBrepo\-depth\fP \- Repository depth. Can be one of \(aqinfinity\(aq,
\(aqempty\(aq, \(aqfiles\(aq, \(aqimmediates\(aq or \(aqunknown\(aq. (default \(aqinfinity\(aq)
.IP \(bu 2
\fBignore\-externals\fP \- Ignore Externals. (default false)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Multiple repos example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- svn:
     workspaceupdater: update
     repos:
       \- url: http://svn.example.com/repo
         basedir: .
         credentials\-id: \(dqabcdef01234567890\(dq
         repo\-depth: files
         ignore\-externals: true
       \- url: http://svn.example.com/repo2
         basedir: repo2

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Advanced commit filtering example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- svn:
      url: http://svn.apache.org/repos/asf/spamassassin/trunk
      credentials\-id: \(dqabcdef01234567890\(dq
      repo\-depth: empty
      ignore\-externals: true
      workspaceupdater: wipeworkspace
      included\-regions:
          \- /region1/.*\e.cpp
          \- /region2
      excluded\-regions:
          \- /region3/.*\e.jpg
          \- /region4
      excluded\-users:
          \- user1
          \- user2
      excluded\-commit\-messages:
          \- test\-msg
          \- test\-msg2
      exclusion\-revprop\-name: propname
      filter\-changelog: true
      ignore\-property\-changes\-on\-directories: true
      viewvc\-url: http://svn.apache.org/viewvc/spamassassin/trunk

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B tfs()
Specifies the Team Foundation Server repository for this job.
.sp
Requires the Jenkins Team Foundation Server Plugin
(\fI\%https://github.com/jenkinsci/tfs\-plugin\fP).
.sp
\fBNOTE\fP: TFS Password must be entered manually on the project if a
user name is specified. The password will be overwritten with an empty
value every time the job is rebuilt with Jenkins Job Builder.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBserver\-url\fP (\fIstr\fP) \-\- The name or URL of the team foundation server.
If the server has been registered on the machine then it is only
necessary to enter the name.
.IP \(bu 2
\fBproject\-path\fP (\fIstr\fP) \-\- The name of the project as it is registered on the
server.
.IP \(bu 2
\fBlogin\fP (\fIstr\fP) \-\- The user name that is registered on the server. The user
name must contain the name and the domain name. Entered as
domain\e\euser or user@domain (optional).
\fBNOTE\fP: You must enter in at least two slashes for the
domain\e\euser format in JJB YAML. It will be rendered normally.
.IP \(bu 2
\fBuse\-update\fP (\fIstr\fP) \-\- If true, Hudson will not delete the workspace at end
of each build. This causes the artifacts from the previous build to
remain when a new build starts. (default true)
.IP \(bu 2
\fBlocal\-path\fP (\fIstr\fP) \-\- The folder where all files will be retrieved into.
The folder name is a relative path, under the workspace of the current
job. (default .)
.IP \(bu 2
\fBworkspace\fP (\fIstr\fP) \-\- 
.sp
The name of the workspace under which the source
should be retrieved. This workspace is created at the start of a
download, and deleted at the end. You can normally omit the property
unless you want to name a workspace to avoid conflicts on the server
(i.e. when you have multiple projects on one server talking to a
Team Foundation Server). (default Hudson\-${JOB_NAME}\-${NODE_NAME})
.sp
The TFS plugin supports the following macros that are replaced in the
workspace name:
.INDENT 2.0
.IP \(bu 2
${JOB_NAME} \- The name of the job.
.IP \(bu 2
.INDENT 2.0
.TP
.B ${USER_NAME} \- The user name that the Hudson server or slave is
running as.
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
.B ${NODE_NAME} \- The name of the node/slave that the plugin currently
is executed on. Note that this is not the hostname, this value is
the Hudson configured name of the slave/node.
.UNINDENT
.IP \(bu 2
${ENV} \- The environment variable that is set on the master or slave.
.UNINDENT

.IP \(bu 2
\fBweb\-access\fP (\fIdict\fP) \-\- 
.sp
Adds links in \(dqchanges\(dq views within Jenkins to an
external system for browsing the details of those changes. The \(dqAuto\(dq
selection attempts to infer the repository browser from other jobs,
if supported by the SCM and a job with matching SCM details can be
found. (optional, default Auto).
.INDENT 2.0
.TP
.B web\-access value
.INDENT 7.0
.IP \(bu 2
\fBweb\-url\fP \-\- Enter the URL to the TSWA server. The plugin will
strip the last path (if any) of the URL when building URLs for
change set pages and other pages. (optional, default
uses server\-url)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- tfs:
      server\-url: \(dqtfs.company.com\(dq
      project\-path: \(dq$/myproject\(dq
      login: \(dqmydomain\e\e\e\ejane\(dq
      use\-update: false
      local\-path: \(dq../foo/\(dq
      workspace: \(dqHudson\-${JOB_NAME}\(dq
      web\-access:
        \- web\-url: \(dqhttp://TFSMachine:8080\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- tfs:
      server\-url: \(dqtfs.company.com\(dq
      project\-path: \(dq$/myproject\(dq
      login: \(dqjane@mydomain\(dq
      use\-update: false
      local\-path: \(dq../foo/\(dq
      workspace: \(dqHudson\-${JOB_NAME}\(dq
      web\-access:

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B url()
Watch for changes in, and download an artifact from a particular url.
.sp
Requires the Jenkins \fI\%URL SCM\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\-list\fP (\fIlist\fP) \-\- List of URLs to watch. (required)
.IP \(bu 2
\fBclear\-workspace\fP (\fIbool\fP) \-\- If set to true, clear the workspace before
downloading the artifact(s) specified in url\-list. (default false)
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- url:
      url\-list:
        \- \(aqhttp://jenkins.domain.local/jnlpJars/jenkins\-cli.jar\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- url:
      url\-list:
        \- \(aqhttp://jenkins.domain.local/jnlpJars/jenkins\-cli.jar\(aq
        \- \(aqhttp://code.jquery.com/jquery\-1.11.3.min.js\(aq
      clear\-workspace: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B workspace()
Specifies the cloned workspace for this job to use as a SCM source.
.sp
Requires the Jenkins \fI\%Clone Workspace SCM Plugin\fP\&.
.sp
The job the workspace is cloned from must be configured with an
clone\-workspace publisher
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparent\-job\fP (\fIstr\fP) \-\- The name of the parent job to clone the
workspace from.
.IP \(bu 2
\fBcriteria\fP (\fIstr\fP) \-\- Set the criteria to determine what build of the parent
project to use. Can be one of \(aqAny\(aq, \(aqNot Failed\(aq or \(aqSuccessful\(aq.
(default Any)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
scm:
  \- workspace:
      parent\-job: my\-upstream\-job
      criteria: Any

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Triggers
.sp
Triggers define what causes a Jenkins job to start building.
.INDENT 0.0
.TP
\fBComponent\fP: triggers
.INDENT 7.0
.TP
.B Macro
trigger
.TP
.B Entry Point
jenkins_jobs.triggers
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
job:
  name: test_job

  triggers:
    \- timed: \(aq@daily\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  triggers.Triggers(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqtriggers\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqtrigger\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  50
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B artifactory()
Artifactory trigger. Trigger if files are added or modified in configured
path(s) to watch on chosen Artifactory server.
.sp
Requires the Jenkins \fI\%Artifactory Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBartifactory\-server\fP (\fIstr\fP) \-\- Artifactory server where the configured
path(s) are monitored from. Available Artifactory servers must be
configured on Jenkins Global Configuration in advance. (default \(aq\(aq)
.IP \(bu 2
\fBschedule\fP (\fIstr\fP) \-\- cron syntax of when to poll. (default \(aq\(aq)
.IP \(bu 2
\fBpaths\fP (\fIstr\fP) \-\- Paths in Artifactory to poll for changes. Multiple
paths can be configured by the \(aq;\(aq separator. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example with Single Path to Monitor:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- artifactory:
        artifactory\-server: my\-artifactory
        schedule: H/15 * * * *
        paths: myrepo/myfolder/latest

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example with Multiple Paths to Monitor:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- artifactory:
        artifactory\-server: my\-artifactory
        schedule: H 0,8,16 * * *
        paths: myrepo/myfolder/latest;myrepo/myfolder/commit

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B bitbucket()
Trigger a job when bitbucket repository is pushed to.
.sp
Requires the Jenkins \fI\%BitBucket Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- bitbucket

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B build\-result()
Configure jobB to monitor jobA build result. A build is scheduled if there
is a new build result that matches your criteria (unstable, failure, ...).
.sp
Requires the Jenkins \fI\%BuildResultTrigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBgroups\fP (\fIlist\fP) \-\- List groups of jobs and results to monitor for
.IP \(bu 2
\fBjobs\fP (\fIlist\fP) \-\- The jobs to monitor (required)
.IP \(bu 2
\fBresults\fP (\fIlist\fP) \-\- Build results to monitor for (default success)
.IP \(bu 2
\fBcombine\fP (\fIbool\fP) \-\- Combine all job information.  A build will be
scheduled only if all conditions are met (default false)
.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- The cron syntax with which to poll the jobs for the
supplied result (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- build\-result:
      cron: H/15 * * * *
      combine: true
      groups:
        \- jobs:
            \- test
            \- test2
          results:
            \- success
            \- not\-built
        \- jobs:
            \- test3
          results:
            \- unstable

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- build\-result:
       groups:
        \- jobs:
            \- test
          results:
            \- aborted

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B dockerhub\-notification()
The job will get triggered when Docker Hub/Registry notifies
that Docker image(s) used in this job has been rebuilt.
.sp
Requires the Jenkins \fI\%CloudBees Docker Hub Notification\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBreferenced\-image\fP (\fIbool\fP) \-\- Trigger the job based on repositories
used by any compatible docker plugin in this job. (default true)
.IP \(bu 2
\fBrepositories\fP (\fIlist\fP) \-\- Specified repositories to trigger the job.
(default [])
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- dockerhub\-notification

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- dockerhub\-notification:
      referenced\-image: true
      repositories:
        \- repo1
        \- repo2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B generic\-webhook\-trigger()
Generic webhook trigger. Trigger when a set of parameters are submitted.
.sp
Requires the Jenkins \fI\%Generic Webhook Trigger\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtoken\fP (\fIstr\fP) \-\- A token to use to trigger the job. (default \(aq\(aq)
.IP \(bu 2
\fBprint\-post\-content\fP (\fIbool\fP) \-\- Print post content in job log.
.IP \(bu 2
\fBprint\-contrib\-var\fP (\fIbool\fP) \-\- Print contributed variables in job log.
.IP \(bu 2
\fBsilent\-response\fP (\fIbool\fP) \-\- Avoid responding with information about
triggered jobs.
.IP \(bu 2
\fBcause\fP (\fIstr\fP) \-\- This will be displayed in any triggered job.
.IP \(bu 2
\fBregex\-filter\-expression\fP (\fIstr\fP) \-\- Regular expression to test on the
evaluated text specified in regex\-filter\-text
.IP \(bu 2
\fBregex\-filter\-text\fP (\fIstr\fP) \-\- Text to test for the given
regexp\-filter\-expression.
.IP \(bu 2
\fBpost\-content\-params\fP (\fIlist\fP) \-\- 
.sp
Parameters to use from posted JSON/XML
.INDENT 2.0
.TP
.B post\-content\-params
.INDENT 7.0
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- JSONPath or XPath
.IP \(bu 2
\fBkey\fP (\fIstr\fP) \-\- Variable name
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) \-\- Expression to evaluate in POST content.
Use JSONPath for JSON or XPath for XML.
.IP \(bu 2
\fBregex\-filter\fP (\fIstr\fP) \-\- Anything in the evaluated value,
matching this regular expression, will be removed. (optional)
.IP \(bu 2
\fBdefault\-value\fP (\fIstr\fP) \-\- This value will be used if
expression does not match anything. (optional)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBrequest\-params\fP (\fIlist\fP) \-\- 
.sp
Parameters to use passed in as request arguments
.INDENT 2.0
.TP
.B request\-params
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fIstr\fP) \-\- Name of request parameter
.IP \(bu 2
\fBregex\-filter\fP (\fIstr\fP) \-\- Anything in the evaluated value,
matching this regular expression, will be removed. (optional)
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBheader\-params\fP (\fIlist\fP) \-\- 
.sp
Parameters to use passed in as headers
.INDENT 2.0
.TP
.B header\-params
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fIstr\fP) \-\- Name of request header in
lowercase. Resulting variable name has \(aq_\(aq instead of \(aq\-\(aq
characters.
.IP \(bu 2
\fBregex\-filter\fP (\fIstr\fP) \-\- Anything in the evaluated value,
matching this regular expression, will be removed. (optional)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- generic\-webhook\-trigger:
        post\-content\-params:
            \- type: JSONPath
              key: action
              value: $.action
              regex\-filter: value_filter
              default\-value: default_value
            \- type: XPath
              key: blah
              value: whooga
              regex\-filter: value_filer
              default\-value: default_something
        regex\-filter\-text: $action
        regex\-filter\-expression: ^(opened|reopened|synchronize)$
        request\-params:
            \- key: request_test_1
              regex\-filter: requesT_value_1
        header\-params:
            \- key: header_test1
              regex\-filter: header_value1
        print\-post\-content: true
        print\-contrib\-var: true
        cause: Generic Cause
        token: blah
        silent\-response: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gerrit()
Trigger on a Gerrit event.
.sp
Requires the Jenkins \fI\%Gerrit Trigger Plugin\fP version >= 2.6.0.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtrigger\-on\fP (\fIlist\fP) \-\- 
.sp
Events to react on. Please use either the new
\fBtrigger\-on\fP, or the old \fBtrigger\-on\-*\fP events definitions. You
cannot use both at once.
.INDENT 2.0
.TP
.B Trigger on
.INDENT 7.0
.IP \(bu 2
\fBpatchset\-created\-event\fP (\fIdict\fP) \-\- Trigger upon patchset
creation.
.INDENT 2.0
.TP
.B Patchset created
.INDENT 7.0
.IP \(bu 2
\fBexclude\-drafts\fP (\fIbool\fP) \-\- exclude drafts (default false)
.IP \(bu 2
\fBexclude\-trivial\-rebase\fP (\fIbool\fP) \-\- exclude trivial rebase
(default false)
.IP \(bu 2
\fBexclude\-no\-code\-change\fP (\fIbool\fP) \-\- exclude no code change
(default false)
.IP \(bu 2
\fBexclude\-private\fP (\fIbool\fP) \-\- exclude private change
(default false)
.IP \(bu 2
\fBexclude\-wip\fP (\fIbool\fP) \-\- exclude wip change
(default false)
.IP \(bu 2
\fBcommit\-message\-contains\-regex\fP (\fIstr\fP) \-\- Commit message
contains regular expression. (default \(aq\(aq)
Requires Gerrit Trigger Plugin >= 2.32.0
.UNINDENT
.UNINDENT
.sp
exclude\-private|exclude\-wip needs
Gerrit Trigger v2.29.0
Exclude drafts|trivial\-rebase|no\-code\-change needs
Gerrit Trigger v2.12.0
.IP \(bu 2
\fBpatchset\-uploaded\-event\fP \-\- Trigger upon patchset creation
(this is a alias for \fIpatchset\-created\-event\fP).
.sp
Deprecated since version 1.1.0: Please use \fI\%trigger\-on\fP\&.

.IP \(bu 2
\fBchange\-abandoned\-event\fP \-\- Trigger on patchset abandoned.
Requires Gerrit Trigger Plugin version >= 2.8.0.
.IP \(bu 2
\fBchange\-merged\-event\fP \-\- Trigger on change merged
.IP \(bu 2
\fBchange\-restored\-event\fP \-\- Trigger on change restored. Requires
Gerrit Trigger Plugin version >= 2.8.0
.IP \(bu 2
\fBdraft\-published\-event\fP \-\- Trigger on draft published event.
.IP \(bu 2
\fBref\-updated\-event\fP \-\- Trigger on ref\-updated.
Gerrit Trigger Plugin version >= 2.29.0
.IP \(bu 2
\fBtopic\-changed\-event\fP \-\- Trigger on topic\-changed.
Gerrit Trigger Plugin version >= 2.26.0
.IP \(bu 2
\fBprivate\-state\-changed\-event\fP \-\- Trigger on private state changed event.
.IP \(bu 2
\fBwip\-state\-changed\-event\fP \-\- Trigger on wip state changed event.
Gerrit Trigger Plugin version >= 2.8.0
.IP \(bu 2
\fBcomment\-added\-event\fP (\fIdict\fP) \-\- Trigger on comment added.
.INDENT 2.0
.TP
.B Comment added
.INDENT 7.0
.IP \(bu 2
\fBapproval\-category\fP (\fIstr\fP) \-\- Approval (verdict) category
(for example \(aqAPRV\(aq, \(aqCRVW\(aq, \(aqVRIF\(aq \-\- see \fI\%Gerrit access
control\fP
.IP \(bu 2
\fBapproval\-value\fP \-\- Approval value for the comment added.
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBcomment\-added\-contains\-event\fP (\fIdict\fP) \-\- Trigger on comment
added contains Regular Expression.
.INDENT 2.0
.TP
.B Comment added contains
.INDENT 7.0
.IP \(bu 2
\fBcomment\-contains\-value\fP (\fIstr\fP) \-\- Comment contains
Regular Expression value.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtrigger\-on\-patchset\-uploaded\-event\fP (\fIbool\fP) \-\- 
.sp
Trigger on patchset upload.
.sp
Deprecated since version 1.1.0.: Please use \fI\%trigger\-on\fP\&.


.IP \(bu 2
\fBtrigger\-on\-change\-abandoned\-event\fP (\fIbool\fP) \-\- 
.sp
Trigger on change abandoned.
Requires Gerrit Trigger Plugin version >= 2.8.0
.sp
Deprecated since version 1.1.0.: Please use \fI\%trigger\-on\fP\&.


.IP \(bu 2
\fBtrigger\-on\-change\-merged\-event\fP (\fIbool\fP) \-\- 
.sp
Trigger on change merged
.sp
Deprecated since version 1.1.0.: Please use \fI\%trigger\-on\fP\&.


.IP \(bu 2
\fBtrigger\-on\-change\-restored\-event\fP (\fIbool\fP) \-\- 
.sp
Trigger on change restored.
Requires Gerrit Trigger Plugin version >= 2.8.0
.sp
Deprecated since version 1.1.0.: Please use \fI\%trigger\-on\fP\&.


.IP \(bu 2
\fBtrigger\-on\-comment\-added\-event\fP (\fIbool\fP) \-\- 
.sp
Trigger on comment added
.sp
Deprecated since version 1.1.0.: Please use \fI\%trigger\-on\fP\&.


.IP \(bu 2
\fBtrigger\-on\-draft\-published\-event\fP (\fIbool\fP) \-\- 
.sp
Trigger on draft published
event
.sp
Deprecated since version 1.1.0: Please use \fI\%trigger\-on\fP\&.


.IP \(bu 2
\fBtrigger\-on\-ref\-updated\-event\fP (\fIbool\fP) \-\- 
.sp
Trigger on ref\-updated
.sp
Deprecated since version 1.1.0.: Please use \fI\%trigger\-on\fP\&.


.IP \(bu 2
\fBtrigger\-approval\-category\fP (\fIstr\fP) \-\- 
.sp
Approval category for comment added
.sp
Deprecated since version 1.1.0.: Please use \fI\%trigger\-on\fP\&.


.IP \(bu 2
\fBtrigger\-approval\-value\fP (\fIint\fP) \-\- 
.sp
Approval value for comment added
.sp
Deprecated since version 1.1.0.: Please use \fI\%trigger\-on\fP\&.


.IP \(bu 2
\fBoverride\-votes\fP (\fIbool\fP) \-\- Override default vote values
.IP \(bu 2
\fBgerrit\-build\-started\-verified\-value\fP (\fIint\fP) \-\- Started \(aq\(aqVerified\(aq\(aq value
.IP \(bu 2
\fBgerrit\-build\-successful\-verified\-value\fP (\fIint\fP) \-\- Successful \(aq\(aqVerified\(aq\(aq
value
.IP \(bu 2
\fBgerrit\-build\-failed\-verified\-value\fP (\fIint\fP) \-\- Failed \(aq\(aqVerified\(aq\(aq value
.IP \(bu 2
\fBgerrit\-build\-unstable\-verified\-value\fP (\fIint\fP) \-\- Unstable \(aq\(aqVerified\(aq\(aq value
.IP \(bu 2
\fBgerrit\-build\-notbuilt\-verified\-value\fP (\fIint\fP) \-\- Not built \(aq\(aqVerified\(aq\(aq
value
.IP \(bu 2
\fBgerrit\-build\-aborted\-verified\-value\fP (\fIint\fP) \-\- Aborted \(aq\(aqVerified\(aq\(aq value
Requires Gerrit Trigger Plugin version >= 2.31.0
.IP \(bu 2
\fBgerrit\-build\-started\-codereview\-value\fP (\fIint\fP) \-\- Started \(aq\(aqCodeReview\(aq\(aq
value
.IP \(bu 2
\fBgerrit\-build\-successful\-codereview\-value\fP (\fIint\fP) \-\- Successful
\(aq\(aqCodeReview\(aq\(aq value
.IP \(bu 2
\fBgerrit\-build\-failed\-codereview\-value\fP (\fIint\fP) \-\- Failed \(aq\(aqCodeReview\(aq\(aq value
.IP \(bu 2
\fBgerrit\-build\-unstable\-codereview\-value\fP (\fIint\fP) \-\- Unstable \(aq\(aqCodeReview\(aq\(aq
value
.IP \(bu 2
\fBgerrit\-build\-notbuilt\-codereview\-value\fP (\fIint\fP) \-\- Not built \(aq\(aqCodeReview\(aq\(aq
value
.IP \(bu 2
\fBgerrit\-build\-aborted\-codereview\-value\fP (\fIint\fP) \-\- Aborted \(aq\(aqCodeReview\(aq\(aq
value
Requires Gerrit Trigger Plugin version >= 2.31.0
.IP \(bu 2
\fBfailure\-message\fP (\fIstr\fP) \-\- Message to leave on failure (default \(aq\(aq)
.IP \(bu 2
\fBsuccessful\-message\fP (\fIstr\fP) \-\- Message to leave on success (default \(aq\(aq)
.IP \(bu 2
\fBunstable\-message\fP (\fIstr\fP) \-\- Message to leave when unstable (default \(aq\(aq)
.IP \(bu 2
\fBnotbuilt\-message\fP (\fIstr\fP) \-\- Message to leave when not built (default \(aq\(aq)
.IP \(bu 2
\fBaborted\-message\fP (\fIstr\fP) \-\- Message to leave when aborted (default \(aq\(aq)
.IP \(bu 2
\fBfailure\-message\-file\fP (\fIstr\fP) \-\- Sets the filename within the workspace from
which to retrieve the unsuccessful review message. (optional)
.IP \(bu 2
\fBprojects\fP (\fIlist\fP) \-\- 
.sp
list of projects to match
.INDENT 2.0
.TP
.B Project
.INDENT 7.0
.IP \(bu 2
\fBproject\-compare\-type\fP (\fIstr\fP) \-\-  \(aq\(aqPLAIN\(aq\(aq, \(aq\(aqANT\(aq\(aq or
\(aq\(aqREG_EXP\(aq\(aq
.IP \(bu 2
\fBproject\-pattern\fP (\fIstr\fP) \-\- Project name pattern to match
.IP \(bu 2
\fBbranch\-compare\-type\fP (\fIstr\fP) \-\- \(aq\(aqPLAIN\(aq\(aq, \(aq\(aqANT\(aq\(aq or
\(aq\(aqREG_EXP\(aq\(aq (not used if \fIbranches\fP list is specified)
.sp
Deprecated since version 1.1.0: Please use \fI\%branches\fP\&.

.IP \(bu 2
\fBbranch\-pattern\fP (\fIstr\fP) \-\- Branch name pattern to match
(not used if \fIbranches\fP list is specified)
.sp
Deprecated since version 1.1.0: Please use \fI\%branches\fP\&.

.UNINDENT
.INDENT 7.0
.IP \(bu 2
\fBbranches\fP (\fIlist\fP) \-\- List of branches to match
(optional)
.INDENT 2.0
.TP
.B Branch
.INDENT 7.0
.IP \(bu 2
\fBbranch\-compare\-type\fP (\fIstr\fP) \-\- \(aq\(aqPLAIN\(aq\(aq,
\(aq\(aqANT\(aq\(aq or \(aq\(aqREG_EXP\(aq\(aq (optional) (default
\(aq\(aqPLAIN\(aq\(aq)
.IP \(bu 2
\fBbranch\-pattern\fP (\fIstr\fP) \-\- Branch name pattern
to match
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBfile\-paths\fP (\fIlist\fP) \-\- List of file paths to match
(optional)
.INDENT 2.0
.TP
.B File Path
.INDENT 7.0
.IP \(bu 2
\fBcompare\-type\fP (\fIstr\fP) \-\- \(aq\(aqPLAIN\(aq\(aq, \(aq\(aqANT\(aq\(aq
or \(aq\(aqREG_EXP\(aq\(aq (optional) (default \(aq\(aqPLAIN\(aq\(aq)
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- File path pattern to
match
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBforbidden\-file\-paths\fP (\fIlist\fP) \-\- List of file paths to
skip triggering (optional)
.INDENT 2.0
.TP
.B Forbidden File Path
.INDENT 7.0
.IP \(bu 2
\fBcompare\-type\fP (\fIstr\fP) \-\-
\(aq\(aqPLAIN\(aq\(aq, \(aq\(aqANT\(aq\(aq or \(aq\(aqREG_EXP\(aq\(aq (optional)
(default \(aq\(aqPLAIN\(aq\(aq)
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- File path pattern to
match
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBtopics\fP (\fIlist\fP) \-\- List of topics to match
(optional)
.INDENT 2.0
.TP
.B Topic
.INDENT 7.0
.IP \(bu 2
\fBcompare\-type\fP (\fIstr\fP) \-\- \(aq\(aqPLAIN\(aq\(aq, \(aq\(aqANT\(aq\(aq or
\(aq\(aqREG_EXP\(aq\(aq (optional) (default \(aq\(aqPLAIN\(aq\(aq)
.IP \(bu 2
\fBpattern\fP (\fIstr\fP) \-\- Topic name pattern to
match
.UNINDENT
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBdisable\-strict\-forbidden\-file\-verification\fP (\fIbool\fP) \-\-
Enabling this option will allow an event to trigger a
build if the event contains BOTH one or more wanted file
paths AND one or more forbidden file paths.  In other
words, with this option, the build will not get
triggered if the change contains only forbidden files,
otherwise it will get triggered. Requires plugin
version >= 2.16.0 (default false)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBskip\-vote\fP (\fIdict\fP) \-\- 
.sp
map of build outcomes for which Jenkins must skip
vote. Requires Gerrit Trigger Plugin version >= 2.7.0
.INDENT 2.0
.TP
.B Outcome
.INDENT 7.0
.IP \(bu 2
\fBsuccessful\fP (\fIbool\fP)
.IP \(bu 2
\fBfailed\fP (\fIbool\fP)
.IP \(bu 2
\fBunstable\fP (\fIbool\fP)
.IP \(bu 2
\fBnotbuilt\fP (\fIbool\fP)
.IP \(bu 2
\fBaborted\fP (\fIbool\fP) \-\- Requires Gerrit Trigger Plugin version >= 2.31.0
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBsilent\fP (\fIbool\fP) \-\- When silent mode is on there will be no communication
back to Gerrit, i.e. no build started/failed/successful approve
messages etc. If other non\-silent jobs are triggered by the same
Gerrit event as this job, the result of this job\(aqs build will not be
counted in the end result of the other jobs. (default false)
.IP \(bu 2
\fBsilent\-start\fP (\fIbool\fP) \-\- Sets silent start mode to on or off. When silent
start mode is on there will be no \(aqbuild started\(aq messages sent back
to Gerrit. (default false)
.IP \(bu 2
\fBescape\-quotes\fP (\fIbool\fP) \-\- escape quotes in the values of Gerrit change
parameters (default true)
.IP \(bu 2
\fBbuild\-cancellation\-policy\fP (\fIdict\fP) \-\- 
.sp
If used, rules regarding
cancellation of builds can be set with this option when
patchsets of the same change comes in. This setting overrides global
server configuration. If build\-cancellation\-policy is not present in
YAML the global server configuration is used.
Requires Gerrit Trigger Plugin version >= 2.32.0
.INDENT 2.0
.TP
.B Options
.INDENT 7.0
.IP \(bu 2
\fBabort\-new\-patchsets\fP (\fIbool\fP) \-\- Only running jobs
will be cancelled if a new patch version is pushed over
(default false).
.IP \(bu 2
\fBabort\-manual\-patchsets\fP (\fIbool\fP) \-\- Builds triggered
manually will be aborted when a new patch set arrives
(default false).
.IP \(bu 2
\fBabort\-same\-topic\fP (\fIbool\fP) \-\- Builds triggered with
topic will be aborted when a new patch set with the
same topic arrives (default false).
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBno\-name\-and\-email\fP (\fIbool\fP) \-\- 
.sp
Do not pass compound \(aqname and email\(aq
parameters (default false)
.sp
Deprecated since version 3.5.0: Please use \fIname\-and\-email\-parameter\-mode\fP
parameter.


.IP \(bu 2
\fBreadable\-message\fP (\fIbool\fP) \-\- 
.sp
If parameters regarding multiline text,
e.g. commit message, should be as human readable or not. If false,
those parameters are Base64 encoded to keep environment variables
clean. (default false)
.sp
Deprecated since version 3.5.0: Please use \fIcommit\-message\-parameter\-mode\fP
parameter.


.IP \(bu 2
\fBname\-and\-email\-parameter\-mode\fP (\fIstr\fP) \-\- The parameter mode for the compound
\(dqname and email\(dq parameters (like GERRIT_PATCHSET_UPLOADER or
GERRIT_CHANGE_OWNER). This can either be \(aqNONE\(aq to avoid passing the
parameter all together, \(aqPLAIN\(aq to pass the parameter in human readable
form, or \(aqBASE64\(aq to pass the parameter in base64 encoded form (default
\(aqPLAIN\(aq). Requires Gerrit Trigger Plugin version >= 2.18.0.
.IP \(bu 2
\fBcommit\-message\-parameter\-mode\fP (\fIstr\fP) \-\- The parameter mode for the
GERRIT_CHANGE_COMMIT_MESSAGE parameter. This can either be \(aqNONE\(aq to
avoid passing the parameter all together, \(aqPLAIN\(aq to pass the parameter
in human readable form, or \(aqBASE64\(aq to pass the parameter in base64
encoded form (default \(aqBASE64\(aq). Requires Gerrit Trigger Plugin version
>= 2.18.0.
.IP \(bu 2
\fBchange\-subject\-parameter\-mode\fP (\fIstr\fP) \-\- The parameter mode for the
GERRIT_CHANGE_SUBJECT parameter. This can either be \(aqNONE\(aq to avoid
passing the parameter all together, \(aqPLAIN\(aq to pass the parameter in
human readable form, or \(aqBASE64\(aq to pass the parameter in base64
encoded form (default \(aqPLAIN\(aq). Requires Gerrit Trigger Plugin version
>= 2.18.0.
.IP \(bu 2
\fBcomment\-text\-parameter\-mode\fP (\fIstr\fP) \-\- The parameter mode for the
GERRIT_EVENT_COMMENT_TEXT parameter. This can either be \(aqNONE\(aq to avoid
passing the parameter all together, \(aqPLAIN\(aq to pass the parameter in
human readable form, or \(aqBASE64\(aq to pass the parameter in base64
encoded form (default \(aqBASE64\(aq). Requires Gerrit Trigger Plugin version
>= 2.18.0.
.IP \(bu 2
\fBdependency\-jobs\fP (\fIstr\fP) \-\- All jobs on which this job depends. If a commit
should trigger both a dependency and this job, the dependency will be
built first. Use commas to separate job names. Beware of cyclic
dependencies. (optional)
.IP \(bu 2
\fBnotification\-level\fP (\fIstr\fP) \-\- Defines to whom email notifications should be
sent. This can either be nobody (\(aqNONE\(aq), the change owner (\(aqOWNER\(aq),
reviewers and change owner (\(aqOWNER_REVIEWERS\(aq), all interested users
i.e. owning, reviewing, watching, and starring (\(aqALL\(aq) or server
default (\(aqSERVER_DEFAULT\(aq). (default \(aqSERVER_DEFAULT\(aq)
.IP \(bu 2
\fBdynamic\-trigger\-enabled\fP (\fIbool\fP) \-\- Enable/disable the dynamic trigger
(default false)
.IP \(bu 2
\fBdynamic\-trigger\-url\fP (\fIstr\fP) \-\- if you specify this option, the Gerrit
trigger configuration will be fetched from there on a regular interval
.IP \(bu 2
\fBtrigger\-for\-unreviewed\-patches\fP (\fIbool\fP) \-\- 
.sp
trigger patchset\-created events
for changes that were uploaded while connection to Gerrit was down
(default false). Requires Gerrit Trigger Plugin version >= 2.11.0.
.sp
Deprecated since version 3.5.0: Supported for Gerrit Trigger Plugin versions
< 2.14.0. See
\fI\%Missed Events Playback Feature\fP\&.


.IP \(bu 2
\fBcustom\-url\fP (\fIstr\fP) \-\- Custom URL for a message sent to Gerrit. Build
details URL will be used if empty. (default \(aq\(aq)
.IP \(bu 2
\fBserver\-name\fP (\fIstr\fP) \-\- Name of the server to trigger on, or \(aq\(aq__ANY__\(aq\(aq to
trigger on any configured Gerrit server (default \(aq__ANY__\(aq). Requires
Gerrit Trigger Plugin version >= 2.11.0
.UNINDENT
.UNINDENT
.sp
You may select one or more Gerrit events upon which to trigger.
You must also supply at least one project and branch, optionally
more.  If you select the comment\-added trigger, you should also
indicate which approval category and value you want to trigger the
job.
.sp
Until version 0.4.0 of Jenkins Job Builder, camelCase keys were used to
configure Gerrit Trigger Plugin, instead of hyphenated\-keys.  While still
supported, camedCase keys are deprecated and should not be used. Support
for this will be removed after 1.0.0 is released.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- gerrit:
      trigger\-on:
        \- patchset\-created\-event:
            exclude\-drafts: true
            exclude\-trivial\-rebase: true
            exclude\-no\-code\-change: true
            exclude\-private: true
            exclude\-wip: true
            commit\-message\-contains\-regex: \(dqregex\(dq
        \- comment\-added\-event:
            approval\-category: \(aqAPRV\(aq
            approval\-value: 1
      projects:
        \- project\-compare\-type: \(aqPLAIN\(aq
          project\-pattern: \(aqtest\-project\(aq
          branches:
            \- branch\-compare\-type: \(aqPLAIN\(aq
              branch\-pattern: \(aqmaster\(aq
            \- branch\-compare\-type: \(aqPLAIN\(aq
              branch\-pattern: \(aqstable\(aq
          file\-paths:
              \- compare\-type: ANT
                pattern: subdirectory/**
          topics:
              \- compare\-type: ANT
                pattern: refactor\-xy**
      skip\-vote:
          successful: true
          failed: true
          unstable: true
          notbuilt: true
          aborted: true
      build\-cancellation\-policy:
        abort\-new\-patchsets: false
        abort\-manual\-patchsets: true
        abort\-same\-topic: true
      silent: false
      silent\-start: true
      escape\-quotes: false
      dependency\-jobs: \(aqjob1, job2\(aq
      name\-and\-email\-parameter\-mode: PLAIN
      notification\-level: ALL
      dynamic\-trigger\-enabled: true
      dynamic\-trigger\-url: http://myhost/mytrigger
      server\-name: my\-server
      failure\-message\-file: path/to/filename

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B github()
Trigger a job when github repository is pushed to.
.sp
Requires the Jenkins \fI\%GitHub Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- github
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B github\-pull\-request()
Build pull requests in github and report results.
.sp
Requires the Jenkins \fI\%GitHub Pull Request Builder Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBadmin\-list\fP (\fIlist\fP) \-\- the users with admin rights (optional)
.IP \(bu 2
\fBwhite\-list\fP (\fIlist\fP) \-\- users whose pull requests build (optional)
.IP \(bu 2
\fBorg\-list\fP (\fIlist\fP) \-\- orgs whose users should be white listed (optional)
.IP \(bu 2
\fBallow\-whitelist\-orgs\-as\-admins\fP (\fIbool\fP) \-\- members of white listed orgs
will have admin rights. (default false)
.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- cron syntax of when to run (optional)
.IP \(bu 2
\fBtrigger\-phrase\fP (\fIstr\fP) \-\- when filled, commenting this phrase
in the pull request will trigger a build (optional)
.IP \(bu 2
\fBonly\-trigger\-phrase\fP (\fIbool\fP) \-\- only commenting the trigger phrase
in the pull request will trigger a build (default false)
.IP \(bu 2
\fBskip\-build\-phrase\fP (\fIstr\fP) \-\- when filled, adding this phrase to
the pull request title or body will not trigger a build (optional)
.IP \(bu 2
\fBblack\-list\-commit\-author\fP (\fIlist\fP) \-\- When filled, pull request commits from this user(s)
will not trigger a build (optional)
.IP \(bu 2
\fBblack\-list\-labels\fP (\fIstr\fP) \-\- list of GitHub labels for which the build
should not be triggered (optional)
.IP \(bu 2
\fBwhite\-list\-labels\fP (\fIstr\fP) \-\- list of GitHub labels for which the build
should only be triggered. (Leave blank for \(aqany\(aq) (optional)
.IP \(bu 2
\fBgithub\-hooks\fP (\fIbool\fP) \-\- use github hook (default false)
.IP \(bu 2
\fBpermit\-all\fP (\fIbool\fP) \-\- build every pull request automatically
without asking (default false)
.IP \(bu 2
\fBauto\-close\-on\-fail\fP (\fIbool\fP) \-\- close failed pull request automatically
(default false)
.IP \(bu 2
\fBdisplay\-build\-errors\-on\-downstream\-builds\fP (\fIbool\fP) \-\- Display build errors on downstream builds
(default false)
.IP \(bu 2
\fBwhite\-list\-target\-branches\fP (\fIlist\fP) \-\- Adding branches to this whitelist
allows you to selectively test pull requests destined for these
branches only. Supports regular expressions (e.g. \(aqmaster\(aq,
\(aqfeature\-.*\(aq). (optional)
.IP \(bu 2
\fBblack\-list\-target\-branches\fP (\fIlist\fP) \-\- Adding branches to this blacklist
allows you to selectively prevent pull requests builds destined for
these branches. Supports regular expressions (e.g. \(aqmaster\(aq,
\(aqfeature\-.*\(aq). (optional)
.IP \(bu 2
\fBauth\-id\fP (\fIstr\fP) \-\- the auth id to use (optional)
.IP \(bu 2
\fBbuild\-desc\-template\fP (\fIstr\fP) \-\- the template for build descriptions in
jenkins (optional)
.IP \(bu 2
\fBstatus\-context\fP (\fIstr\fP) \-\- the context to include on PR status comments
(optional)
.IP \(bu 2
\fBtriggered\-status\fP (\fIstr\fP) \-\- the status message to set when the build has
been triggered (optional)
.IP \(bu 2
\fBstarted\-status\fP (\fIstr\fP) \-\- the status comment to set when the build has
been started (optional)
.IP \(bu 2
\fBstatus\-url\fP (\fIstr\fP) \-\- the status URL to set (optional)
.IP \(bu 2
\fBstatus\-add\-test\-results\fP (\fIbool\fP) \-\- add test result one\-liner to status
message (optional)
.IP \(bu 2
\fBsuccess\-status\fP (\fIstr\fP) \-\- the status message to set if the job succeeds
(optional)
.IP \(bu 2
\fBfailure\-status\fP (\fIstr\fP) \-\- the status message to set if the job fails
(optional)
.IP \(bu 2
\fBerror\-status\fP (\fIstr\fP) \-\- the status message to set if the job errors
(optional)
.IP \(bu 2
\fBsuccess\-comment\fP (\fIstr\fP) \-\- comment to add to the PR on a successful job
(optional)
.IP \(bu 2
\fBfailure\-comment\fP (\fIstr\fP) \-\- comment to add to the PR on a failed job
(optional)
.IP \(bu 2
\fBerror\-comment\fP (\fIstr\fP) \-\- comment to add to the PR on an errored job
(optional)
.IP \(bu 2
\fBcancel\-builds\-on\-update\fP (\fIbool\fP) \-\- cancel existing builds when a PR is
updated (optional)
.IP \(bu 2
\fBcomment\-file\fP (\fIstr\fP) \-\- Extends the standard build comment message on
github with a custom message file. (optional)
.IP \(bu 2
\fBno\-commit\-status\fP (\fIbool\fP) \-\- Enables \(dqDo not update commit status\(dq
.IP \(bu 2
\fBincluded\-regions\fP (\fIlist\fP) \-\- Each inclusion uses regular expression pattern
matching, and must be separated by a new line. An empty list implies
that everything is included. (optional)
.IP \(bu 2
\fBexcluded\-regions\fP (\fIlist\fP) \-\- Each exclusion uses regular expression pattern
matching, and must be separated by a new line. Exclusions take
precedence over inclusions, if there is an overlap between included
and excluded regions. (optional)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- github\-pull\-request:
      admin\-list:
        \- user1
        \- user2
      white\-list:
        \- user3
        \- user4
      org\-list:
        \- org1
        \- org2
      white\-list\-labels:
        \- label1
        \- label2
      black\-list\-labels:
        \- label3
        \- label4
      cron: \(aq* * * * *\(aq
      build\-desc\-template: \(dqbuild description\(dq
      trigger\-phrase: \(aqretest this please\(aq
      skip\-build\-phrase: \(aqno tests\(aq
      black\-list\-commit\-author:
        \- blacklist
        \- commit
        \- author
      only\-trigger\-phrase: true
      github\-hooks: true
      permit\-all: true
      auto\-close\-on\-fail: false
      display\-build\-errors\-on\-downstream\-builds: true
      allow\-whitelist\-orgs\-as\-admins: true
      white\-list\-target\-branches:
        \- master
        \- testing
      black\-list\-target\-branches:
        \- master
        \- testing
      auth\-id: \(aq123\-456\-789\(aq
      status\-context: \(dqstatus context\(dq
      triggered\-status: \(dqtriggered status message\(dq
      started\-status: \(dqstarted\(dq
      status\-url: \(dqurl/to/status\(dq
      status\-add\-test\-results: false
      success\-status: \(dqsuccess message\(dq
      failure\-status: \(dqfailure message\(dq
      error\-status: \(dqerror message\(dq
      success\-comment: \(dqsuccess comment\(dq
      failure\-comment: \(dqfailure comment\(dq
      error\-comment: \(dqerror\-comment\(dq
      cancel\-builds\-on\-update: true
      comment\-file: \(dq/tmp/path\(dq
      no\-commit\-status: true
      included\-regions:
          \- include
          \- region
      excluded\-regions:
          \- exclude
          \- region

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- github\-pull\-request

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gitlab()
Makes Jenkins act like a GitLab CI server.
.sp
Requires the Jenkins \fI\%GitLab Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtrigger\-push\fP (\fIbool\fP) \-\- Build on Push Events (default true)
.IP \(bu 2
\fBtrigger\-merge\-request\fP (\fIbool\fP) \-\- Build on Merge Request Events (default
true)
.IP \(bu 2
\fBtrigger\-accepted\-merge\-request\fP (\fIbool\fP) \-\- Build on Accepted Merge Request
Events (>= 1.4.6) (default false)
.IP \(bu 2
\fBtrigger\-closed\-merge\-request\fP (\fIbool\fP) \-\- Build on Closed Merge Request
Events (>= 1.4.6) (default false)
.IP \(bu 2
\fBtrigger\-open\-merge\-request\-push\fP (\fIstr\fP) \-\- 
.sp
Rebuild open Merge Requests
on Push Events.
.INDENT 2.0
.TP
.B trigger\-open\-merge\-request\-push values (< 1.1.26)
.INDENT 7.0
.IP \(bu 2
\fBtrue\fP (default)
.IP \(bu 2
\fBfalse\fP
.UNINDENT
.TP
.B trigger\-open\-merge\-request\-push values (>= 1.1.26)
.INDENT 7.0
.IP \(bu 2
\fBnever\fP (default)
.IP \(bu 2
\fBsource\fP
.IP \(bu 2
\fBboth\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBtrigger\-note\fP (\fIbool\fP) \-\- Build when comment is added with defined phrase
(>= 1.2.4) (default true)
.IP \(bu 2
\fBnote\-regex\fP (\fIstr\fP) \-\- Phrase that triggers the build (>= 1.2.4) (default
\(aqJenkins please retry a build\(aq)
.IP \(bu 2
\fBci\-skip\fP (\fIbool\fP) \-\- Enable skipping builds of commits that contain
[ci\-skip] in the commit message (default true)
.IP \(bu 2
\fBwip\-skip\fP (\fIbool\fP) \-\- Enable skipping builds of WIP Merge Requests (>= 1.2.4)
(default true)
.IP \(bu 2
\fBset\-build\-description\fP (\fIbool\fP) \-\- Set build description to build cause
(eg. Merge request or Git Push) (default true)
.IP \(bu 2
\fBcancel\-pending\-builds\-on\-update\fP (\fIbool\fP) \-\- Cancel pending merge request
builds on update (default false)
.IP \(bu 2
\fBpending\-build\-name\fP (\fIstr\fP) \-\- Set the pending merge request build name (optional)
.IP \(bu 2
\fBadd\-note\-merge\-request\fP (\fIbool\fP) \-\- Add note with build status on
merge requests (default true)
.IP \(bu 2
\fBadd\-vote\-merge\-request\fP (\fIbool\fP) \-\- Vote added to note with build status
on merge requests (>= 1.1.27) (default true)
.IP \(bu 2
\fBaccept\-merge\-request\-on\-success\fP (\fIbool\fP) \-\- Automatically accept the Merge
Request if the build is successful (>= 1.1.27) (default false)
.IP \(bu 2
\fBadd\-ci\-message\fP (\fIbool\fP) \-\- Add CI build status (1.1.28 \- 1.2.0) (default
false)
.IP \(bu 2
\fBallow\-all\-branches\fP (\fIbool\fP) \-\- Allow all branches (Ignoring Filtered
Branches) (< 1.1.29) (default false)
.IP \(bu 2
\fBbranch\-filter\-type\fP (\fIstr\fP) \-\- Filter branches that can trigger a build.
Valid values and their additional attributes are described in the
\fI\%branch filter type\fP table (>= 1.1.29) (default \(aqAll\(aq).
.IP \(bu 2
\fBinclude\-branches\fP (\fIlist\fP) \-\- Defined list of branches to include
(default [])
.IP \(bu 2
\fBexclude\-branches\fP (\fIlist\fP) \-\- Defined list of branches to exclude
(default [])
.IP \(bu 2
\fBtarget\-branch\-regex\fP (\fIstr\fP) \-\- Regular expression to select branches
.IP \(bu 2
\fBsecret\-token\fP (\fIstr\fP) \-\- Secret token for build trigger
.UNINDENT
.UNINDENT
.TS
center;
|l|l|.
_
T{
Branch filter type
T}	T{
Description
T}
_
T{
All
T}	T{
All branches are allowed to trigger this job.
T}
_
T{
NameBasedFilter
T}	T{
Filter branches by name.
List source branches that are allowed to trigger a
build from a Push event or a Merge Request event. If
both fields are left empty, all branches are allowed
to trigger this job. For Merge Request events only
the target branch name is filtered out by the
\fBinclude\-branches\fP and \fBexclude\-branches\fP lists.
T}
_
T{
RegexBasedFilter
T}	T{
Filter branches by regex
The target branch regex allows you to limit the
execution of this job to certain branches. Any
branch matching the specified pattern in
\fBtarget\-branch\-regex\fP triggers the job. No
filtering is performed if the field is left empty.
T}
_
.TE
.sp
Example (version < 1.1.26):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- gitlab:
      trigger\-push: true
      trigger\-merge\-request: true
      trigger\-open\-merge\-request\-push: true
      ci\-skip: true
      set\-build\-description: true
      add\-note\-merge\-request: true
      add\-vote\-merge\-request: true
      add\-ci\-message: true
      allow\-all\-branches: true
      include\-branches:
        \- \(aqmaster\(aq
        \- \(aqmaster2\(aq
        \- \(aqlocal\-test\(aq
      exclude\-branches:
        \- \(aqbroken\-test\(aq
        \- \(aqmaster\-foo\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal example (version >= 1.1.26):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- gitlab

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full example (version >= 1.1.26):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- gitlab:
      trigger\-push: false
      trigger\-merge\-request: false
      trigger\-open\-merge\-request\-push: both
      ci\-skip: false
      set\-build\-description: false
      add\-note\-merge\-request: false
      add\-vote\-merge\-request: false
      add\-ci\-message: true
      allow\-all\-branches: true
      include\-branches:
        \- \(aqmaster\(aq
        \- \(aqmaster2\(aq
        \- \(aqlocal\-test\(aq
      exclude\-branches:
        \- \(aqbroken\-test\(aq
        \- \(aqmaster\-foo\(aq
      pending\-build\-name: \(aqtest\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gitlab\-merge\-request()
Build merge requests in gitlab and report results.
.sp
Requires the Jenkins \fI\%Gitlab MergeRequest Builder Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- Cron syntax of when to run (required)
.IP \(bu 2
\fBproject\-path\fP (\fIstr\fP) \-\- Gitlab\-relative path to project (required)
.IP \(bu 2
\fBtarget\-branch\-regex\fP (\fIstr\fP) \-\- Allow execution of this job for certain
branches only (default \(aq\(aq). Requires Gitlab MergeRequest Builder
Plugin >= 2.0.0
.IP \(bu 2
\fBuse\-http\-url\fP (\fIstr\fP) \-\- Use the HTTP(S) URL to fetch/clone repository
(default false)
.IP \(bu 2
\fBassignee\-filter\fP (\fIstr\fP) \-\- Only MRs with this assigned user will
trigger the build automatically (default \(aqjenkins\(aq)
.IP \(bu 2
\fBtag\-filter\fP (\fIstr\fP) \-\- Only MRs with this label will trigger the build
automatically (default \(aqBuild\(aq)
.IP \(bu 2
\fBtrigger\-comment\fP (\fIstr\fP) \-\- Force build if this comment is the last
in merge reguest (default \(aq\(aq)
.IP \(bu 2
\fBpublish\-build\-progress\-messages\fP (\fIstr\fP) \-\- 
.sp
Publish build progress
messages (except build failed) (default true)
.sp
Deprecated since version 2.0.0.


.IP \(bu 2
\fBauto\-close\-failed\fP (\fIstr\fP) \-\- On failure, auto close the request
(default false)
.IP \(bu 2
\fBauto\-merge\-passed\fP (\fIstr\fP) \-\- On success, auto merge the request
(default false)
.UNINDENT
.UNINDENT
.sp
Example (version < 2.0.0):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- gitlab\-merge\-request:
      cron: \(aq* * * * *\(aq
      project\-path: \(aqtest/project\(aq
      use\-http\-url: false
      assignee\-filter: \(aqjenkinsbot\(aq
      tag\-filter: \(aqfix\(aq
      trigger\-comment: \(aqrebuild\(aq
      publish\-build\-progress\-messages: true
      auto\-close\-failed: false
      auto\-merge\-passed: false

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example (version >= 2.0.0):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- gitlab\-merge\-request:
      cron: \(aq* * * * *\(aq
      project\-path: \(aqtest/project\(aq
      target\-branch\-regex: \(aq(.*release.*|.*hotfix.*)\(aq
      use\-http\-url: false
      assignee\-filter: \(aqjenkinsbot\(aq
      tag\-filter: \(aqfix\(aq
      trigger\-comment: \(aqrebuild\(aq
      auto\-close\-failed: false
      auto\-merge\-passed: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B gogs()
Trigger a job when gogs repository is pushed to.
.sp
Requires the Jenkins \fI\%Gogs Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- gogs

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B groovy\-script()
Triggers the job using a groovy script.
.sp
Requires the Jenkins \fI\%ScriptTrigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsystem\-script\fP (\fIbool\fP) \-\- If true, run the groovy script as a system script,
the script will have access to the same variables as the Groovy Console.
If false, run the groovy script on the executor node, the script will not
have access to the hudson or job model. (default false)
.IP \(bu 2
\fBscript\fP (\fIstr\fP) \-\- Content of the groovy script. If the script result is
evaluated to true, a build is scheduled. (default \(aq\(aq)
.IP \(bu 2
\fBscript\-file\-path\fP (\fIstr\fP) \-\- Groovy script path. (default \(aq\(aq)
.IP \(bu 2
\fBproperty\-file\-path\fP (\fIstr\fP) \-\- Property file path. All properties will be set
as parameters for the triggered build. (default \(aq\(aq)
.IP \(bu 2
\fBenable\-concurrent\fP (\fIbool\fP) \-\- Enable concurrent build. (default false)
.IP \(bu 2
\fBlabel\fP (\fIstr\fP) \-\- Restrict where the polling should run. (default \(aq\(aq)
.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- cron syntax of when to run (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- groovy\-script:
        script: groovy\-content
        script\-file\-path: path/to/filename
        property\-file\-path: /path/to/properties/file
        cron: H/15 * * * *
        enable\-concurrent: true
        label: master
        system\-script: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- groovy\-script

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ivy()
Poll with an Ivy script.
.sp
Requires the Jenkins \fI\%IvyTrigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fIstr\fP) \-\- Path of the ivy file. (optional)
.IP \(bu 2
\fBsettings\-path\fP (\fIstr\fP) \-\- Ivy Settings Path. (optional)
.IP \(bu 2
\fBproperties\-file\fP (\fIlist str\fP) \-\- List of properties file path. Properties
will be injected as variables in the ivy settings file. (optional)
.IP \(bu 2
\fBproperties\-content\fP (\fIstr\fP) \-\- Properties content. Properties will be
injected as variables in the ivy settings file. (optional)
.IP \(bu 2
\fBdebug\fP (\fIbool\fP) \-\- Active debug mode on artifacts resolution. (default false)
.IP \(bu 2
\fBdownload\-artifacts\fP \-\- Download artifacts for dependencies to see if they
have changed. (default true)
.IP \(bu 2
\fBenable\-concurrent\fP (\fIbool\fP) \-\- Enable Concurrent Build. (default false)
.IP \(bu 2
\fBlabel\fP (\fIstr\fP) \-\- Restrict where the polling should run. (default \(aq\(aq)
.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- cron syntax of when to run (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- ivy:
        path: path/to/file
        settings\-path: path/to/settings/file
        properties\-file:
            \- \(aqfilename1\(aq
            \- \(aqfilename2\(aq
        debug: true
        cron: \(aqH/15 * * * *\(aq
        enable\-concurrent: False
        label: master

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jira\-changelog()
Sets up a trigger that listens to JIRA issue changes.
.sp
Requires the Jenkins \fI\%JIRA Trigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBjql\-filter\fP (\fIstr\fP) \-\- Must match updated issues to trigger a build.
(default \(aq\(aq)
.IP \(bu 2
\fBchangelog\-matchers\fP (\fIlist\fP) \-\- .INDENT 2.0
.TP
.B Custom Field Matcher
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBcustom\-field\-name\fP (\fIstr\fP) \-\- The custom field
name that has been changed during the issue update.
(default \(aq\(aq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBcompare\-new\-value\fP (\fIbool\fP) \-\- Compare the
new value of the updated field. (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnew\-value\fP (\fIstr\fP) \-\- The new value of the updated field.
(default \(aq\(aq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBcompare\-old\-value\fP (\fIbool\fP) \-\- Compare the
old value of the updated field. (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBold\-value\fP (\fIstr\fP) \-\- The value
before the field is updated. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.TP
.B JIRA Field Matcher
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBjira\-field\-ID\fP (\fIstr\fP) \-\- The JIRA Field ID that
has been changed during the issue update. (default \(aq\(aq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBcompare\-new\-value\fP (\fIbool\fP) \-\- Compare the new value
of the updated field. (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBnew\-value\fP (\fIstr\fP) \-\- The new value of the updated field.
(default \(aq\(aq)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBcompare\-old\-value\fP (\fIbool\fP) \-\- Compare the old value
of the updated field. (default false)
.UNINDENT
.IP \(bu 2
.INDENT 2.0
.TP
\fBold\-value\fP (\fIstr\fP) \-\- The value before
the field is updated. (default \(aq\(aq)
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBparameter\-mapping\fP (\fIlist\fP) \-\- .INDENT 2.0
.TP
.B Issue Attribute Path
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBjenkins\-parameter\fP (\fIstr\fP) \-\- Jenkins parameter name
(default \(aq\(aq)
.UNINDENT
.IP \(bu 2
\fBissue\-attribute\-path\fP (\fIstr\fP) \-\- Attribute path (default \(aq\(aq)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- jira\-changelog

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- jira\-changelog:
      jql\-filter: filter
      changelog\-matchers:
          \- field\-type: \(aqCUSTOM\(aq
            field: name
            new\-value: val1
            old\-value: val2
            compare\-new\-value: true
            compare\-old\-value: true
          \- field\-type: \(aqJIRA\(aq
            field: versions
            new\-value: val3
            old\-value: val4
            compare\-new\-value: true
            compare\-old\-value: true
      parameter\-mapping:
          \- jenkins\-parameter: param
            issue\-attribute\-path: path

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jira\-comment\-trigger()
Trigger builds when a comment is added to JIRA.
.sp
Requires the Jenkins \fI\%JIRA Trigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBjql\-filter\fP (\fIstr\fP) \-\- Must match updated issues to trigger a build.
(default \(aq\(aq)
.IP \(bu 2
\fBcomment\-pattern\fP (\fIstr\fP) \-\- Triggers build only when the comment added to
JIRA matches pattern (default \(aq(?i)build this please\(aq)
.IP \(bu 2
\fBparameter\-mapping\fP (\fIlist\fP) \-\- .INDENT 2.0
.TP
.B Issue Attribute Path
.INDENT 7.0
.IP \(bu 2
.INDENT 2.0
.TP
\fBjenkins\-parameter\fP (\fIstr\fP) \-\- Jenkins parameter name
(default \(aq\(aq)
.UNINDENT
.IP \(bu 2
\fBissue\-attribute\-path\fP (\fIstr\fP) \-\- Attribute path (default \(aq\(aq)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- jira\-comment\-trigger

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- jira\-comment\-trigger:
      jql\-filter: filter
      comment\-pattern: comment
      parameter\-mapping:
        \- jenkins\-parameter: param1
          issue\-attribute\-path: \(aqpath/to/attribute\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jms\-messaging()
.INDENT 7.0
.TP
.B The JMS Messaging Plugin provides the following functionality:
.INDENT 7.0
.IP \(bu 2
A build trigger to submit jenkins jobs upon receipt
of a matching message.
.IP \(bu 2
A builder that may be used to submit a message to the topic
upon the completion of a job
.IP \(bu 2
A post\-build action that may be used to submit a message to the topic
upon the completion of a job
.UNINDENT
.TP
.B JMS Messaging provider types supported:
.INDENT 7.0
.IP \(bu 2
ActiveMQ
.IP \(bu 2
FedMsg
.UNINDENT
.UNINDENT
.sp
Requires the Jenkins \fI\%JMS Messaging Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBno\-squash\fP (\fIbool\fP) \-\- true = schedule a new job for every triggering message.
(default false)
Normally if a job is queued and another triggering message is received, a new job
is not submitted and the job is \(dqsquashed\(dq into the job already queued.
Setting this option to \(aqTrue\(aq forces a new job to be submitted for every triggering
message that is received.
.IP \(bu 2
\fBoverride\-topic\fP (\fIstr\fP) \-\- If you need to override the default topic.
(default \(aq\(aq)
.IP \(bu 2
\fBselector\fP (\fIstr\fP) \-\- The JSON or YAML formatted text that conforms to
the schema for defining the various OpenShift resources. (default \(aq\(aq)
note: topic needs to be in double quotes
ex. topic = \(dqorg.fedoraproject.prod.fedimg.image.upload\(dq
.IP \(bu 2
\fBprovider\-name\fP (\fIstr\fP) \-\- Name of message provider setup in the
global config. (default \(aq\(aq)
.IP \(bu 2
\fBchecks\fP (\fIlist\fP) \-\- List of checks to monitor. (default [])
.IP \(bu 2
\fBfield\fP (\fIstr\fP) \-\- Check the body of messages for a field. (default \(aq\(aq)
.IP \(bu 2
\fBexpected\-value\fP (\fIstr\fP) \-\- Expected value for the field. regex (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- jms\-messaging:
      no\-squash: True
      selector: topic = \(dqorg.fedoraproject.prod.fedimg.image.upload\(dq
      provider\-name: fedmsg
      checks:
        \- field: compose
          expected\-value: .+compose_id.+Fedora\-Atomic.+
        \- field: image_name
          expected\-value: .+Fedora\-Atomic.+

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- jms\-messaging:
      selector: topic = \(dqorg.fedoraproject.prod.fedimg.image.upload\(dq
      provider\-name: fedmsg

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B monitor\-files()
Configure Jenkins to monitor files.
Requires the Jenkins \fI\%Filesystem Trigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfiles\fP (\fIlist\fP) \-\- 
.sp
List of files to monitor
.INDENT 2.0
.TP
.B File
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fIstr\fP) \-\- File path to monitor. You can use a pattern
that specifies a set of files if you don\(aqt know the real file
path. (required)
.IP \(bu 2
\fBstrategy\fP (\fIstr\fP) \-\- Choose your strategy if there is more
than one matching file. Can be one of Ignore file (\(aqIGNORE\(aq) or
Use the most recent (\(aqLATEST\(aq). (default \(aqLATEST\(aq)
.IP \(bu 2
\fBcheck\-content\fP (\fIlist\fP) \-\- List of content changes of the
file to monitor
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Content Nature
.INDENT 7.0
.IP \(bu 2
\fBsimple\fP (\fIbool\fP) \-\- Trigger on change in content of
the specified file (whatever the type file).
(default false)
.IP \(bu 2
\fBjar\fP (\fIbool\fP) \-\- Trigger on change in content of the
specified JAR file. (default false)
.IP \(bu 2
\fBtar\fP (\fIbool\fP) \-\- Trigger on change in content of the
specified Tar file. (default false)
.IP \(bu 2
\fBzip\fP (\fIbool\fP) \-\- Trigger on change in content of the
specified ZIP file. (default false)
.IP \(bu 2
\fBsource\-manifest\fP (\fIlist\fP) \-\- Trigger on change to
MANIFEST files.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B MANIFEST File
.INDENT 7.0
.IP \(bu 2
\fBkeys\fP (\fIlist\fP) \-\- List of keys to inspect.
(optional)
.IP \(bu 2
\fBall\-keys\fP (\fIbool\fP) \-\- If true, take into
account all keys. (default true)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBjar\-manifest\fP (\fIlist\fP) \-\- Trigger on change to
MANIFEST files (contained in jar files).
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B MANIFEST File
.INDENT 7.0
.IP \(bu 2
\fBkeys\fP (\fIlist\fP) \-\- List of keys to inspect.
(optional)
.IP \(bu 2
\fBall\-keys\fP (\fIbool\fP) \-\- If true, take into
account all keys. (default true)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBproperties\fP (\fIlist\fP) \-\- Monitor the contents of the
properties file.
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Properties File
.INDENT 7.0
.IP \(bu 2
\fBkeys\fP (\fIlist\fP) \-\- List of keys to inspect.
(optional)
.IP \(bu 2
\fBall\-keys\fP (\fIbool\fP) \-\- If true, take into
account all keys. (default true)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
\fBxml\fP (\fIlist str\fP) \-\- Trigger on change to the listed
XPath expressions.
.IP \(bu 2
\fBtext\fP (\fIlist str\fP) \-\- Trigger on change to the listed
regular expressions.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBignore\-modificaton\-date\fP (\fIbool\fP) \-\- If true, ignore the file
modification date. Only valid when content changes of the file
are being monitored. (default true)
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- cron syntax of when to run (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- monitor\-files:
      files:
          \- path: \(aqpath1\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- monitor\-files:
      cron: \(aq* * * * *\(aq
      files:
          \- path: \(aqpath1\(aq
            strategy: \(aqIGNORE\(aq
          \- path: \(aqpath2\(aq
            check\-content:
                \- simple: true
                \- jar: true
                \- tar: true
                \- zip: true
                \- source\-manifest:
                    \- all\-keys: false
                      keys:
                          \- key1
                          \- key2
                \- jar\-manifest:
                    \- keys:
                          \- key1
                          \- key2
                \- properties:
                    \- all\-keys: false
                      keys:
                          \- prop1
                          \- prop2
                \- xml:
                    \- \(aqxpath1\(aq
                    \- \(aqxpath2\(aq
                \- text:
                    \- \(aqregex1\(aq
            ignore\-modificaton\-date: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B monitor\-folders()
Configure Jenkins to monitor folders.
.sp
Requires the Jenkins \fI\%Filesystem Trigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpath\fP (\fIstr\fP) \-\- Folder path to poll. (default \(aq\(aq)
.IP \(bu 2
\fBincludes\fP (\fIlist\fP) \-\- Fileset includes setting that specifies the list of
includes files. Basedir of the fileset is relative to the workspace
root. If no value is set, all files are used. (default \(aq\(aq)
.IP \(bu 2
\fBexcludes\fP (\fIstr\fP) \-\- The \(aqexcludes\(aq pattern. A file that matches this mask
will not be polled even if it matches the mask specified in \(aqincludes\(aq
section. (default \(aq\(aq)
.IP \(bu 2
\fBcheck\-modification\-date\fP (\fIbool\fP) \-\- Check last modification date.
(default true)
.IP \(bu 2
\fBcheck\-content\fP (\fIbool\fP) \-\- Check content. (default true)
.IP \(bu 2
\fBcheck\-fewer\fP (\fIbool\fP) \-\- Check fewer files (default true)
.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- cron syntax of when to run (default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- monitor\-folders:
      path: \(aqpathname\(aq
      includes:
        \- \(aqpattern1\(aq
        \- \(aqpattern2\(aq
      excludes: \(aqpattern1\(aq
      check\-modification\-date: false
      check\-content: false
      check\-fewer: false
      cron: H/15 * * * *

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- monitor\-folders

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B parameterized\-timer()
Trigger builds with parameters at certain times.
Requires the Jenkins \fI\%Parameterized Scheduler Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBcron\fP (\fIstr\fP) \-\- cron syntax of when to run and with which parameters
(required)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- parameterized\-timer:
      cron: \(dq@midnight % PARAM=value\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pollscm()
Poll the SCM to determine if there has been a change.
.INDENT 7.0
.TP
.B Parameter
the polling interval (cron syntax)
.UNINDENT
.sp
Deprecated since version 1.3.0.: Please use \fI\%cron\fP\&.

.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- the polling interval (cron syntax, required)
.IP \(bu 2
\fBignore\-post\-commit\-hooks\fP (\fIbool\fP) \-\- Ignore changes notified by SCM
post\-commit hooks. The subversion\-plugin supports this since
version 1.44. (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- pollscm:
      cron: \(dq*/30 * * * *\(dq
      ignore\-post\-commit\-hooks: True

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pollurl()
Trigger when the HTTP response from a URL changes.
Requires the Jenkins \fI\%URLTrigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- cron syntax of when to run (default \(aq\(aq)
.IP \(bu 2
\fBpolling\-node\fP (\fIstr\fP) \-\- Restrict where the polling should run.
(optional)
.IP \(bu 2
\fBurls\fP (\fIlist\fP) \-\- 
.sp
List of URLs to monitor
.INDENT 2.0
.TP
.B URL
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL to monitor for changes (required)
.IP \(bu 2
\fBproxy\fP (\fIbool\fP) \-\- Activate the Jenkins proxy (default false)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \-\- Connect/read timeout in seconds
(default 300)
.IP \(bu 2
\fBusername\fP (\fIstr\fP) \-\- User name for basic authentication
(optional)
.IP \(bu 2
\fBpassword\fP (\fIstr\fP) \-\- Password for basic authentication
(optional)
.IP \(bu 2
\fBcheck\-status\fP (\fIint\fP) \-\- Check for a specific HTTP status
code (optional)
.IP \(bu 2
\fBcheck\-etag\fP (\fIbool\fP) \-\- Check the HTTP ETag for changes
(default false)
.IP \(bu 2
\fBcheck\-date\fP (\fIbool\fP) \-\- Check the last modification date of
the URL (default false)
.IP \(bu 2
\fBcheck\-content\fP (\fIlist\fP) \-\- List of content type changes to
monitor
.INDENT 2.0
.TP
.B Content Type
.INDENT 7.0
.IP \(bu 2
\fBsimple\fP (\fIbool\fP) \-\- Trigger on any change to
the content of the URL (default false)
.IP \(bu 2
\fBjson\fP (\fIlist\fP) \-\- Trigger on any change to
the listed JSON paths
.IP \(bu 2
\fBtext\fP (\fIlist\fP) \-\- Trigger on any change to
the listed regular expressions
.IP \(bu 2
\fBxml\fP (\fIlist\fP) \-\- Trigger on any change to
the listed XPath expressions
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- pollurl:
      cron: \(aq* * * * *\(aq
      polling\-node: \(aqlabel expression\(aq
      urls:
        \- url: \(aqhttp://example.com/url1\(aq
          proxy: false
          timeout: 442
          username: username
          password: sekr3t
          check\-status: 202
          check\-etag: false
          check\-date: true
          check\-content:
            \- simple: true
            \- json:
              \- \(aq$..author\(aq
              \- \(aq$.store..price\(aq
        \- url: \(aqhttp://example.com/url2\(aq
          proxy: true
          check\-etag: true
          check\-content:
            \- simple: false
            \- xml:
              \- \(aq//author\(aq
              \- \(aq/store//price\(aq
            \- text:
              \- \(aq\ed+\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B rabbitmq()
This plugin triggers build using remote build message in RabbitMQ queue.
.sp
Requires the Jenkins \fI\%RabbitMQ Build Trigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtoken\fP (\fIstr\fP) \-\- the build token expected in the message queue (required)
.IP \(bu 2
\fBfilters\fP (\fIlist\fP) \-\- 
.sp
list of filters to apply (optional)
.INDENT 2.0
.TP
.B Filter
.INDENT 7.0
.IP \(bu 2
\fBfield\fP (\fIstr\fP) \- Some field in message (required)
.IP \(bu 2
\fBvalue\fP (\fIstr\fP) \- value of specified field (required)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- rabbitmq:
      token: \(aqbuild_trigger_token\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example with filters:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- rabbitmq:
      token: \(aqbuild_trigger_token\(aq
      filters:
        \- field: \(aqfield1\(aq
          value: \(aqvalue1\(aq
        \- field: \(aqfield2\(aq
          value: \(aqvalue2\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B reverse()
This trigger can be configured in the UI using the checkbox with the
following text: \(aqBuild after other projects are built\(aq.
.sp
Set up a trigger so that when some other projects finish building, a new
build is scheduled for this project. This is convenient for running an
extensive test after a build is complete, for example.
.sp
This configuration complements the \(dqBuild other projects\(dq section in the
\(dqPost\-build Actions\(dq of an upstream project, but is preferable when you
want to configure the downstream project.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBjobs\fP (\fIstr\fP) \-\- List of jobs to watch. Can be either a comma separated
list or a list.
.IP \(bu 2
\fBresult\fP (\fIstr\fP) \-\- Build results to monitor for between the following
options: success, unstable and failure. (default \(aqsuccess\(aq).
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- reverse:
        jobs: \(aqFantastic\-job\(aq
        result: \(aqfailure\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example List:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- reverse:
        jobs:
            \- \(aqa\(aq
            \- \(aqb\(aq
            \- \(aqc\(aq
        result: \(aqfailure\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B script()
Triggers the job using shell or batch script.
.sp
Requires the Jenkins \fI\%ScriptTrigger Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBlabel\fP (\fIstr\fP) \-\- Restrict where the polling should run. (default \(aq\(aq)
.IP \(bu 2
\fBscript\fP (\fIstr\fP) \-\- A shell or batch script. (default \(aq\(aq)
.IP \(bu 2
\fBscript\-file\-path\fP (\fIstr\fP) \-\- A shell or batch script path. (default \(aq\(aq)
.IP \(bu 2
\fBcron\fP (\fIstr\fP) \-\- cron syntax of when to run (default \(aq\(aq)
.IP \(bu 2
\fBenable\-concurrent\fP (\fIbool\fP) \-\- Enables triggering concurrent builds.
(default false)
.IP \(bu 2
\fBexit\-code\fP (\fIint\fP) \-\- If the exit code of the script execution returns this
expected exit code, a build is scheduled. (default 0)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- script:
        script: \(aqexit 0\(aq
        script\-file\-path: \(aq$WORKSPACE/scripts\(aq
        cron: \(aqH/15 * * * *\(aq
        enable\-concurrent: true
        label: master
        exit\-code: 0

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- script

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B stash\-pull\-request()
Trigger builds via Stash/Bitbucket Server Pull Requests.
.sp
Requires the Jenkins \fI\%Stash Pull Request Builder Plugin\fP\&.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B arg str cron
cron syntax of when to run (required)
.TP
.B arg str stash\-host
The HTTP or HTTPS URL of the Stash host (NOT ssh).
e.g.: \fI\%https://example.com\fP (required)
.TP
.B arg str credentials\-id
Jenkins credential set to use. (required)
.TP
.B arg str project
Abbreviated project code. e.g.: PRJ or ~user (required)
.TP
.B arg str repository
Stash Repository Name.  e.g.:  Repo (required)
.TP
.B arg str ci\-skip\-phrases
CI Skip Phrases. (default \(aqNO TEST\(aq)
.TP
.B arg str ci\-build\-phrases
CI Build Phrases. (default \(aqtest this please\(aq)
.TP
.B arg str target\-branches
Target branches to filter. (default \(aq\(aq)
.TP
.B arg bool ignore\-ssl
Ignore SSL certificates for Stash host.
(default false)
.TP
.B arg bool check\-destination\-commit
Rebuild if destination branch
changes. (default false)
.TP
.B arg bool check\-mergable
Build only if PR is mergeable. (default false)
.TP
.B arg bool merge\-on\-success
Merge PR if build is successful.
(default false)
.TP
.B arg bool check\-not\-conflicted
Build only if Stash reports no conflicts.
(default false)
.TP
.B arg bool only\-build\-on\-comment
Only build when asked (with test
phrase). (default false)
.TP
.B arg bool delete\-previous\-build\-finish\-comments
Keep PR comment only for
most recent Build. (default false)
.TP
.B arg bool cancel\-outdated\-jobs
Cancel outdated jobs. (default false)
.UNINDENT
.sp
Minimal Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- stash\-pull\-request:
      cron: \(dq* * * * *\(dq
      stash\-host: \(dqhttps://stash\-host.com\(dq
      credentials\-id: default\-stash\-credentials
      project: stash\-project
      repository: stash\-repo

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- stash\-pull\-request:
      cron: \(dqH 1 2 3 4\(dq
      stash\-host: \(dqhttps://stash\-host.com\(dq
      credentials\-id: default\-stash\-credentials
      project: stash\-project
      repository: stash\-repo
      ci\-skip\-phrases: \(dqtest skip phrase\(dq
      ci\-build\-phrases: \(dqtest build phrase\(dq
      target\-branches: \(dqmaster\(dq
      ignore\-ssl: true
      check\-destination\-commit: true
      check\-mergable: true
      merge\-on\-success: true
      check\-not\-conflicted: false
      only\-build\-on\-comment: true
      delete\-previous\-build\-finish\-comments: true
      cancel\-outdated\-jobs: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B timed()
Trigger builds at certain times.
.INDENT 7.0
.TP
.B Parameter
when to run the job (cron syntax)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- timed: \(dq@midnight\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Wrappers
.sp
Wrappers can alter the way the build is run as well as the build output.
.INDENT 0.0
.TP
\fBComponent\fP: wrappers
.INDENT 7.0
.TP
.B Macro
wrapper
.TP
.B Entry Point
jenkins_jobs.wrappers
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B class  wrappers.Wrappers(registry)
.INDENT 7.0
.TP
.B component_list_type  =  \(aqwrappers\(aq
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  \(aqwrapper\(aq
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  80
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B android\-emulator()
Automates many Android development tasks including SDK installation,
build file generation, emulator creation and launch,
APK (un)installation...
.sp
Requires the Jenkins \fI\%Android Emulator Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBavd\fP (\fIstr\fP) \-\- Enter the name of an existing Android emulator configuration.
If this is exclusive with the \(aqos\(aq arg.
.IP \(bu 2
\fBos\fP (\fIstr\fP) \-\- Can be an OS version, target name or SDK add\-on
.IP \(bu 2
\fBscreen\-density\fP (\fIstr\fP) \-\- Density in dots\-per\-inch (dpi) or as an alias,
e.g. \(dq160\(dq or \(dqmdpi\(dq. (default mdpi)
.IP \(bu 2
\fBscreen\-resolution\fP (\fIstr\fP) \-\- Can be either a named resolution or explicit
size, e.g. \(dqWVGA\(dq or \(dq480x800\(dq. (default WVGA)
.IP \(bu 2
\fBlocale\fP (\fIstr\fP) \-\- Language and country pair. (default en_US)
.IP \(bu 2
\fBtarget\-abi\fP (\fIstr\fP) \-\- Name of the ABI / system image to be used. (optional)
.IP \(bu 2
\fBsd\-card\fP (\fIstr\fP) \-\- sd\-card size e.g. \(dq32M\(dq or \(dq10240K\(dq. (optional)
.IP \(bu 2
\fBwipe\fP (\fIbool\fP) \-\- if true, the emulator will have its user data reset at
start\-up (default false)
.IP \(bu 2
\fBshow\-window\fP (\fIbool\fP) \-\- if true, the Android emulator user interface will
be displayed on screen during the build. (default false)
.IP \(bu 2
\fBsnapshot\fP (\fIbool\fP) \-\- Start emulator from stored state (default false)
.IP \(bu 2
\fBdelete\fP (\fIbool\fP) \-\- Delete Android emulator at the end of build
(default false)
.IP \(bu 2
\fBstartup\-delay\fP (\fIint\fP) \-\- Wait this many seconds before attempting
to start the emulator (default 0)
.IP \(bu 2
\fBcommandline\-options\fP (\fIstr\fP) \-\- Will be given when starting the
Android emulator executable (optional)
.IP \(bu 2
\fBexe\fP (\fIstr\fP) \-\- The emulator executable. (optional)
.IP \(bu 2
\fBhardware\-properties\fP (\fIlist\fP) \-\- Dictionary of hardware properties. Allows
you to override the default values for an AVD. (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- android\-emulator:
      os: android\-19
      target\-abi: x86
      sd\-card: 16MB
      hardware\-properties:
        hw.accelerometer: 100
      wipe: true
      show\-window: true
      snapshot: true
      delete: true
      startup\-delay: 10
      commandline\-options: \(dq\-gpu on \-no\-audio\(dq
      exe: emulator\-arm

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ansicolor()
Translate ANSI color codes to HTML in the console log.
.sp
Requires the Jenkins \fI\%Ansi Color Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBcolormap\fP (\fIstr\fP) \-\- Color mapping to use (default xterm)
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- ansicolor

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- ansicolor:
      colormap: \(dqgnome\-terminal\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B artifactory\-generic()
Wrapper for non\-Maven projects.
.sp
Requires the Jenkins \fI\%Artifactory Plugin\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL of the Artifactory server. e.g.
\fI\%https://jfrog.com/artifactory/\fP (default \(aq\(aq)
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Artifactory user with permissions use for
connected to the selected Artifactory Server
(default \(aq\(aq)
.IP \(bu 2
\fBrepo\-key\fP (\fIstr\fP) \-\- Release repository name (plugin < 2.3.0) (default \(aq\(aq)
.IP \(bu 2
\fBsnapshot\-repo\-key\fP (\fIstr\fP) \-\- Snapshots repository name (plugin < 2.3.0)
(default \(aq\(aq)
.IP \(bu 2
\fBkey\-from\-select\fP (\fIstr\fP) \-\- Repository key to use (plugin >= 2.3.0)
(default \(aq\(aq)
.IP \(bu 2
\fBkey\-from\-text\fP (\fIstr\fP) \-\- Repository key to use that can be configured
dynamically using Jenkins variables (plugin >= 2.3.0) (default \(aq\(aq)
.IP \(bu 2
\fBupload\-spec\fP (\fIstr\fP) \-\- File Spec schema for uploading files is as follows
(default \(aq\(aq)
.IP \(bu 2
\fBdownload\-spec\fP (\fIstr\fP) \-\- File Spec schema for downloading
files is as follows (default \(aq\(aq)
.IP \(bu 2
\fBupload\-spec\-file\fP (\fIstr\fP) \-\- File location for uploading Spec schema
(default \(aq\(aq)
.IP \(bu 2
\fBdownload\-spec\-file\fP (\fIstr\fP) \-\- File location for downloading Spec schema
(default \(aq\(aq)
.IP \(bu 2
\fBdeploy\-pattern\fP (\fIlist\fP) \-\- List of patterns for mappings
build artifacts to published artifacts. Supports Ant\-style wildcards
mapping to target directories. E.g.: \fI/\fP\&.zip=>dir (default [])
.IP \(bu 2
\fBresolve\-pattern\fP (\fIlist\fP) \-\- List of references to other
artifacts that this build should use as dependencies.
.IP \(bu 2
\fBmatrix\-params\fP (\fIlist\fP) \-\- List of properties to attach to all deployed
artifacts in addition to the default ones: build.name, build.number,
and vcs.revision (default [])
.IP \(bu 2
\fBdeploy\-build\-info\fP (\fIbool\fP) \-\- Deploy jenkins build metadata with
artifacts to Artifactory (default false)
.IP \(bu 2
\fBenv\-vars\-include\fP (\fIbool\fP) \-\- Include environment variables accessible by
the build process. Jenkins\-specific env variables are always included.
Use the env\-vars\-include\-patterns and env\-vars\-exclude\-patterns to
filter the environment variables published to artifactory.
(default false)
.IP \(bu 2
\fBenv\-vars\-include\-patterns\fP (\fIlist\fP) \-\- List of environment variable patterns
for including env vars as part of the published build info. Environment
variables may contain the * and the ? wildcards (default [])
.IP \(bu 2
\fBenv\-vars\-exclude\-patterns\fP (\fIlist\fP) \-\- List of environment variable patterns
that determine the env vars excluded from the published build info
(default [])
.IP \(bu 2
\fBdiscard\-old\-builds\fP (\fIbool\fP) \-\- Remove older build info from Artifactory (default false)
.IP \(bu 2
\fBdiscard\-build\-artifacts\fP (\fIbool\fP) \-\- Remove older build artifacts from Artifactory (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- artifactory\-generic:
      url: http://artifactory.example.net/artifactory
      name: \(aqtest\(aq
      deploy\-build\-info: true
      repo\-key: \(aqrelease\-repo\(aq
      snapshot\-repo\-key: \(aqsnapshot\-repo\(aq
      deploy\-pattern:
      \- \(aq*.zip=>results\(aq
      resolve\-pattern:
      \- \(aqlibs\-release\-local:prod/*=>prod\-jars\(aq
      matrix\-params:
      \- \(aqcustom_prop=${PROJECT_ENV_VAR}\(aq
      env\-vars\-include: true
      env\-vars\-include\-patterns:
      \- \(aqPROJECT_*\(aq
      \- \(aqORG_*\(aq
      discard\-old\-builds: true
      discard\-build\-artifacts: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B artifactory\-maven()
Wrapper for non\-Maven projects.
.sp
Requires the Jenkins \fI\%Artifactory Plugin\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL of the Artifactory server. e.g.
\fI\%https://jfrog.com/artifactory/\fP (default \(aq\(aq)
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Artifactory user with permissions use for
connected to the selected Artifactory Server
(default \(aq\(aq)
.IP \(bu 2
\fBrepo\-key\fP (\fIstr\fP) \-\- Name of the repository to search for
artifact dependencies. Provide a single repo\-key or provide
separate release\-repo\-key and snapshot\-repo\-key.
.IP \(bu 2
\fBrelease\-repo\-key\fP (\fIstr\fP) \-\- Release repository name. Value of
repo\-key take priority over release\-repo\-key if provided.
.IP \(bu 2
\fBsnapshot\-repo\-key\fP (\fIstr\fP) \-\- Snapshots repository name. Value of
repo\-key take priority over release\-repo\-key if provided.
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- artifactory\-maven:
      url: http://artifactory.example.net/artifactory
      name: \(aqtest\(aq
      repo\-key: repo

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B artifactory\-maven\-freestyle()
Wrapper for Free Stype projects.
.sp
Requires the Jenkins \fI\%Artifactory Plugin\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBurl\fP (\fIstr\fP) \-\- URL of the Artifactory server. e.g.
\fI\%https://jfrog.com/artifactory/\fP (default \(aq\(aq)
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Artifactory user with permissions use for
connected to the selected Artifactory Server (default \(aq\(aq)
.IP \(bu 2
\fBrelease\-repo\-key\fP (\fIstr\fP) \-\- Release repository name (default \(aq\(aq)
.IP \(bu 2
\fBsnapshot\-repo\-key\fP (\fIstr\fP) \-\- Snapshots repository name (default \(aq\(aq)
.IP \(bu 2
\fBpublish\-build\-info\fP (\fIbool\fP) \-\- Push build metadata with artifacts
(default false)
.IP \(bu 2
\fBdiscard\-old\-builds\fP (\fIbool\fP) \-\- Remove older build info from Artifactory (default true)
.IP \(bu 2
\fBdiscard\-build\-artifacts\fP (\fIbool\fP) \-\- Remove older build artifacts from Artifactory (default false)
.IP \(bu 2
\fBinclude\-env\-vars\fP (\fIbool\fP) \-\- Include all environment variables
accessible by the build process. Jenkins\-specific env variables
are always included (default false)
.IP \(bu 2
\fBrun\-checks\fP (\fIbool\fP) \-\- Run automatic license scanning check after the
build is complete (default false)
.IP \(bu 2
\fBinclude\-publish\-artifacts\fP (\fIbool\fP) \-\- Include the build\(aqs published
module artifacts in the license violation checks if they are
also used as dependencies for other modules in this build
(default false)
.IP \(bu 2
\fBlicense\-auto\-discovery\fP (\fIbool\fP) \-\- Tells Artifactory not to try
and automatically analyze and tag the build\(aqs dependencies
with license information upon deployment (default true)
.IP \(bu 2
\fBenable\-issue\-tracker\-integration\fP (\fIbool\fP) \-\- When the Jenkins
JIRA plugin is enabled, synchronize information about JIRA
issues to Artifactory and attach issue information to build
artifacts (default false)
.IP \(bu 2
\fBaggregate\-build\-issues\fP (\fIbool\fP) \-\- When the Jenkins JIRA plugin
is enabled, include all issues from previous builds up to the
latest build status defined in \(dqAggregation Build Status\(dq
(default false)
.IP \(bu 2
\fBfilter\-excluded\-artifacts\-from\-build\fP (\fIbool\fP) \-\- Add the excluded
files to the excludedArtifacts list and remove them from the
artifacts list in the build info (default false)
.IP \(bu 2
\fBscopes\fP (\fIstr\fP) \-\- A list of dependency scopes/configurations to run
license violation checks on. If left empty all dependencies from
all scopes will be checked (default \(aq\(aq)
.IP \(bu 2
\fBviolation\-recipients\fP (\fIstr\fP) \-\- Recipients that need to be notified
of license violations in the build info (default \(aq\(aq)
.IP \(bu 2
\fBmatrix\-params\fP (\fIlist\fP) \-\- List of properties to attach to all
deployed artifacts in addition to the default ones:
build.name, build.number, and vcs.revision (default \(aq\(aq)
.IP \(bu 2
\fBblack\-duck\-app\-name\fP (\fIstr\fP) \-\- The existing Black Duck Code Center
application name (default \(aq\(aq)
.IP \(bu 2
\fBblack\-duck\-app\-version\fP (\fIstr\fP) \-\- The existing Black Duck Code Center
application version (default \(aq\(aq)
.IP \(bu 2
\fBblack\-duck\-report\-recipients\fP (\fIstr\fP) \-\- Recipients that will be emailed
a report after the automatic Black Duck Code Center compliance checks
finished (default \(aq\(aq)
.IP \(bu 2
\fBblack\-duck\-scopes\fP (\fIstr\fP) \-\- A list of dependency scopes/configurations
to run Black Duck Code Center compliance checks on. If left empty
all dependencies from all scopes will be checked (default \(aq\(aq)
.IP \(bu 2
\fBblack\-duck\-run\-checks\fP (\fIbool\fP) \-\- Automatic Black Duck Code Center
compliance checks will occur after the build completes
(default false)
.IP \(bu 2
\fBblack\-duck\-include\-published\-artifacts\fP (\fIbool\fP) \-\- Include the build\(aqs
published module artifacts in the license violation checks if they
are also used as dependencies for other modules in this build
(default false)
.IP \(bu 2
\fBauto\-create\-missing\-component\-requests\fP (\fIbool\fP) \-\- Auto create
missing components in Black Duck Code Center application after
the build is completed and deployed in Artifactory
(default true)
.IP \(bu 2
\fBauto\-discard\-stale\-component\-requests\fP (\fIbool\fP) \-\- Auto discard
stale components in Black Duck Code Center application after
the build is completed and deployed in Artifactory
(default true)
.IP \(bu 2
\fBdeploy\-artifacts\fP (\fIbool\fP) \-\- Push artifacts to the Artifactory
Server. The specific artifacts to push are controlled using
the deployment\-include\-patterns and deployment\-exclude\-patterns.
(default true)
.IP \(bu 2
\fBdeployment\-include\-patterns\fP (\fIlist\fP) \-\- List of patterns for including
build artifacts to publish to artifactory. (default[]\(aq)
.IP \(bu 2
\fBdeployment\-exclude\-patterns\fP (\fIlist\fP) \-\- List of patterns
for excluding artifacts from deployment to Artifactory
(default [])
.IP \(bu 2
\fBenv\-vars\-include\fP (\fIbool\fP) \-\- Include environment variables
accessible by the build process. Jenkins\-specific env variables
are always included. Environment variables can be filtered using
the env\-vars\-include\-patterns nad env\-vars\-exclude\-patterns.
(default false)
.IP \(bu 2
\fBenv\-vars\-include\-patterns\fP (\fIlist\fP) \-\- List of environment variable patterns
that will be included as part of the published build info. Environment
variables may contain the * and the ? wildcards (default [])
.IP \(bu 2
\fBenv\-vars\-exclude\-patterns\fP (\fIlist\fP) \-\- List of environment variable patterns
that will be excluded from the published build info
(default [])
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- artifactory\-maven\-freestyle:
      url: http://artifactory.example.net/artifactory
      name: \(aqtest\(aq
      repo\-key: repo
      matrix\-params:
      \- \(aqcustom_prop=${PROJECT_ENV_VAR}\(aq
      deployment\-include\-patterns:
      \- \(aq*.zip=>results\(aq
      env\-vars\-include: true
      env\-vars\-include\-patterns:
      \- \(aqPROJECT_*\(aq
      \- \(aqORG_*\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B build\-keeper()
Keep builds based on specific policy.
.sp
Requires the Jenkins \fI\%Build Keeper Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBpolicy\fP (\fIstr\fP) \-\- 
.sp
Policy to keep builds.
.INDENT 2.0
.TP
.B policy values
.INDENT 7.0
.IP \(bu 2
\fBby\-day\fP
.IP \(bu 2
\fBkeep\-since\fP
.IP \(bu 2
\fBbuild\-number\fP
.IP \(bu 2
\fBkeep\-first\-failed\fP
.IP \(bu 2
\fBrun\-condition\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBbuild\-period\fP (\fIint\fP) \-\- Number argument to calculate build to keep,
depends on the policy. (default 0)
.IP \(bu 2
\fBdont\-keep\-failed\fP (\fIbool\fP) \-\- Flag to indicate if to keep failed builds.
(default false)
.IP \(bu 2
\fBnumber\-of\-fails\fP (\fIint\fP) \-\- number of consecutive failed builds in order
to mark first as keep forever, only applies to keep\-first\-failed
policy (default 0)
.IP \(bu 2
\fBkeep\-build\fP (\fIbool\fP) \-\- Build will be kept if there is a problem
evaluating the RunCondition (default false)
.IP \(bu 2
\fBtoken\fP (\fIstr\fP) \-\- Token value for the boolean condition (default \(aq\(aq)
.IP \(bu 2
\fBbuild\-cause\fP (\fIlist\fP) \-\- The cause why the build
was triggered (default USER_CAUSE)
.IP \(bu 2
\fBexclusive\-cause\fP (\fIbool\fP) \-\- Cause must be the only one causing this
build to be triggered (default False)
.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- Contents of your shell script (default \(aq\(aq)
.IP \(bu 2
\fBallowed\-nodes\fP (\fIstr\fP) \-\- Node to be executed on (default \(aq\(aq)
.IP \(bu 2
\fBexpression\fP (\fIstr\fP) \-\- The regular expression used to
match the label (default \(aq\(aq)
.IP \(bu 2
\fBlabel\fP (\fIstr\fP) \-\- The label that will be tested by
the regular expression (default \(aq\(aq)
.IP \(bu 2
\fBarg1\fP (\fIstr\fP) \-\- First string argument for
strings\-match condition (default \(aq\(aq)
.IP \(bu 2
\fBarg2\fP (\fIstr\fP) \-\- Second string argument for
strings\-match condition (default \(aq\(aq)
.IP \(bu 2
\fBignore\-case\fP (\fIbool\fP) \-\- Ignore the case of the strings when
matching the two string arguments (default False)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- build\-keeper:
      policy: \(aqby\-day\(aq
      build\-period: 10
      dont\-keep\-failed: true

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- build\-keeper:
      policy: \(aqkeep\-first\-failed\(aq
      number\-of\-fails: 1

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B build\-name()
Set the name of the build.
.sp
Requires the Jenkins \fI\%Build Name Setter Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Name for the build.  Typically you would use a variable
from Jenkins in the name.  The syntax would be ${FOO} for
the FOO variable.
.IP \(bu 2
\fBdescription\fP (\fIstr\fP) \-\- Build description for the build (Optional).
.IP \(bu 2
\fBrun\-at\-start\fP (\fIstr\fP) \-\- Set build name before build starts (Optional, default: True).
.IP \(bu 2
\fBrun\-at\-end\fP (\fIstr\fP) \-\- Set build name after build ends (Optional, default: True).
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- build\-name:
      name: Build\-${FOO}
      description: lorem ipsum dolor
      run\-at\-start: true
      run\-at\-end: false
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B build\-user\-vars()
Set environment variables to the value of the user that started the build.
.sp
Requires the Jenkins \fI\%Build User Vars Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- build\-user\-vars
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ci\-skip()
Skip making a build for certain push.
Just add [ci skip] into your commit\(aqs message to let Jenkins know,
that you do not want to perform build for the next push.
.sp
Requires the Jenkins \fI\%Ci Skip Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- ci\-skip

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B config\-file\-provider()
Provide configuration files (i.e., settings.xml for maven etc.)
which will be copied to the job\(aqs workspace.
.sp
Requires the Jenkins \fI\%Config File Provider Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBfiles\fP (\fIlist\fP) \-\- 
.sp
List of managed config files made up of three
parameters
.INDENT 7.0
.TP
.B files
.INDENT 7.0
.IP \(bu 2
\fBfile\-id\fP (\fIstr\fP) \-\- The identifier for the managed config
file
.IP \(bu 2
\fBtarget\fP (\fIstr\fP) \-\- Define where the file should be created
(default \(aq\(aq)
.IP \(bu 2
\fBvariable\fP (\fIstr\fP) \-\- Define an environment variable to be
used (default \(aq\(aq)
.IP \(bu 2
\fBreplace\-tokens\fP (\fIbool\fP) \-\- Replace tokens in config file.
For example \(dqpassword: ${PYPI_JENKINS_PASS}\(dq will be replaced
with the global variable configured in Jenkins.
.UNINDENT
.UNINDENT

.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- config\-file\-provider:
      files:
        \- file\-id: org.jenkinsci.plugins.configfiles.custom.CustomConfig1234
        \- file\-id: org.jenkinsci.plugins.configfiles.custom.CustomConfig5678
          target: /foo.txt
          variable: varName
          replace\-tokens: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- config\-file\-provider:
      files:
        \- file\-id: org.jenkinsci.plugins.configfiles.custom.CustomConfig1234

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B copy\-to\-slave()
Copy files to slave before build.
.sp
Requires the Jenkins \fI\%Copy To Slave Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBincludes\fP (\fIlist\fP) \-\- list of file patterns to copy (optional)
.IP \(bu 2
\fBexcludes\fP (\fIlist\fP) \-\- list of file patterns to exclude (optional)
.IP \(bu 2
\fBflatten\fP (\fIbool\fP) \-\- flatten directory structure (default false)
.IP \(bu 2
\fBrelative\-to\fP (\fIstr\fP) \-\- base location of includes/excludes, must be home
($JENKINS_HOME), somewhereElse ($JENKINS_HOME/copyToSlave),
userContent ($JENKINS_HOME/userContent) or workspace
(default userContent)
.IP \(bu 2
\fBinclude\-ant\-excludes\fP (\fIbool\fP) \-\- exclude ant\(aqs default excludes
(default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- copy\-to\-slave

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- copy\-to\-slave:
        includes:
            \- \(aqfile1\(aq
            \- \(aqfile2*.txt\(aq
        excludes:
            \- \(aqfile2bad.txt\(aq
        flatten: True
        relative\-to: \(aqsomewhereElse\(aq
        include\-ant\-excludes: True

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B credentials\-binding()
Binds credentials to environment variables using the credentials binding
plugin for jenkins.
.sp
Requires the Jenkins \fI\%Credentials Binding Plugin\fP version 1.1 or greater.
.INDENT 7.0
.TP
.B Parameters
\fBbinding\-type\fP (\fIlist\fP) \-\- 
.sp
List of each bindings to create.  Bindings may be
of type \fIzip\-file\fP, \fIfile\fP, \fIusername\-password\fP, \fItext\fP,
\fIusername\-password\-separated\fP or \fIamazon\-web\-services\fP\&.
username\-password sets a variable to the username and password given in
the credentials, separated by a colon.
username\-password\-separated sets one variable to the username and one
variable to the password given in the credentials.
amazon\-web\-services sets one variable to the access key and one
variable to the secret access key. Requires the
\fI\%AWS Credentials Plugin\fP
\&.
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcredential\-id\fP (\fIstr\fP) UUID of the credential being
referenced
.IP \(bu 2
\fBvariable\fP (\fIstr\fP) Environment variable where the
credential will be stored
.IP \(bu 2
\fBusername\fP (\fIstr\fP) Environment variable for the
username (Required for binding\-type
username\-password\-separated)
.IP \(bu 2
\fBpassword\fP (\fIstr\fP) Environment variable for the
password (Required for binding\-type
username\-password\-separated)
.IP \(bu 2
\fBaccess\-key\fP (\fIstr\fP) Environment variable for the
access key (Required for binding\-type
amazon\-web\-services)
.IP \(bu 2
\fBsecret\-key\fP (\fIstr\fP) Environment variable for the
access secret key (Required for binding\-type
amazon\-web\-services)
.IP \(bu 2
\fBkey\-file\-variable\fP (\fIstr\fP) Environment variable
to be set to the temporary path of the SSH key
file during the build.
.IP \(bu 2
\fBusername\-variable\fP (\fIstr\fP) Environment variable
to be set to the username during
the build. (optional)
.IP \(bu 2
\fBpassphrase\-variable\fP (\fIstr\fP) Environment
variable to be set to the password
during the build. (optional)
.IP \(bu 2
\fBkeystore\-variable\fP (\fIstr\fP) Environment
variable to be set to the temporary
keystore location during the build.
.IP \(bu 2
\fBpassword\-variable\fP (\fIstr\fP) Environment
variable to be set to the password
during the build.
.IP \(bu 2
\fBalias\-variable\fP (\fIstr\fP) Environment variable
to be set to the keystore alias name
of the certificate during the build.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
 \- credentials\-binding:
     \- zip\-file:
        credential\-id: b3e6f337\-5d44\-4f57\-921c\-1632d796caa6
        variable: CONFIG_ZIP
     \- file:
        credential\-id: b3e6f337\-5d44\-4f57\-921c\-1632d796caab
        variable: config_file
     \- username\-password:
        credential\-id: b3e6f337\-5d44\-4f57\-921c\-1632d796caac
        variable: config_username_password
     \- text:
        credential\-id: b3e6f337\-5d44\-4f57\-921c\-1632d796caad
        variable: config_text
     \- docker\-server\-creds\-binding:
        credential\-id: b3e6f337\-5d44\-4f57\-921c\-1632d796caae
        variable: config_docker_server
 \- credentials\-binding:
     \- username\-password\-separated:
        credential\-id: b3e6f337\-5d44\-4f57\-921c\-1632d796caag
        username: myUsername
        password: myPassword
 \- credentials\-binding:
     \- amazon\-web\-services:
        credential\-id: b3e6f337\-5d44\-4f57\-921c\-1632d796caaf
        access\-key: AWS_ACCESS_KEY_ID
        secret\-key: AWS_SECRET_ACCESS_KEY
 \- credentials\-binding:
     \- ssh\-user\-private\-key:
        credential\-id: b3e6f337\-5d44\-4f57\-921c\-1632d796caah
        key\-file\-variable: KEY_FILE_VARIABLE
        username\-variable: USER_NAME_VARIABLE
        passphrase\-variable: PASSPHRASE_VARIABLE
 \- credentials\-binding:
     \- cert\-multi\-binding:
        credential\-id: b3e6f337\-5d44\-4f57\-921c\-1632d796caaj
        keystore\-variable: KEYSTORE_VARIABLE
        password\-variable: PASSWORD_VARIABLE
        alias\-variable: ALIAS_VARIABLE

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B custom\-tools()
Requires the Jenkins \fI\%Custom Tools Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBtools\fP (\fIlist\fP) \-\- List of custom tools to add
(optional)
.IP \(bu 2
\fBskip\-master\-install\fP (\fIbool\fP) \-\- skips the install in top level matrix job
(default \(aqfalse\(aq)
.IP \(bu 2
\fBconvert\-homes\-to\-upper\fP (\fIbool\fP) \-\- Converts the home env vars to uppercase
(default \(aqfalse\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- custom\-tools:
      tools:
      \- my_custom_tool
      skip\-master\-install: true
      convert\-homes\-to\-upper: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B delivery\-pipeline()
If enabled the job will create a version based on the template.
The version will be set to the environment variable PIPELINE_VERSION and
will also be set in the downstream jobs.
.sp
Requires the Jenkins \fI\%Delivery Pipeline Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBversion\-template\fP (\fIstr\fP) \-\- Template for generated version e.g
1.0.${BUILD_NUMBER} (default \(aq\(aq)
.IP \(bu 2
\fBset\-display\-name\fP (\fIbool\fP) \-\- Set the generated version as the display name
for the build (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- delivery\-pipeline

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- delivery\-pipeline:
        version\-template: 1.0.0\-${BUILD_NUMBER}
        set\-display\-name: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B docker\-custom\-build\-env()
Allows the definition of a build environment for a job using a Docker
container.
.sp
Requires the Jenkins \fI\%CloudBees Docker Custom Build
Environment Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBimage\-type\fP (\fIstr\fP) \-\- Docker image type. Valid values and their
additional attributes described in the \fI\%image_types\fP table
.IP \(bu 2
\fBdocker\-tool\fP (\fIstr\fP) \-\- The name of the docker installation to use
(default \(aqDefault\(aq)
.IP \(bu 2
\fBhost\fP (\fIstr\fP) \-\- URI to the docker host you are using
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- Argument to specify the ID of credentials to use
for docker host (optional)
.IP \(bu 2
\fBregistry\-credentials\-id\fP (\fIstr\fP) \-\- Argument to specify the ID of
credentials to use for docker registry (optional)
.IP \(bu 2
\fBvolumes\fP (\fIlist\fP) \-\- 
.sp
Volumes to bind mound from slave host into container
.INDENT 2.0
.TP
.B volume
.INDENT 7.0
.IP \(bu 2
\fBhost\-path\fP (\fIstr\fP) Path on host
.IP \(bu 2
\fBpath\fP (\fIstr\fP) Path inside container
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBverbose\fP (\fIbool\fP) \-\- Log docker commands executed by plugin on build log
(default false)
.IP \(bu 2
\fBprivileged\fP (\fIbool\fP) \-\- Run in privileged mode (default false)
.IP \(bu 2
\fBforce\-pull\fP (\fIbool\fP) \-\- Force pull (default false)
.IP \(bu 2
\fBgroup\fP (\fIstr\fP) \-\- The user to run build has to be the same as the Jenkins
slave user so files created in workspace have adequate owner and
permission set
.IP \(bu 2
\fBcommand\fP (\fIstr\fP) \-\- Container start command (default \(aq/bin/cat\(aq)
.IP \(bu 2
\fBnet\fP (\fIstr\fP) \-\- Network bridge (default \(aqbridge\(aq)
.IP \(bu 2
\fBmemory\-limit\fP (\fIstr\fP) \-\- Configure the limit memory
constraint (default \(aq\(aq)
.IP \(bu 2
\fBcpu\-shares\fP (\fIstr\fP) \-\- Configure the CPU shares
constraint (default \(aq\(aq)
.UNINDENT
.UNINDENT
.TS
center;
|l|l|.
_
T{
Image Type
T}	T{
Description
T}
_
T{
dockerfile
T}	T{
Build docker image from a Dockerfile in project
workspace. With this option, project can define the
build environment as a Dockerfile stored in SCM with
project source code
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B context\-path
(str) Path to docker context
(default \(aq.\(aq)
.TP
.B dockerfile
(str) Use an alternate Dockerfile to
build the container hosting this build
(default \(aqDockerfile\(aq)
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
T{
pull
T}	T{
Pull specified docker image from Docker repository
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B image
(str) Image id/tag
.UNINDENT
.UNINDENT
.UNINDENT
T}
_
.TE
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- docker\-custom\-build\-env:
      image\-type: \(aqpull\(aq
      image: \(aqcentos:7\(aq
      force\-pull: true
      privileged: true
      verbose: true
      group: jenkins
      command: /bin/cat
      net: bridge
      memory\-limit: memory=L<inf, memory\-swap=inf
      cpu\-shares: 2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B env\-file()
Add or override environment variables to the whole build process.
.sp
Requires the Jenkins \fI\%Environment File Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBproperties\-file\fP (\fIstr\fP) \-\- path to the properties file (optional)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- env\-file:
      properties\-file: ${WORKSPACE}/foo
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B env\-script()
Add or override environment variables to the whole build process.
.sp
Requires the Jenkins \fI\%Environment Script Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBscript\-content\fP \-\- The script to run (default \(aq\(aq)
.IP \(bu 2
\fBscript\-type\fP (\fIstr\fP) \-\- 
.sp
The script type.
.INDENT 2.0
.TP
.B script\-types supported
.INDENT 7.0
.IP \(bu 2
\fBunix\-script\fP (default)
.IP \(bu 2
\fBpower\-shell\fP
.IP \(bu 2
\fBbatch\-script\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBonly\-run\-on\-parent\fP \-\- Only applicable for Matrix Jobs. If true, run only
on the matrix parent job (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- env\-script:
      script\-content: \(aqecho foo=bar\(aq
      only\-run\-on\-parent: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B exclusion()
Add a resource to use for critical sections to establish a mutex on. If
another job specifies the same resource, the second job will wait for the
blocked resource to become available.
.sp
Requires the Jenkins \fI\%Exclusion Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBresources\fP (\fIlist\fP) \-\- List of resources to add for exclusion
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- exclusion:
      resources:
          \- myresource1
          \- myresource2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B github\-pull\-request()
Set GitHub commit status with custom context and message.
.sp
Requires the Jenkins \fI\%GitHub Pull Request Builder Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBshow\-matrix\-status\fP (\fIbool\fP) \-\- Only post commit status of parent matrix job
(default false)
.IP \(bu 2
\fBstatus\-context\fP (\fIstr\fP) \-\- The context to include on PR status comments
(default \(aq\(aq)
.IP \(bu 2
\fBtriggered\-status\fP (\fIstr\fP) \-\- The status message to set when the build has
been triggered (default \(aq\(aq)
.IP \(bu 2
\fBstarted\-status\fP (\fIstr\fP) \-\- The status message to set when the build has
been started (default \(aq\(aq)
.IP \(bu 2
\fBstatus\-url\fP (\fIstr\fP) \-\- The status URL to set (default \(aq\(aq)
.IP \(bu 2
\fBstatus\-add\-test\-results\fP (\fIbool\fP) \-\- Add test result one\-liner to status
message (default false)
.IP \(bu 2
\fBstatuses\fP (\fIlist\fP) \-\- 
.sp
List of custom statuses on the commit for when a build
is completed
.INDENT 2.0
.TP
.B Status
.INDENT 7.0
.IP \(bu 2
\fBmessage\fP (\fIstr\fP) \-\- The message that is appended to a comment
when a build finishes with the desired build status. If no status
updates should be made when a build finishes with the indicated
build status, use \(dq\-\-none\-\-\(dq to alert the trigger. (required)
.IP \(bu 2
\fBresult\fP (\fIstr\fP) \-\- Build result. Can be one of \(aqSUCCESS\(aq,
\(aqERROR\(aq or \(aqFAILURE\(aq. (required)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- github\-pull\-request

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- github\-pull\-request:
      show\-matrix\-status: true
      status\-context: \(dqmy\-build\(dq
      triggered\-status: \(dqbuild was triggered\(dq
      started\-status: \(dqbuild was started\(dq
      status\-url: \(dqhttp://1.2.3.4\(dq
      status\-add\-test\-results: true
      statuses:
        \- message: \(dqbuild has succeeded\(dq
          result: SUCCESS
        \- message: \(dqbuild has failed\(dq
          result: ERROR

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B inject()
Add or override environment variables to the whole build process.
.sp
Requires the Jenkins \fI\%EnvInject Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBproperties\-file\fP (\fIstr\fP) \-\- path to the properties file (optional)
.IP \(bu 2
\fBproperties\-content\fP (\fIstr\fP) \-\- key value pair of properties (optional)
.IP \(bu 2
\fBscript\-file\fP (\fIstr\fP) \-\- path to the script file (optional)
.IP \(bu 2
\fBscript\-content\fP (\fIstr\fP) \-\- contents of a script (optional)
.IP \(bu 2
\fBload\-from\-master\fP (\fIbool\fP) \-\- load files from master (default false)
.IP \(bu 2
\fBgroovy\-script\fP (\fIstr\fP) \-\- contents of the groovy script (optional)
.IP \(bu 2
\fBgroovy\-sandbox\fP (\fIbool\fP) \-\- use groovy sandbox (default false)
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- inject

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- inject:
        properties\-file: example.prop full
        properties\-content: EXAMPLE=foo\-bar full
        script\-file: scriptfull.sh
        script\-content: test script content full
        groovy\-script: test groovy\-script location full
        groovy\-sandbox: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B inject\-ownership\-variables()
Inject ownership variables to the build as environment variables.
.sp
Requires the Jenkins \fI\%EnvInject Plugin\fP
and Jenkins \fI\%Ownership plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBjob\-variables\fP (\fIbool\fP) \-\- inject job ownership variables to the job
(default false)
.IP \(bu 2
\fBnode\-variables\fP (\fIbool\fP) \-\- inject node ownership variables to the job
(default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- inject\-ownership\-variables:
      job\-variables: true
      node\-variables: true

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B inject\-passwords()
Inject passwords to the build as environment variables.
.sp
Requires the Jenkins \fI\%EnvInject Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBglobal\fP (\fIbool\fP) \-\- inject global passwords to the job
.IP \(bu 2
\fBmask\-password\-params\fP (\fIbool\fP) \-\- mask password parameters
.IP \(bu 2
\fBjob\-passwords\fP (\fIlist\fP) \-\- 
.sp
key value pair of job passwords
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) Name of password
.IP \(bu 2
\fBpassword\fP (\fIstr\fP) Encrypted password
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- inject\-passwords:
        global: true
        mask\-password\-params: true
        job\-passwords:
            \- name: ADMIN
              password: 0v8ZCNaHwq1hcx+sHwRLdg9424uBh4Pin0zO4sBIb+U=

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B jclouds()
Uses JClouds to provide slave launching on most of the currently
usable Cloud infrastructures.
.sp
Requires the Jenkins \fI\%JClouds Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBsingle\-use\fP (\fIbool\fP) \-\- Whether or not to terminate the slave after use
(default false).
.IP \(bu 2
\fBinstances\fP (\fIlist\fP) \-\- The name of the jclouds template to create an
instance from, and its parameters.
.IP \(bu 2
\fBcloud\-name\fP (\fIstr\fP) \-\- The name of the jclouds profile containing the
specified template.
.IP \(bu 2
\fBcount\fP (\fIint\fP) \-\- How many instances to create (default 1).
.IP \(bu 2
\fBstop\-on\-terminate\fP (\fIbool\fP) \-\- Whether or not to suspend instead of terminate
the instance (default false).
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
 wrappers:
    \- jclouds:
        single\-use: True
        instances:
          \- jenkins\-dev\-slave:
              cloud\-name: mycloud1
              count: 1
              stop\-on\-terminate: True
          \- jenkins\-test\-slave:
              cloud\-name: mycloud2
              count: 2
              stop\-on\-terminate: False

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B job\-log\-logger()
Enable writing the job log to the underlying logging system.
.sp
Requires the Jenkins \fI\%Job Log Logger plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBsuppress\-empty\fP (\fIbool\fP) \-\- Suppress empty log messages (default true)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- job\-log\-logger:
      suppress\-empty: false

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B live\-screenshot()
Show live screenshots of running jobs in the job list.
.sp
Requires the Jenkins \fI\%Live\-Screenshot Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfull\-size\fP (\fIstr\fP) \-\- name of screenshot file (default \(aqscreenshot.png\(aq)
.IP \(bu 2
\fBthumbnail\fP (\fIstr\fP) \-\- name of thumbnail file (default \(aqscreenshot\-thumb.png\(aq)
.UNINDENT
.UNINDENT
.sp
File type must be .png and they must be located inside the $WORKDIR.
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- live\-screenshot:
        full\-size: my_screenshot.png
        thumbnail: my_screenshot\-thumb.png

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- live\-screenshot

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B locks()
Control parallel execution of jobs.
.sp
Requires the Jenkins \fI\%Locks and Latches Plugin\fP\&.
.INDENT 7.0
.TP
.B Arg
list of locks to use
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- locks:
        \- FOO
        \- FOO2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B logfilesize()
Abort the build if its logfile becomes too big.
.sp
Requires the Jenkins \fI\%Logfilesizechecker Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBset\-own\fP (\fIbool\fP) \-\- Use job specific maximum log size instead of global
config value (default false).
.IP \(bu 2
\fBfail\fP (\fIbool\fP) \-\- Make builds aborted by this wrapper be marked as \(dqfailed\(dq
(default false).
.IP \(bu 2
\fBsize\fP (\fIint\fP) \-\- Abort the build if logfile size is bigger than this
value (in MiB, default 128). Only applies if set\-own is true.
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- logfilesize:
      set\-own: true
      size: 1024
      fail: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- logfilesize

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B logstash build wrapper()
Dump the Jenkins console output to Logstash.
.sp
Requires the Jenkins \fI\%logstash plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBuse\-redis\fP \-\- Boolean to use Redis. (default true)
.IP \(bu 2
\fBredis\fP \-\- 
.sp
Redis config params
.INDENT 2.0
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBhost\fP (\fIstr\fP) Redis hostname        (default \(aqlocalhost\(aq)
.UNINDENT
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBport\fP (\fIint\fP) Redis port number (default 6397)
.UNINDENT
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBdatabase\-number\fP (\fIint\fP)        Redis database number (default 0)
.UNINDENT
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBdatabase\-password\fP (\fIstr\fP)        Redis database password (default \(aq\(aq)
.UNINDENT
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBdata\-type\fP (\fIstr\fP)        Redis database type (default \(aqlist\(aq)
.UNINDENT
.TP
.B Parameter
.INDENT 7.0
.IP \(bu 2
\fBkey\fP (\fIstr\fP) Redis key (default \(aqlogstash\(aq)
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- logstash:
      use\-redis: True
      redis:
        host: \(aqlocalhost\(aq
        port: 6379
        database\-number: 0
        database\-password: \(aqpassword\(aq
        data\-type: \(aqlist\(aq
        key: \(aqlogstash\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B m2\-repository\-cleanup()
Configure M2 Repository Cleanup.
.sp
Requires the Jenkins \fI\%M2 Repository Cleanup\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBpatterns\fP (\fIlist\fP) \-\- List of patterns for artifacts to cleanup before
building. (optional)
.UNINDENT
.sp
This plugin allows you to configure a maven2 job to clean some or all of
the artifacts from the repository before it runs.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- m2\-repository\-cleanup:
        patterns:
            \- com/ibm/**
            \- com/microsoft/**

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B mask\-passwords()
Hide passwords in the console log.
.sp
Requires the Jenkins \fI\%Mask Passwords Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- mask\-passwords
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B matrix\-tie\-parent()
Tie parent to a node.
.sp
Requires the Jenkins \fI\%Matrix Tie Parent Plugin\fP\&.
.sp
Note that from Jenkins version 1.532 this plugin\(aqs functionality is
available under the \(dqadvanced\(dq option of the matrix project configuration.
You can use the top level \fBnode\fP parameter to control where the parent
job is tied in Jenkins 1.532 and higher.
.INDENT 7.0
.TP
.B Parameters
\fBnode\fP (\fIstr\fP) \-\- Name of the node (required)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
project\-type: matrix
wrappers:
  \- matrix\-tie\-parent:
      node: Unix

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B maven\-release()
Wrapper for Maven projects
.sp
Requires the Jenkins \fI\%M2 Release Plugin\fP
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBrelease\-goals\fP (\fIstr\fP) \-\- Release goals and options (default \(aq\(aq)
.IP \(bu 2
\fBdry\-run\-goals\fP (\fIstr\fP) \-\- DryRun goals and options (default \(aq\(aq)
.IP \(bu 2
\fBnum\-successful\-builds\fP (\fIint\fP) \-\- Number of successful release builds to keep
(default 1)
.IP \(bu 2
\fBselect\-custom\-scm\-comment\-prefix\fP (\fIbool\fP) \-\- Preselect \(aqSpecify custom SCM
comment prefix\(aq (default false)
.IP \(bu 2
\fBselect\-append\-jenkins\-username\fP (\fIbool\fP) \-\- Preselect \(aqAppend Jenkins
Username\(aq (default false)
.IP \(bu 2
\fBselect\-scm\-credentials\fP (\fIbool\fP) \-\- Preselect \(aqSpecify SCM login/password\(aq
(default false)
.IP \(bu 2
\fBrelease\-env\-var\fP (\fIstr\fP) \-\- Release environment variable (default \(aq\(aq)
.IP \(bu 2
\fBscm\-user\-env\-var\fP (\fIstr\fP) \-\- SCM username environment variable (default \(aq\(aq)
.IP \(bu 2
\fBscm\-password\-env\-var\fP (\fIstr\fP) \-\- SCM password environment variable
(default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- maven\-release:
      release\-goals: \-Dresume=false release:prepare release:perform
      dry\-run\-goals: \-Dresume=false \-DdryRun=true release:prepare
      num\-successful\-builds: 1
      select\-custom\-scm\-comment\-prefix: false
      select\-append\-jenkins\-username: false
      select\-scm\-credentials: false
      release\-env\-var: IS_M2RELEASEBUILD
      scm\-user\-env\-var: SCM_USER

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B mongo\-db build wrapper()
Initializes a MongoDB database while running the build.
.sp
Requires the Jenkins \fI\%MongoDB plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- The name of the MongoDB install to use (required)
.IP \(bu 2
\fBdata\-directory\fP (\fIstr\fP) \-\- Data directory for the server (default \(aq\(aq)
.IP \(bu 2
\fBport\fP (\fIint\fP) \-\- Port for the server (default \(aq\(aq)
.IP \(bu 2
\fBstartup\-params\fP (\fIstr\fP) \-\- Startup parameters for the server (default \(aq\(aq)
.IP \(bu 2
\fBstart\-timeout\fP (\fIint\fP) \-\- How long to wait for the server to start in
milliseconds. 0 means no timeout. (default 0)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- mongo\-db:
      name: 2.4.6
      data\-directory: /var/tmp/mongo
      port: 5555
      startup\-params: \(dq\-\-bind_ip 127.0.0.1\(dq
      start\-timeout: 5000

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- mongo\-db:
      name: 2.4.6

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B nodejs\-installator()
Provides Jenkins integration for NodeJS & npm packages.
.sp
Requires the Jenkins \fI\%NodeJS Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBname\fP (\fIstr\fP) \-\- nodejs installation name (required)
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- nodejs\-installator:
      name: \(dqlatest node\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B openstack()
Provision slaves from OpenStack on demand.
.sp
Requires the Jenkins \fI\%Openstack Cloud Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinstances\fP (\fIlist\fP) \-\- 
.sp
List of instances to be launched at the beginning of
the build.
.INDENT 2.0
.TP
.B instances
.INDENT 7.0
.IP \(bu 2
\fBcloud\-name\fP (\fIstr\fP) \-\- The name of the cloud profile which
contains the specified cloud instance template (required).
.IP \(bu 2
\fBtemplate\-name\fP (\fIstr\fP) \-\- The name of the cloud instance
template to create an instance from(required).
.IP \(bu 2
\fBmanual\-template\fP (\fIbool\fP) \-\- If True, instance template name
will be put in \(aqSpecify Template Name as String\(aq option. Not
specifying or specifying False, instance template name will be
put in \(aqSelect Template from List\(aq option. To use parameter
replacement, set this to True.  (default false)
.IP \(bu 2
\fBcount\fP (\fIint\fP) \-\- How many instances to create (default 1).
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBsingle\-use\fP (\fIbool\fP) \-\- Whether or not to terminate the slave after use
(default false).
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- openstack:
      instances:
        \- cloud\-name: mycloud1
          template\-name: jenkins\-dev\-slave
          count: 1
        \- cloud\-name: mycloud2
          template\-name: jenkins\-test\-slave
          manual\-template: True
          count: 2
      single\-use: True

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pathignore()
This plugin allows SCM\-triggered jobs to ignore
build requests if only certain paths have changed.
.sp
Requires the Jenkins \fI\%Pathignore Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBignored\fP (\fIstr\fP) \-\- A set of patterns to define ignored changes
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- pathignore:
      ignored: \(dqdocs, tests\(dq
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B port\-allocator()
Assign unique TCP port numbers.
.sp
Requires the Jenkins \fI\%Port Allocator Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBname\fP (\fIstr\fP) \-\- Deprecated, use names instead
.IP \(bu 2
\fBnames\fP (\fIlist\fP) \-\- Variable list of names of the port or list of
specific port numbers
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- port\-allocator:
        names:
            \- SERVER_PORT
            \- SERVER_PORT2

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B pre\-scm\-buildstep()
Execute a Build Step before running the SCM.
.sp
Requires the Jenkins \fI\%Pre SCM BuildStep\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfailOnError\fP (\fIstr\fP) \-\- Specifies if the job should fail on error
(plugin >= 0.3) (default false).
.IP \(bu 2
\fBbuildsteps\fP (\fIlist\fP) \-\- 
.sp
List of build steps to execute
.INDENT 2.0
.TP
.B Buildstep
Any acceptable builder, as seen in the example
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- pre\-scm\-buildstep:
      failOnError: true
      buildsteps:
        \- shell: |
            #!/bin/bash
            echo \(dqDoing something cool\(dq
        \- shell: |
            #!/bin/zsh
            echo \(dqDoing something cool with zsh\(dq
        \- ant: \(dqtarget1 target2\(dq
          ant\-name: \(dqStandard Ant\(dq
        \- inject:
             properties\-file: example.prop
             properties\-content: EXAMPLE=foo\-bar

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B rbenv()
Set the rbenv implementation.
.sp
Requires the Jenkins \fI\%rbenv plugin\fP\&.
.sp
All parameters are optional.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBruby\-version\fP (\fIstr\fP) \-\- Version of Ruby to use  (default 1.9.3\-p484)
.IP \(bu 2
\fBignore\-local\-version\fP (\fIbool\fP) \-\- If true, ignore local Ruby
version (defined in the \(dq.ruby\-version\(dq file in workspace) even if it
has been defined  (default false)
.IP \(bu 2
\fBpreinstall\-gem\-list\fP (\fIstr\fP) \-\- List of gems to install
(default \(aqbundler,rake\(aq)
.IP \(bu 2
\fBrbenv\-root\fP (\fIstr\fP) \-\- RBENV_ROOT  (default $HOME/.rbenv)
.IP \(bu 2
\fBrbenv\-repo\fP (\fIstr\fP) \-\- Which repo to clone rbenv from
(default \fI\%https://github.com/rbenv/rbenv\fP)
.IP \(bu 2
\fBrbenv\-branch\fP (\fIstr\fP) \-\- Which branch to clone rbenv from  (default master)
.IP \(bu 2
\fBruby\-build\-repo\fP (\fIstr\fP) \-\- Which repo to clone ruby\-build from
(default \fI\%https://github.com/rbenv/ruby\-build\fP)
.IP \(bu 2
\fBruby\-build\-branch\fP (\fIstr\fP) \-\- Which branch to clone ruby\-build from
(default master)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- rbenv:
      ruby\-version: 2.0.0\-p353
      ignore\-local\-version: false
      preinstall\-gem\-list: \(dqbundler,rake\(dq
      rbenv\-root: \(dq$HOME/.rbenv\(dq
      rbenv\-repo: \(dqhttps://github.com/sstephenson/rbenv.git\(dq
      rbenv\-branch: \(dqmaster\(dq
      ruby\-build\-repo: \(dqhttps://github.com/sstephenson/ruby\-build.git\(dq
      ruby\-build\-branch: \(dqmaster\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B release()
Add release build configuration.
.sp
Requires the Jenkins \fI\%Release Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBkeep\-forever\fP (\fIbool\fP) \-\- Keep build forever (default true)
.IP \(bu 2
\fBoverride\-build\-parameters\fP (\fIbool\fP) \-\- Enable build\-parameter override
(default false)
.IP \(bu 2
\fBversion\-template\fP (\fIstr\fP) \-\- Release version template (default \(aq\(aq)
.IP \(bu 2
\fBparameters\fP (\fIlist\fP) \-\- Release parameters (see the \fI\%Parameters\fP module)
.IP \(bu 2
\fBpre\-build\fP (\fIlist\fP) \-\- Pre\-build steps (see the \fI\%Builders\fP module)
.IP \(bu 2
\fBpost\-build\fP (\fIlist\fP) \-\- Post\-build steps (see \fI\%Builders\fP)
.IP \(bu 2
\fBpost\-success\fP (\fIlist\fP) \-\- Post successful\-build steps (see \fI\%Builders\fP)
.IP \(bu 2
\fBpost\-failed\fP (\fIlist\fP) \-\- Post failed\-build steps (see \fI\%Builders\fP)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- release:
      keep\-forever: false
      parameters:
          \- string:
              name: RELEASE_BRANCH
              default: \(aq\(aq
              description: Git branch to release from.
          \- bool:
              name: FOO
              default: false
              description: \(dqA parameter named FOO, defaults to \(aqfalse\(aq.\(dq
      post\-success:
          \- shell: |
              #!/bin/bash
              copy_build_artefacts.sh

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B rvm\-env()
Set the RVM implementation.
.sp
Requires the Jenkins \fI\%Rvm Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBimplementation\fP (\fIstr\fP) \-\- Type of implementation. Syntax is RUBY[@GEMSET],
such as \(aq1.9.3\(aq or \fI\%\(aqjruby@foo\fP\(aq.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- rvm\-env:
      implementation: 1.9.3
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sauce\-ondemand()
Allows you to integrate Sauce OnDemand with Jenkins.  You can
automate the setup and tear down of Sauce Connect and integrate
the Sauce OnDemand results videos per test.
.sp
Requires the Jenkins \fI\%Sauce OnDemand Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBenable\-sauce\-connect\fP (\fIbool\fP) \-\- launches a SSH tunnel from their cloud
to your private network (default false)
.IP \(bu 2
\fBsauce\-host\fP (\fIstr\fP) \-\- The name of the selenium host to be used.  For
tests run using Sauce Connect, this should be localhost.
ondemand.saucelabs.com can also be used to connect directly to
Sauce OnDemand,  The value of the host will be stored in the
SAUCE_ONDEMAND_HOST environment variable.  (default \(aq\(aq)
.IP \(bu 2
\fBsauce\-port\fP (\fIstr\fP) \-\- The name of the Selenium Port to be used.  For
tests run using Sauce Connect, this should be 4445.  If using
ondemand.saucelabs.com for the Selenium Host, then use 4444.
The value of the port will be stored in the SAUCE_ONDEMAND_PORT
environment variable.  (default \(aq\(aq)
.IP \(bu 2
\fBoverride\-username\fP (\fIstr\fP) \-\- If set then api\-access\-key must be set.
Overrides the username from the global config. (default \(aq\(aq)
.IP \(bu 2
\fBoverride\-api\-access\-key\fP (\fIstr\fP) \-\- If set then username must be set.
Overrides the api\-access\-key set in the global config. (default \(aq\(aq)
.IP \(bu 2
\fBstarting\-url\fP (\fIstr\fP) \-\- The value set here will be stored in the
SELENIUM_STARTING_ULR environment variable.  Only used when type
is selenium. (default \(aq\(aq)
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- 
.sp
Type of test to run (default selenium)
.INDENT 2.0
.TP
.B type values
.INDENT 7.0
.IP \(bu 2
\fBselenium\fP
.IP \(bu 2
\fBwebdriver\fP
.UNINDENT
.UNINDENT

.IP \(bu 2
\fBplatforms\fP (\fIlist\fP) \-\- The platforms to run the tests on.  Platforms
supported are dynamically retrieved from sauce labs.  The format of
the values has only the first letter capitalized, no spaces, underscore
between os and version, underscore in internet_explorer, everything
else is run together.  If there are not multiple version of the browser
then just the first version number is used.
Examples: Mac_10.8iphone5.1 or Windows_2003firefox10
or Windows_2012internet_explorer10 (default \(aq\(aq)
.IP \(bu 2
\fBlaunch\-sauce\-connect\-on\-slave\fP (\fIbool\fP) \-\- Whether to launch sauce connect
on the slave. (default false)
.IP \(bu 2
\fBhttps\-protocol\fP (\fIstr\fP) \-\- The https protocol to use (default \(aq\(aq)
.IP \(bu 2
\fBsauce\-connect\-options\fP (\fIstr\fP) \-\- Options to pass to sauce connect
(default \(aq\(aq)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- sauce\-ondemand:
      enable\-sauce\-connect: true
      sauce\-host: foo
      sauce\-port: 8080
      override\-username: foo
      override\-api\-access\-key: 123lkj123kh123l;k12323
      type: webdriver
      platforms:
        \- Linuxandroid4
        \- Linuxfirefox10
        \- Linuxfirefox11
      launch\-sauce\-connect\-on\-slave: true
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B sonar()
Wrapper for SonarQube Plugin.
.sp
Requires \fI\%SonarQube plugin\fP
.INDENT 7.0
.TP
.B Parameters
\fBinstall\-name\fP (\fIstr\fP) \-\- Release goals and options (default \(aq\(aq)
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- sonar

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- sonar:
      install\-name: test\-sonar\-installation

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B ssh\-agent\-credentials()
Sets up the user for the ssh agent plugin for jenkins.
.sp
Requires the Jenkins \fI\%SSH\-Agent Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBusers\fP (\fIlist\fP) \-\- A list of Jenkins users credential IDs (required)
.IP \(bu 2
\fBuser\fP (\fIstr\fP) \-\- The user id of the jenkins user credentials (deprecated)
.IP \(bu 2
\fBignore\-missing\-credentials\fP (\fIbool\fP) \-\- Specifies the option to ignore
missing credentials (default false)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- ssh\-agent\-credentials:
        users:
            \- \(aq44747833\-247a\-407a\-a98f\-a5a2d785111c\(aq
            \- \(aqf1c0f777\-7ac6\-43fd\-b5c7\-68b420aa1392\(aq
            \- \(aqdd647a01\-be21\-402b\-bfc5\-a4e89be7d0c4\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
if both \fBusers\fP and \fBuser\fP parameters specified, \fBusers\fP will be
preferred, \fBuser\fP will be ignored.
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
    \- ssh\-agent\-credentials:
        user: \(aq49d20745\-9889\-4c02\-b286\-fc6fb89c36bd\(aq
        users:
            \- \(aq44747833\-247a\-407a\-a98f\-a5a2d785111c\(aq
            \- \(aqdd647a01\-be21\-402b\-bfc5\-a4e89be7d0c4\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The \fBusers\fP with one value in list equals to the \fBuser\fP\&. In this
case old style XML will be generated. Use this format if you use
SSH\-Agent plugin < 1.5.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- ssh\-agent\-credentials:
      users:
          \- \(aq49d20745\-9889\-4c02\-b286\-fc6fb89c36bd\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
equals to:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- ssh\-agent\-credentials:
      user: \(aq49d20745\-9889\-4c02\-b286\-fc6fb89c36bd\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B timeout()
Abort the build if it runs too long.
.sp
Requires the Jenkins \fI\%Build Timeout Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBfail\fP (\fIbool\fP) \-\- Mark the build as failed (default false)
.IP \(bu 2
\fBabort\fP (\fIbool\fP) \-\- Mark the build as aborted (default false)
.IP \(bu 2
\fBabort\-and\-restart\fP (\fIbool\fP) \-\- Mark the build as aborted, then restart.
Count of restarts can be set via \fImax\-restarts\fP
(default false) (Version >= 1.17).
.IP \(bu 2
\fBwrite\-description\fP (\fIbool\fP) \-\- Write a message in the description
(default false)
.IP \(bu 2
\fBmax\-restarts\fP (\fIint\fP) \-\- Count of maximum restarts.
0 means without a limit (default 0) (Version >= 1.17).
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \-\- Abort the build after this number of minutes (default 3)
.IP \(bu 2
\fBtimeout\-var\fP (\fIstr\fP) \-\- Export an environment variable to reference the
timeout value (optional)
.IP \(bu 2
\fBtype\fP (\fIstr\fP) \-\- Timeout type to use (default absolute)
.IP \(bu 2
\fBelastic\-percentage\fP (\fIint\fP) \-\- Percentage of the three most recent builds
where to declare a timeout, only applies to \fBelastic\fP type.
(default 0)
.IP \(bu 2
\fBelastic\-number\-builds\fP (\fIint\fP) \-\- Number of builds to consider computing
average duration, only applies to \fBelastic\fP type. (default 3)
.IP \(bu 2
\fBelastic\-default\-timeout\fP (\fIint\fP) \-\- Timeout to use if there were no previous
builds, only applies to \fBelastic\fP type. (default 3)
.IP \(bu 2
\fBdeadline\-time\fP (\fIstr\fP) \-\- Build terminate automatically at next deadline time
(HH:MM:SS), only applies to \fBdeadline\fP type. (default 0:00:00)
.IP \(bu 2
\fBdeadline\-tolerance\fP (\fIint\fP) \-\- Period in minutes after deadline when a job
should be immediately aborted, only applies to \fBdeadline\fP type.
(default 1)
.UNINDENT
.UNINDENT
.sp
Example (Version < 1.14):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- timeout:
      timeout: 90
      timeout\-var: \(aqBUILD_TIMEOUT\(aq
      fail: true
      type: absolute

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- timeout:
      fail: false
      type: likely\-stuck

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
 wrappers:
    \- timeout:
        timeout\-var: \(aqBUILD_TIMEOUT\(aq
        fail: true
        elastic\-percentage: 150
        elastic\-default\-timeout: 90
        type: elastic

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Example (Version >= 1.14):
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- timeout:
      timeout: 90
      timeout\-var: \(aqBUILD_TIMEOUT\(aq
      fail: true
      type: absolute

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- timeout:
      timeout: 5
      timeout\-var: \(aqBUILD_TIMEOUT\(aq
      type: no\-activity
      abort: true
      write\-description: \(dqBlah Blah Blah\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- timeout:
      timeout: 90
      timeout\-var: \(aqBUILD_TIMEOUT\(aq
      abort: true
      type: likely\-stuck

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- timeout:
      elastic\-percentage: 150
      elastic\-default\-timeout: 3
      elastic\-number\-builds: 14
      timeout\-var: \(aqBUILD_TIMEOUT\(aq
      abort: true
      type: elastic

.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
 wrappers:
    \- timeout:
        deadline\-time: \(aq0:00:00\(aq
        deadline\-tolerance: 1
        timeout\-var: \(aqBUILD_TIMEOUT\(aq
        type: deadline

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B timestamps()
Add timestamps to the console log.
.sp
Requires the Jenkins \fI\%Timestamper Plugin\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- timestamps
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B vault\-secrets()
Inject environment variables from a HashiCorp Vault secret.
.sp
Secrets are generally masked in the build log.
.sp
Requires the Jenkins \fI\%HashiCorp Vault Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvault\-url\fP (\fIstr\fP) \-\- Vault URL
.IP \(bu 2
\fBcredentials\-id\fP (\fIstr\fP) \-\- Vault Credential
.IP \(bu 2
\fBengine\-version\fP (\fIstr\fP) \-\- Vault K/V Engine version
.IP \(bu 2
\fBfail\-if\-not\-found\fP (\fIbool\fP) \-\- Fail if the secret path is not found
.IP \(bu 2
\fBskip\-ssl\-verification\fP (\fIbool\fP) \-\- Skip verification of SSL certs
.IP \(bu 2
\fBsecrets\fP (\fIlist\fP) \-\- 
.sp
List of secrets
.INDENT 2.0
.TP
.B secrets
.INDENT 7.0
.IP \(bu 2
\fBsecret\-path\fP (\fIstr\fP) \-\-
The path of the secret in the vault server
.IP \(bu 2
\fBengine\-version\fP (\fIstr\fP) \-\-
Vault K/V Engine version
.UNINDENT
.INDENT 7.0
.TP
.B secret\-values
.INDENT 7.0
.IP \(bu 2
\fBsecret\-values\fP (\fIlist\fP) \-\- List of key / value pairs
.INDENT 2.0
.IP \(bu 2
\fBenv\-var\fP (\fIstr\fP) \-\-
The environment variable to set with the value of the
vault key
.IP \(bu 2
\fBvault\-key\fP (\fIstr\fP) \-\- The vault key whose value with
populate the environment variable
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT

.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- vault\-secrets:
      vault\-url: \(aqhttp://127.0.0.1:8200\(aq
      credentials\-id: \(aqmyCredentials\(aq
      secrets:
        \- secret\-path: \(aqsecret/my\-token\(aq
          secret\-values:
            \- env\-var: \(aqTOKEN\(aq
              vault\-key: \(aqtoken\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- vault\-secrets:
      vault\-url: \(aqhttp://127.0.0.1:8200\(aq
      credentials\-id: \(aqmyCredentials\(aq
      fail\-if\-not\-found: \(aqfalse\(aq
      skip\-ssl\-verification: \(aqtrue\(aq
      engine\-version: \(aq2\(aq
      secrets:
        \- secret\-path: \(aqsecret/my\-secret\(aq
          secret\-values:
            \- env\-var: \(aqUSERNAME\(aq
              vault\-key: \(aqusername\(aq
            \- env\-var: \(aqPASSWORD\(aq
              vault\-key: \(aqpassword\(aq
        \- secret\-path: \(aqsecret/my\-secret2\(aq
          engine\-version: \(aq2\(aq
          secret\-values:
            \- env\-var: \(aqUSERNAME2\(aq
              vault\-key: \(aqusername2\(aq
            \- env\-var: \(aqPASSWORD2\(aq
              vault\-key: \(aqpassword2\(aq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B version\-number()
Generate a version number for the build using a format string. See the
wiki page for more detailed descriptions of options.
.sp
Requires the Jenkins \fI\%Version number plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBvariable\-name\fP (\fIstr\fP) \-\- Name of environment variable to assign version
number to (required)
.IP \(bu 2
\fBformat\-string\fP (\fIstr\fP) \-\- Format string used to generate version number
(required)
.IP \(bu 2
\fBprefix\-variable\fP (\fIstr\fP) \-\- Variable that contains version number prefix
(optional)
.IP \(bu 2
\fBskip\-failed\-builds\fP (\fIbool\fP) \-\- If the build fails, DO NOT increment any
auto\-incrementing component of the version number (default: false)
.IP \(bu 2
\fBdisplay\-name\fP (\fIbool\fP) \-\- Use the version number for the build display
name (default: false)
.IP \(bu 2
\fBstart\-date\fP (\fIstr\fP) \-\- The date the project began as a UTC timestamp
(default 1970\-1\-1 00:00:00.0 UTC)
.IP \(bu 2
\fBbuilds\-today\fP (\fIint\fP) \-\- The number of builds that have been executed
today (optional)
.IP \(bu 2
\fBbuilds\-this\-month\fP (\fIint\fP) \-\- The number of builds that have been executed
since the start of the month (optional)
.IP \(bu 2
\fBbuilds\-this\-year\fP (\fIint\fP) \-\- The number of builds that have been executed
since the start of the year (optional)
.IP \(bu 2
\fBbuilds\-all\-time\fP (\fIint\fP) \-\- The number of builds that have been executed
since the start of the project (optional)
.UNINDENT
.UNINDENT
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- version\-number:
      variable\-name: relVersion
      prefix\-variable: relVersion
      format\-string: ${BUILD_DATE_FORMATTED, \(dqyy.M\(dq}.${BUILDS_THIS_MONTH_Z}

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B workspace\-cleanup (pre\-build)()
Requires the Jenkins \fI\%Workspace Cleanup Plugin\fP\&.
.sp
The post\-build workspace\-cleanup is available as a publisher.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinclude\fP (\fIlist\fP) \-\- list of files to be included
.IP \(bu 2
\fBexclude\fP (\fIlist\fP) \-\- list of files to be excluded
.IP \(bu 2
\fBdirmatch\fP (\fIbool\fP) \-\- Apply pattern to directories too (default false)
.IP \(bu 2
\fBcheck\-parameter\fP (\fIstr\fP) \-\- boolean environment variable to check to
determine whether to actually clean up
.IP \(bu 2
\fBexternal\-deletion\-command\fP (\fIstr\fP) \-\- external deletion command to run
against files and directories
.IP \(bu 2
\fBdisable\-deferred\-wipeout\fP (\fIbool\fP) \-\- Disable improved deferred wipeout
method (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- workspace\-cleanup:
      include:
        \- \(dq_generated.py\(dq
      exclude:
        \- \(dq*.py\(dq
      dirmatch: true
      check\-parameter: \(dqDO_WS_CLEANUP\(dq
      external\-deletion\-command: \(dqshred \-u %s\(dq
      disable\-deferred\-wipeout: true

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- workspace\-cleanup

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B xvfb()
Enable xvfb during the build.
.sp
Requires the Jenkins \fI\%Xvfb Plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBinstallation\-name\fP (\fIstr\fP) \-\- The name of the Xvfb tool installation (default
\(aqdefault\(aq)
.IP \(bu 2
\fBauto\-display\-name\fP (\fIbool\fP) \-\- Uses the \-displayfd option of Xvfb by which it
chooses it\(aqs own display name (default false)
.IP \(bu 2
\fBdisplay\-name\fP (\fIstr\fP) \-\- Ordinal of the display Xvfb will be running on, if
left empty chosen based on current build executor number (default \(aq\(aq)
.IP \(bu 2
\fBassigned\-labels\fP (\fIstr\fP) \-\- If you want to start Xvfb only on specific nodes
specify its name or label (default \(aq\(aq)
.IP \(bu 2
\fBparallel\-build\fP (\fIbool\fP) \-\- When running multiple Jenkins nodes on the same
machine this setting influences the display number generation (default
false)
.IP \(bu 2
\fBtimeout\fP (\fIint\fP) \-\- A timeout of given seconds to wait before returning
control to the job (default 0)
.IP \(bu 2
\fBscreen\fP (\fIstr\fP) \-\- Resolution and color depth. (default \(aq1024x768x24\(aq)
.IP \(bu 2
\fBdisplay\-name\-offset\fP (\fIint\fP) \-\- Offset for display names. (default 1)
.IP \(bu 2
\fBadditional\-options\fP (\fIstr\fP) \-\- Additional options to be added with the
options above to the Xvfb command line (default \(aq\(aq)
.IP \(bu 2
\fBdebug\fP (\fIbool\fP) \-\- If Xvfb output should appear in console log of this job
(default false)
.IP \(bu 2
\fBshutdown\-with\-build\fP (\fIbool\fP) \-\- Should the display be kept until the whole
job ends (default false)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- xvfb:
      installation\-name: default
      auto\-display\-name: false
      display\-name: 123
      assigned\-labels: nodes\-xxx
      parallel\-build: false
      timeout: 10
      screen: 1024x768x16
      display\-name\-offset: 100
      additional\-options: \-fbdir /tmp
      debug: true
      shutdown\-with\-build: false

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- xvfb

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B xvnc()
Enable xvnc during the build.
.sp
Requires the Jenkins \fI\%xvnc plugin\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBscreenshot\fP (\fIbool\fP) \-\- Take screenshot upon build completion (default false)
.IP \(bu 2
\fBxauthority\fP (\fIbool\fP) \-\- Create a dedicated Xauthority file per build (default
true)
.UNINDENT
.UNINDENT
.sp
Full Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- xvnc:
      screenshot: true
      xauthority: false

.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Minimal Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
wrappers:
  \- xvnc

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Zuul
.sp
The Zuul module adds jobs parameters to manually run a build as Zuul would
have. It is entirely optional, Zuul 2.0+ pass the parameters over Gearman.
.INDENT 0.0
.TP
.B class  zuul.Zuul(registry)
.INDENT 7.0
.TP
.B handle_data(job_data)
This method is called before any XML is generated.  By
overriding this method, a module may arbitrarily modify a data
structure which will probably be the JJB YamlParser\(aqs intermediate data
representation. If it has changed the data structure at all, it must
return \fBTrue\fP, otherwise, it must return \fBFalse\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBjob_data\fP (\fIdict\fP) \-\- the intermediate representation of job data
loaded from JJB Yaml files without variables interpolation or other
yaml expansions.
.TP
.B Return type
bool
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  0
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B zuul()
Configure this job to be triggered by Zuul.
.sp
Adds parameters describing the change triggering the build such as the
branch name, change number and patchset.
.sp
See parameters \fI\%expected by Zuul\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- zuul
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B zuul\-post()
Configure this post\-merge job to be triggered by Zuul.
.sp
Adds parameters describing the reference update triggering the build, which
are the previous and next revisions in full (40 hexadecimal sha1) and short
form.
.sp
See parameters \fI\%expected by Zuul\fP\&.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
triggers:
  \- zuul\-post
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS Module Execution
.sp
The jenkins job builder modules are executed in sequence.
.INDENT 0.0
.TP
.B Generally the sequence is:
.INDENT 7.0
.IP 1. 3
parameters/properties
.IP 2. 3
scm
.IP 3. 3
triggers
.IP 4. 3
wrappers
.IP 5. 3
prebuilders (maven only, configured like \fI\%Builders\fP)
.IP 6. 3
builders (maven, freestyle, matrix, etc..)
.IP 7. 3
postbuilders (maven only, configured like \fI\%Builders\fP)
.IP 8. 3
publishers/reporters/notifications
.UNINDENT
.UNINDENT
.SH EXTENDING
.sp
Jenkins Job Builder is quite modular.  It is easy to add new
attributes to existing components, a new module to support a Jenkins
plugin, or include locally defined methods to deal with an
idiosyncratic build system.
.SS The Builder
.sp
The \fBBuilder\fP class manages Jenkins jobs. It\(aqs responsible for
creating/deleting/updating jobs and can be called from your application. You
can pass it a filename or an open file\-like object that represents your YAML
configuration. See the \fBjenkins_jobs/builder.py\fP file for more details.
.SS XML Processing
.sp
Most of the work of building XML from the YAML configuration file is
handled by individual functions that implement a single
characteristic.  For example, see the
\fBjenkins_jobs/modules/builders.py\fP file for the Python module that
implements the standard Jenkins builders.  The \fBshell\fP function at
the top of the file implements the standard \fIExecute a shell\fP build
step.  All of the YAML to XML functions in Jenkins Job Builder have
the same signature:
.INDENT 0.0
.TP
.B component(parser, xml_parent, data)
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the jenkins jobs YAML parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- this attribute\(aqs parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure for this attribute and below
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The function is expected to examine the YAML data structure and create
new XML nodes and attach them to the xml_parent element.  This general
pattern is applied throughout the included modules.
.SS Modules
.sp
Nearly all of Jenkins Job Builder is implemented in modules.  The main
program has no concept of builders, publishers, properties, or any
other aspects of job definition.  Each of those building blocks is
defined in a module, and due to the use of setuptools entry points,
most modules are easily extensible with new components.
.sp
To add a new module, define a class that inherits from
\fI\%jenkins_jobs.modules.base.Base\fP, and add it to the
\fBjenkins_jobs.modules\fP entry point in your setup.py.
.INDENT 0.0
.TP
.B class  jenkins_jobs.modules.base.Base(registry)
A base class for a Jenkins Job Builder Module.
.sp
The module is initialized before any YAML is parsed.
.INDENT 7.0
.TP
.B Parameters
\fBregistry\fP (\fI\%ModuleRegistry\fP) \-\- the global module registry.
.UNINDENT
.INDENT 7.0
.TP
.B component_list_type  =  None
The component list type will be used to look up possible
implementations of the component type via entry points (entry
points provide a list of components, so it should be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B component_type  =  None
The component type for components of this module.  This will be
used to look for macros (they are defined singularly, and should
not be plural).
Set both component_type and component_list_type to None if module
doesn\(aqt have components.
.UNINDENT
.INDENT 7.0
.TP
.B gen_xml(xml_parent, data)
Update the XML element tree based on YAML data.  Override
this method to add elements to the XML output.  Create new
Element objects and add them to the xml_parent.  The YAML data
structure must not be modified.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBdata\fP (\fIdict\fP) \-\- the YAML data structure
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B handle_data(job_data)
This method is called before any XML is generated.  By
overriding this method, a module may arbitrarily modify a data
structure which will probably be the JJB YamlParser\(aqs intermediate data
representation. If it has changed the data structure at all, it must
return \fBTrue\fP, otherwise, it must return \fBFalse\fP\&.
.INDENT 7.0
.TP
.B Parameters
\fBjob_data\fP (\fIdict\fP) \-\- the intermediate representation of job data
loaded from JJB Yaml files without variables interpolation or other
yaml expansions.
.TP
.B Return type
bool
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B sequence  =  10
The sequence number for the module.  Modules are invoked in the
order of their sequence number in order to produce consistently
ordered XML output.
.UNINDENT
.UNINDENT
.SS Components
.sp
Most of the standard modules supply a number of components, and it\(aqs
easy to provide your own components for use by those modules.  For
instance, the Builders module provides several builders, such as the
\fIshell\fP builder as well as the \fItrigger_builds\fP builder.  If you
wanted to add a new builder, all you need to do is write a function
that conforms to the \fI\%Component Interface\fP,
and then add that function to the appropriate entry point (via a
setup.py file).
.SS Module Registry
.sp
All modules and their associated components are registered in the
module registry. It can be accessed either from modules via the registry
field, or via the parser parameter of components.
.INDENT 0.0
.TP
.B class  jenkins_jobs.registry.ModuleRegistry(jjb_config, plugins_list=None)
.INDENT 7.0
.TP
.B dispatch(component_type, xml_parent, component, template_data={}, job_data=None)
This is a method that you can call from your implementation of
Base.gen_xml or component.  It allows modules to define a type
of component, and benefit from extensibility via Python
entry points and Jenkins Job Builder \fI\%Macros\fP\&.
.INDENT 7.0
.TP
.B Parameters
.INDENT 7.0
.IP \(bu 2
\fBcomponent_type\fP (\fIstr\fP) \-\- the name of the component
(e.g., \fIbuilder\fP)
.IP \(bu 2
\fBparser\fP (\fIYAMLParser\fP) \-\- the global YAML Parser
.IP \(bu 2
\fBxml_parent\fP (\fIElement\fP) \-\- the parent XML element
.IP \(bu 2
\fBcomponent\fP \-\- component definition
.IP \(bu 2
\fBtemplate_data\fP (\fIdict\fP) \-\- values that should be interpolated into
the component definition
.IP \(bu 2
\fBjob_data\fP (\fIdict\fP) \-\- full job definition
.UNINDENT
.UNINDENT
.sp
See \fI\%jenkins_jobs.modules.base.Base\fP for how to register
components of a module.
.sp
See the Publishers module for a simple example of how to use
this method.
.UNINDENT
.INDENT 7.0
.TP
.B get_plugin_info(plugin_name)
Provide information about plugins within a module\(aqs impl of Base.gen_xml.
.sp
The return value is a dictionary with data obtained directly from a
running Jenkins instance.
This allows module authors to differentiate generated XML output based
on information such as specific plugin versions.
.INDENT 7.0
.TP
.B Parameters
\fBplugin_name\fP (\fIstr\fP) \-\- Either the shortName or longName of a plugin
as see in a query that looks like:
\fBhttp://<jenkins\-hostname>/pluginManager/api/json?pretty&depth=2\fP
.UNINDENT
.sp
During a \(aqtest\(aq run, it is possible to override JJB\(aqs query to a live
Jenkins instance by passing it a path to a file containing a YAML list
of dictionaries that mimics the plugin properties you want your test
output to reflect:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
jenkins\-jobs test \-p /path/to/plugins\-info.yaml
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Below is example YAML that might be included in
/path/to/plugins\-info.yaml.
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\- longName: \(aqJenkins HipChat Plugin\(aq
  shortName: \(aqhipchat\(aq
  version: \(dq0.1.8\(dq

.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%Index\fP
.IP \(bu 2
\fI\%Module Index\fP
.IP \(bu 2
\fI\%Search Page\fP
.UNINDENT
.SH AUTHOR
Jenkins Job Builder Maintainers
.SH COPYRIGHT
2023, Jenkins Job Builder Maintainers
.\" Generated by docutils manpage writer.
.