Update Jenkins wiki -> plugins URLs
The Jenkins Wiki page is deprecated and Jenkins community is expected to migrate their documentation to plugins.jenkins.io URL. This patch updates all plugins that have a relevant plugins.jenkins.io URL documentation link. Change-Id: Iba7df7eada7b8ca0bb9aad93f5499ac6365a9293 Signed-off-by: Thanh Ha <zxiiro@gmail.com>
This commit is contained in:
Thanh Ha
parent
4424ab24c2
commit
29b8795753
|
|
@ -46,6 +46,7 @@ import jenkins_jobs.modules.helpers as helpers
|
|||
def builds_chain_fingerprinter(registry, xml_parent, data):
|
||||
"""yaml: builds-chain-fingerprinter
|
||||
Builds chain fingerprinter.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Builds chain fingerprinter Plugin
|
||||
<Builds+chain+fingerprinter>`.
|
||||
|
||||
|
|
@ -75,7 +76,8 @@ def builds_chain_fingerprinter(registry, xml_parent, data):
|
|||
def ownership(registry, xml_parent, data):
|
||||
"""yaml: ownership
|
||||
Plugin provides explicit ownership for jobs and slave nodes.
|
||||
Requires the Jenkins :jenkins-wiki:`Ownership Plugin <Ownership+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Ownership Plugin <ownership>`.
|
||||
|
||||
:arg bool enabled: whether ownership enabled (default : true)
|
||||
:arg str owner: the owner of job
|
||||
|
|
@ -107,8 +109,9 @@ def promoted_build(registry, xml_parent, data):
|
|||
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.
|
||||
Requires the Jenkins :jenkins-wiki:`Promoted Builds Plugin
|
||||
<Promoted+Builds+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Promoted Builds Plugin
|
||||
<promoted-builds>`.
|
||||
|
||||
:arg list names: the promoted build names (optional)
|
||||
|
||||
|
|
@ -130,7 +133,8 @@ def promoted_build(registry, xml_parent, data):
|
|||
def gitbucket(parser, xml_parent, data):
|
||||
"""yaml: gitbucket
|
||||
Integrate GitBucket to Jenkins.
|
||||
Requires the Jenkins :jenkins-wiki:`GitBucket Plugin <GitBucket+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`GitBucket Plugin <gitbucket>`.
|
||||
|
||||
:arg str url: GitBucket URL to issue (required)
|
||||
:arg bool link-enabled: Enable hyperlink to issue (default false)
|
||||
|
|
@ -186,7 +190,8 @@ def gitlab(registry, xml_parent, data):
|
|||
"""yaml: gitlab
|
||||
Sets the GitLab connection for the project. Configured via Jenkins Global
|
||||
Configuration.
|
||||
Requires the Jenkins :jenkins-wiki:`GitLab Plugin <GitLab+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`GitLab Plugin <gitlab-plugin>`.
|
||||
|
||||
:arg str connection: the GitLab connection name (required)
|
||||
|
||||
|
|
@ -206,8 +211,9 @@ def gitlab(registry, xml_parent, data):
|
|||
def gitlab_logo(registry, xml_parent, data):
|
||||
"""yaml: gitlab-logo
|
||||
Configures the GitLab-Logo Plugin.
|
||||
Requires the Jenkins :jenkins-wiki:`GitLab Logo Plugin
|
||||
<GitLab+Logo+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`GitLab Logo Plugin
|
||||
<gitlab-logo>`.
|
||||
|
||||
:arg str repository-name: the GitLab repository name (required)
|
||||
|
||||
|
|
@ -226,7 +232,8 @@ def gitlab_logo(registry, xml_parent, data):
|
|||
def disk_usage(registry, xml_parent, data):
|
||||
"""yaml: disk-usage
|
||||
Enables the Disk Usage Plugin.
|
||||
Requires the Jenkins :jenkins-wiki:`Disk Usage Plugin <Disk+Usage+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Disk Usage Plugin <disk-usage>`.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -239,7 +246,8 @@ def disk_usage(registry, xml_parent, data):
|
|||
def least_load(registry, xml_parent, data):
|
||||
"""yaml: least-load
|
||||
Enables the Least Load Plugin.
|
||||
Requires the Jenkins :jenkins-wiki:`Least Load Plugin <Least+Load+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Least Load Plugin <leastload>`.
|
||||
|
||||
:arg bool disabled: whether or not leastload is disabled (default true)
|
||||
|
||||
|
|
@ -259,8 +267,9 @@ def least_load(registry, xml_parent, data):
|
|||
def throttle(registry, xml_parent, data):
|
||||
"""yaml: throttle
|
||||
Throttles the number of builds for this job.
|
||||
Requires the Jenkins :jenkins-wiki:`Throttle Concurrent Builds Plugin
|
||||
<Throttle+Concurrent+Builds+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Throttle Concurrent Builds Plugin
|
||||
<throttle-concurrents>`.
|
||||
|
||||
:arg str option: throttle `project` (throttle the project alone)
|
||||
or `category` (throttle the project as part of one or more categories)
|
||||
|
|
@ -320,8 +329,8 @@ def throttle(registry, xml_parent, data):
|
|||
def branch_api(registry, xml_parent, data):
|
||||
"""yaml: branch-api
|
||||
Enforces a minimum time between builds based on the desired maximum rate.
|
||||
Requires the Jenkins :jenkins-wiki:`Branch API Plugin
|
||||
<Branch+API+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Branch API Plugin <branch-api>`.
|
||||
|
||||
:arg int number-of-builds: The maximum number of builds allowed within
|
||||
the specified time period. (default 1)
|
||||
|
|
@ -362,8 +371,7 @@ def branch_api(registry, xml_parent, data):
|
|||
def sidebar(registry, xml_parent, data):
|
||||
"""yaml: sidebar
|
||||
Allows you to add links in the sidebar.
|
||||
Requires the Jenkins :jenkins-wiki:`Sidebar-Link Plugin
|
||||
<Sidebar-Link+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Sidebar-Link Plugin <sidebar-link>`.
|
||||
|
||||
:arg str url: url to link to (optional)
|
||||
:arg str text: text for the link (optional)
|
||||
|
|
@ -390,7 +398,8 @@ def sidebar(registry, xml_parent, data):
|
|||
def inject(registry, xml_parent, data):
|
||||
"""yaml: inject
|
||||
Allows you to inject environment variables into the build.
|
||||
Requires the Jenkins :jenkins-wiki:`Env Inject Plugin <EnvInject+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`EnvInject Plugin <envinject>`.
|
||||
|
||||
:arg str properties-file: file to read with properties (optional)
|
||||
:arg str properties-content: key=value properties (optional)
|
||||
|
|
@ -569,8 +578,8 @@ def priority_sorter(registry, xml_parent, data):
|
|||
"""yaml: priority-sorter
|
||||
Allows simple ordering of builds, using a configurable job priority.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Priority Sorter Plugin
|
||||
<Priority+Sorter+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Priority Sorter Plugin
|
||||
<PrioritySorter>`.
|
||||
|
||||
:arg int priority: Priority of the job. Higher value means higher
|
||||
priority, with 3 as the default priority. (required)
|
||||
|
|
@ -615,8 +624,8 @@ def build_blocker(registry, xml_parent, data):
|
|||
if at least one name of currently running jobs
|
||||
is matching with one of the given regular expressions.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Build Blocker Plugin
|
||||
<Build+Blocker+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Build Blocker Plugin
|
||||
<build-blocker-plugin>`.
|
||||
|
||||
:arg bool use-build-blocker: Enable or disable build blocker (default true)
|
||||
:arg list blocking-jobs: One regular expression per line to select
|
||||
|
|
@ -668,8 +677,8 @@ def copyartifact(registry, xml_parent, data):
|
|||
Specify a list of projects that have access to copy the artifacts of
|
||||
this project.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Copy Artifact plugin
|
||||
<Copy+Artifact+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Copy Artifact plugin
|
||||
<copyartifact>`.
|
||||
|
||||
:arg str projects: comma separated list of projects that can copy
|
||||
artifacts of this project. Wild card character '*' is available.
|
||||
|
|
@ -704,7 +713,7 @@ def batch_tasks(registry, xml_parent, data):
|
|||
Batch tasks and builds "lock" the workspace, so when one of those
|
||||
activities is in progress, all the others will block in the queue.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Batch Task Plugin <Batch+Task+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Batch Task Plugin <batch-task>`.
|
||||
|
||||
:arg list batch-tasks: Batch tasks.
|
||||
|
||||
|
|
@ -731,7 +740,7 @@ def heavy_job(registry, xml_parent, data):
|
|||
This plugin allows you to define "weight" on each job,
|
||||
and making each job consume that many executors
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Heavy Job Plugin <Heavy+Job+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Heavy Job Plugin <heavy-job>`.
|
||||
|
||||
:arg int weight: Specify the total number of executors
|
||||
that this job should occupy (default 1)
|
||||
|
|
@ -754,8 +763,8 @@ def slave_utilization(registry, xml_parent, data):
|
|||
This plugin allows you to specify the percentage of a slave's capacity a
|
||||
job wants to use.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Slave Utilization Plugin
|
||||
<Slave+Utilization+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Slave Utilization Plugin
|
||||
<slave-utilization-plugin>`.
|
||||
|
||||
:arg int slave-percentage: Specify the percentage of a slave's execution
|
||||
slots that this job should occupy (default 0)
|
||||
|
|
@ -786,8 +795,8 @@ def slave_utilization(registry, xml_parent, data):
|
|||
|
||||
def delivery_pipeline(registry, xml_parent, data):
|
||||
"""yaml: delivery-pipeline
|
||||
Requires the Jenkins :jenkins-wiki:`Delivery Pipeline Plugin
|
||||
<Delivery+Pipeline+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Delivery Pipeline Plugin
|
||||
<delivery-pipeline-plugin>`.
|
||||
|
||||
:arg str stage: Name of the stage for this job (default '')
|
||||
:arg str task: Name of the task for this job (default '')
|
||||
|
|
@ -843,7 +852,7 @@ def zeromq_event(registry, xml_parent, data):
|
|||
|
||||
def slack(registry, xml_parent, data):
|
||||
"""yaml: slack
|
||||
Requires the Jenkins :jenkins-wiki:`Slack Plugin <Slack+Plugin>`
|
||||
Requires the Jenkins :jenkins-plugins:`Slack Plugin <slack>`.
|
||||
|
||||
When using Slack Plugin version < 2.0, Slack Plugin itself requires a
|
||||
publisher aswell as properties please note that you have to add the
|
||||
|
|
@ -920,7 +929,8 @@ def rebuild(registry, xml_parent, data):
|
|||
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.
|
||||
Requires the Jenkins :jenkins-wiki:`Rebuild Plugin <Rebuild+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Rebuild Plugin <rebuild>`.
|
||||
|
||||
:arg bool auto-rebuild: Rebuild without asking for parameters
|
||||
(default false)
|
||||
|
|
@ -985,8 +995,8 @@ def slave_prerequisites(registry, xml_parent, data):
|
|||
This plugin allows you to check prerequisites on slave before
|
||||
a job can run a build on it
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Slave Prerequisites Plugin
|
||||
<Slave+Prerequisites+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Slave Prerequisites Plugin
|
||||
<slave-prerequisites>`.
|
||||
|
||||
:arg str script: A script to be executed on slave node.
|
||||
If returning non 0 status, the node will be vetoed from hosting
|
||||
|
|
@ -1024,8 +1034,8 @@ def groovy_label(registry, xml_parent, data):
|
|||
This plugin allows you to use Groovy script to restrict where this project
|
||||
can be run.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Groovy Label Assignment Plugin
|
||||
<Groovy+Label+Assignment+plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Groovy Label Assignment Plugin
|
||||
<groovy-label-assignment>`.
|
||||
|
||||
Return value from Groovy script is treated as Label Expression.
|
||||
It is treated as followings:
|
||||
|
|
@ -1078,8 +1088,8 @@ def groovy_label(registry, xml_parent, data):
|
|||
|
||||
def lockable_resources(registry, xml_parent, data):
|
||||
"""yaml: lockable-resources
|
||||
Requires the Jenkins :jenkins-wiki:`Lockable Resources Plugin
|
||||
<Lockable+Resources+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Lockable Resources Plugin
|
||||
<lockable-resources>`.
|
||||
|
||||
:arg str resources: List of required resources, space separated.
|
||||
(required, mutual exclusive with label)
|
||||
|
|
@ -1138,7 +1148,7 @@ def lockable_resources(registry, xml_parent, data):
|
|||
|
||||
def docker_container(registry, xml_parent, data):
|
||||
"""yaml: docker-container
|
||||
Requires the Jenkins: :jenkins-wiki:`Docker Plugin<Docker+Plugin>`.
|
||||
Requires the Jenkins: :jenkins-plugins:`Docker Plugin <docker-plugin>`.
|
||||
|
||||
:arg str docker-registry-url: URL of the Docker registry. (default '')
|
||||
:arg str credentials-id: Credentials Id for the Docker registey.
|
||||
|
|
@ -1190,8 +1200,9 @@ def docker_container(registry, xml_parent, data):
|
|||
def disable_resume(registry, xml_parent, data):
|
||||
"""yaml: disable-resume
|
||||
Do not allow the pipeline to resume if the master restarts
|
||||
Requires the Jenkins :jenkins-wiki:`Pipeline Job Plugin
|
||||
<Pipeline+Job+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Pipeline Job Plugin
|
||||
<workflow-aggregator>`.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -1211,8 +1222,8 @@ def cachet_gating(registry, xml_parent, data):
|
|||
The Cachet Gating Plugin provides a gating mechanism
|
||||
based on the availability of resources.
|
||||
|
||||
Requires the Jenkins: :jenkins-wiki:`Cachet Gate Plugin
|
||||
<Cachet+Gate+Plugin>`.
|
||||
Requires the Jenkins: :jenkins-plugins:`Cachet Gate Plugin
|
||||
<cachet-gating>`.
|
||||
|
||||
:arg bool required-resources: Confirm availability of listed
|
||||
resources before building. Requires the list of resources to
|
||||
|
|
|
|||
|
|
@ -174,6 +174,7 @@ def archive(registry, xml_parent, data):
|
|||
def blame_upstream(registry, xml_parent, data):
|
||||
"""yaml: blame-upstream
|
||||
Notify upstream committers when build fails
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Blame upstream committers Plugin
|
||||
<Blame+Upstream+Committers+Plugin>`.
|
||||
|
||||
|
|
@ -1579,19 +1580,19 @@ def junit(registry, xml_parent, data):
|
|||
(default false)
|
||||
:arg bool test-stability: Add historical information about test
|
||||
results stability (default false).
|
||||
Requires the Jenkins :jenkins-wiki:`Test stability Plugin
|
||||
<Test+stability+plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Test stability Plugin
|
||||
<test-stability>`.
|
||||
:arg bool claim-build: Allow claiming of failed tests (default false)
|
||||
Requires the Jenkins :jenkins-wiki:`Claim Plugin <Claim+plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Claim Plugin <claim>`.
|
||||
:arg bool measurement-plots: Create measurement plots (default false)
|
||||
Requires the Jenkins :jenkins-wiki:`Measurement Plots Plugin
|
||||
<Measurement+Plots+Plugin>`.
|
||||
:arg bool flaky-test-reports: Publish flaky test reports (default false).
|
||||
Requires the Jenkins :jenkins-wiki:`Flaky Test Handler Plugin
|
||||
<Flaky+Test+Handler+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Flaky Test Handler Plugin
|
||||
<flaky-test-handler>`.
|
||||
:arg bool junit-attachments: Publish test attachments (default false).
|
||||
Requires the Jenkins :jenkins-wiki:`JUnit Attachments Plugin
|
||||
<JUnit+Attachments+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`JUnit Attachments Plugin
|
||||
<junit-attachments>`.
|
||||
|
||||
|
||||
Minimal example using defaults:
|
||||
|
|
@ -2689,6 +2690,7 @@ def aggregate_tests(registry, xml_parent, data):
|
|||
def aggregate_flow_tests(registry, xml_parent, data):
|
||||
"""yaml: aggregate-flow-tests
|
||||
Aggregate downstream test results in a Build Flow job.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Build Flow Test Aggregator Plugin
|
||||
<Build+Flow+Test+Aggregator+Plugin>`.
|
||||
|
||||
|
|
@ -2879,7 +2881,8 @@ def logparser(registry, xml_parent, data):
|
|||
|
||||
def copy_to_master(registry, xml_parent, data):
|
||||
"""yaml: copy-to-master
|
||||
Copy files to master from slave
|
||||
Copy files to master from slave.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Copy To Slave Plugin
|
||||
<Copy+To+Slave+Plugin>`.
|
||||
|
||||
|
|
@ -3220,8 +3223,8 @@ def sonar(registry, xml_parent, data):
|
|||
possible to provide a ConfigFileProvider settings file, see Example
|
||||
below. (optional)
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Config File Provider Plugin
|
||||
<Config+File+Provider+Plugin>`
|
||||
Requires the Jenkins :jenkins-plugins:`Config File Provider Plugin
|
||||
<config-file-provider>`
|
||||
for the Config File Provider "settings" and "global-settings" config.
|
||||
|
||||
This publisher supports the post-build action exposed by the Jenkins
|
||||
|
|
@ -5667,7 +5670,7 @@ def sitemonitor(registry, xml_parent, data):
|
|||
"""yaml: sitemonitor
|
||||
This plugin checks the availability of an url.
|
||||
|
||||
It requires the :jenkins-wiki:`sitemonitor plugin <SiteMonitor+Plugin>`.
|
||||
It requires the :jenkins-plugins:`sitemonitor plugin <sitemonitor>`.
|
||||
|
||||
:arg list sites: List of URLs to check
|
||||
|
||||
|
|
@ -7085,8 +7088,8 @@ def flowdock(registry, xml_parent, data):
|
|||
"""yaml: flowdock
|
||||
This plugin publishes job build results to a Flowdock flow.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Flowdock Plugin
|
||||
<Flowdock+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Flowdock Plugin
|
||||
<jenkins-flowdock-plugin>`.
|
||||
|
||||
:arg str token: API token for the targeted flow.
|
||||
(required)
|
||||
|
|
|
|||
|
|
@ -76,8 +76,7 @@ def findbugs(registry, xml_parent, data):
|
|||
"""yaml: findbugs
|
||||
FindBugs reporting for builds
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`FindBugs Plugin
|
||||
<FindBugs+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`FindBugs Plugin <findbugs>`.
|
||||
|
||||
:arg bool rank-priority: Use rank as priority (default false)
|
||||
:arg str include-files: Comma separated list of files to include.
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ default with no SCM.
|
|||
|
||||
The scm module allows referencing multiple repositories in a Jenkins job.
|
||||
Note: Adding more than one scm definition requires the Jenkins
|
||||
:jenkins-wiki:`Multiple SCMs plugin <Multiple+SCMs+Plugin>`.
|
||||
:jenkins-plugins:`Multiple SCMs plugin <multiple-scms>`.
|
||||
|
||||
Example of multiple repositories in a single job:
|
||||
.. literalinclude:: /../../tests/macros/fixtures/scm/multi-scms001.yaml
|
||||
|
|
@ -47,8 +47,9 @@ import jenkins_jobs.modules.helpers as helpers
|
|||
|
||||
def p4(registry, xml_parent, data):
|
||||
r"""yaml: p4
|
||||
Specifies the Perforce (P4) repository for this job
|
||||
Requires the Jenkins :jenkins-wiki:`P4 Plugin <P4+Plugin>`.
|
||||
Specifies the Perforce (P4) repository for this job.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`P4 Plugin <p4>`.
|
||||
"""
|
||||
scm = XML.SubElement(
|
||||
xml_parent,
|
||||
|
|
@ -171,7 +172,8 @@ def p4_construct_populate(xml_parent, data):
|
|||
def git(registry, xml_parent, data):
|
||||
r"""yaml: git
|
||||
Specifies the git SCM repository for this job.
|
||||
Requires the Jenkins :jenkins-wiki:`Git Plugin <Git+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Git Plugin <git>`.
|
||||
|
||||
:arg str url: URL of the git repository
|
||||
:arg str credentials-id: ID of credential to use to connect, which is the
|
||||
|
|
@ -704,7 +706,8 @@ def git_extensions(xml_parent, data):
|
|||
def cvs(registry, xml_parent, data):
|
||||
"""yaml: cvs
|
||||
Specifies the CVS SCM repository for this job.
|
||||
Requires the Jenkins :jenkins-wiki:`CVS Plugin <CVS+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`CVS Plugin <cvs>`.
|
||||
|
||||
:arg list repos: List of CVS repositories. (required)
|
||||
|
||||
|
|
@ -835,7 +838,8 @@ def cvs(registry, xml_parent, data):
|
|||
def repo(registry, xml_parent, data):
|
||||
"""yaml: repo
|
||||
Specifies the repo SCM repository for this job.
|
||||
Requires the Jenkins :jenkins-wiki:`Repo Plugin <Repo+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Repo Plugin <repo>`.
|
||||
|
||||
:arg str manifest-url: URL of the repo manifest (required)
|
||||
:arg str manifest-branch: The branch of the manifest to use (optional)
|
||||
|
|
@ -916,8 +920,9 @@ def repo(registry, xml_parent, data):
|
|||
def store(registry, xml_parent, data):
|
||||
"""yaml: store
|
||||
Specifies the Visualworks Smalltalk Store repository for this job.
|
||||
Requires the Jenkins :jenkins-wiki:`Visualworks Smalltalk Store Plugin
|
||||
<Visualworks+Smalltalk+Store+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Visualworks Smalltalk Store Plugin
|
||||
<visualworks-store>`.
|
||||
|
||||
:arg str script: name of the Store script to run
|
||||
:arg str repository: name of the Store repository
|
||||
|
|
@ -1121,8 +1126,9 @@ def svn(registry, xml_parent, data):
|
|||
def tfs(registry, xml_parent, data):
|
||||
r"""yaml: tfs
|
||||
Specifies the Team Foundation Server repository for this job.
|
||||
Requires the Jenkins :jenkins-wiki:`Team Foundation Server Plugin
|
||||
<Team+Foundation+Server+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Team Foundation Server Plugin
|
||||
<tfs>`.
|
||||
|
||||
**NOTE**: TFS Password must be entered manually on the project if a
|
||||
user name is specified. The password will be overwritten with an empty
|
||||
|
|
@ -1225,8 +1231,9 @@ def tfs(registry, xml_parent, data):
|
|||
def workspace(registry, xml_parent, data):
|
||||
"""yaml: workspace
|
||||
Specifies the cloned workspace for this job to use as a SCM source.
|
||||
Requires the Jenkins :jenkins-wiki:`Clone Workspace SCM Plugin
|
||||
<Clone+Workspace+SCM+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Clone Workspace SCM Plugin
|
||||
<clone-workspace-scm>`.
|
||||
|
||||
The job the workspace is cloned from must be configured with an
|
||||
clone-workspace publisher
|
||||
|
|
@ -1262,7 +1269,8 @@ def workspace(registry, xml_parent, data):
|
|||
def hg(self, xml_parent, data):
|
||||
"""yaml: hg
|
||||
Specifies the mercurial SCM repository for this job.
|
||||
Requires the Jenkins :jenkins-wiki:`Mercurial Plugin <Mercurial+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Mercurial Plugin <mercurial>`.
|
||||
|
||||
:arg str url: URL of the hg repository (required)
|
||||
:arg str credentials-id: ID of credentials to use to connect (optional)
|
||||
|
|
@ -1354,8 +1362,9 @@ def openshift_img_streams(registry, xml_parent, data):
|
|||
OpenShift ImageStreams (which are abstractions of Docker repositories)
|
||||
and SCMs - versions / commit IDs of related artifacts
|
||||
(images vs. programmatics files)
|
||||
Requires the Jenkins :jenkins-wiki:`OpenShift
|
||||
Pipeline Plugin <OpenShift+Pipeline+Plugin>`._
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`OpenShift Pipeline Plugin
|
||||
<openshift-pipeline>`.
|
||||
|
||||
:arg str image-stream-name: The name of the ImageStream is what shows up
|
||||
in the NAME column if you dump all the ImageStream's with the
|
||||
|
|
@ -1405,7 +1414,8 @@ def openshift_img_streams(registry, xml_parent, data):
|
|||
def bzr(registry, xml_parent, data):
|
||||
"""yaml: bzr
|
||||
Specifies the bzr SCM repository for this job.
|
||||
Requires the Jenkins :jenkins-wiki:`Bazaar Plugin <Bazaar+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Bazaar Plugin <bazaar>`.
|
||||
|
||||
:arg str url: URL of the bzr branch (required)
|
||||
:arg bool clean-tree: Clean up the workspace (using bzr) before pulling
|
||||
|
|
@ -1470,7 +1480,8 @@ def url(registry, xml_parent, data):
|
|||
"""yaml: url
|
||||
|
||||
Watch for changes in, and download an artifact from a particular url.
|
||||
Requires the Jenkins :jenkins-wiki:`URL SCM <URL+SCM>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`URL SCM <URLSCM>`.
|
||||
|
||||
:arg list url-list: List of URLs to watch. (required)
|
||||
:arg bool clear-workspace: If set to true, clear the workspace before
|
||||
|
|
@ -1498,7 +1509,8 @@ def dimensions(registry, xml_parent, data):
|
|||
"""yaml: dimensions
|
||||
|
||||
Specifies the Dimensions SCM repository for this job.
|
||||
Requires Jenkins :jenkins-wiki:`Dimensions Plugin <Dimensions+Plugin>`.
|
||||
|
||||
Requires Jenkins :jenkins-plugins:`Dimensions Plugin <dimensionsscm>`.
|
||||
|
||||
:arg str project: Project name of format PRODUCT_ID:PROJECT_NAME (required)
|
||||
:arg str permissions: Default Permissions for updated files
|
||||
|
|
@ -1600,7 +1612,8 @@ def dimensions(registry, xml_parent, data):
|
|||
def accurev(registry, xml_parent, data):
|
||||
"""yaml: accurev
|
||||
Specifies the AccuRev SCM repository for this job.
|
||||
Requires the Jenkins :jenkins-wiki:`AccuRev Plugin <AccuRev+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`AccuRev Plugin <accurev>`.
|
||||
|
||||
:arg str depot: Depot you want to use for the current job (optional)
|
||||
:arg str stream: Stream where the build will be generated from (optional)
|
||||
|
|
|
|||
|
|
@ -244,8 +244,9 @@ def gerrit(registry, xml_parent, data):
|
|||
"""yaml: gerrit
|
||||
|
||||
Trigger on a Gerrit event.
|
||||
Requires the Jenkins :jenkins-wiki:`Gerrit Trigger Plugin <Gerrit+Trigger>`
|
||||
version >= 2.6.0.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Gerrit Trigger Plugin
|
||||
<gerrit-trigger>` version >= 2.6.0.
|
||||
|
||||
:arg list trigger-on: Events to react on. Please use either the new
|
||||
**trigger-on**, or the old **trigger-on-*** events definitions. You
|
||||
|
|
@ -693,8 +694,8 @@ def dockerhub_notification(registry, xml_parent, data):
|
|||
The job will get triggered when Docker Hub/Registry notifies
|
||||
that Docker image(s) used in this job has been rebuilt.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`CloudBees Docker Hub Notification
|
||||
<CloudBees+Docker+Hub+Notification>`.
|
||||
Requires the Jenkins :jenkins-plugins:`CloudBees Docker Hub Notification
|
||||
<dockerhub-notification>`.
|
||||
|
||||
:arg bool referenced-image: Trigger the job based on repositories
|
||||
used by any compatible docker plugin in this job. (default true)
|
||||
|
|
@ -812,7 +813,7 @@ def build_content_type(
|
|||
def pollurl(registry, xml_parent, data):
|
||||
"""yaml: pollurl
|
||||
Trigger when the HTTP response from a URL changes.
|
||||
Requires the Jenkins :jenkins-wiki:`URLTrigger Plugin <URLTrigger+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`URLTrigger Plugin <urltrigger>`.
|
||||
|
||||
:arg string cron: cron syntax of when to run (default '')
|
||||
:arg string polling-node: Restrict where the polling should run.
|
||||
|
|
@ -930,8 +931,8 @@ def jms_messaging(registry, xml_parent, data):
|
|||
- ActiveMQ
|
||||
- FedMsg
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`JMS Messaging Plugin
|
||||
<JMS+Messaging+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`JMS Messaging Plugin
|
||||
<jms-messaging>`.
|
||||
|
||||
:arg bool no-squash: true = schedule a new job for every triggering message.
|
||||
(default false)
|
||||
|
|
@ -1009,8 +1010,9 @@ def timed(registry, xml_parent, data):
|
|||
def bitbucket(registry, xml_parent, data):
|
||||
"""yaml: bitbucket
|
||||
Trigger a job when bitbucket repository is pushed to.
|
||||
Requires the Jenkins :jenkins-wiki:`BitBucket Plugin
|
||||
<BitBucket+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`BitBucket Plugin
|
||||
<bitbucket>`.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -1025,7 +1027,8 @@ def bitbucket(registry, xml_parent, data):
|
|||
def github(registry, xml_parent, data):
|
||||
"""yaml: github
|
||||
Trigger a job when github repository is pushed to.
|
||||
Requires the Jenkins :jenkins-wiki:`GitHub Plugin <GitHub+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`GitHub Plugin <github>`.
|
||||
|
||||
Example::
|
||||
|
||||
|
|
@ -1039,8 +1042,9 @@ def github(registry, xml_parent, data):
|
|||
def github_pull_request(registry, xml_parent, data):
|
||||
"""yaml: github-pull-request
|
||||
Build pull requests in github and report results.
|
||||
Requires the Jenkins :jenkins-wiki:`GitHub Pull Request Builder Plugin
|
||||
<GitHub+pull+request+builder+plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`GitHub Pull Request Builder Plugin
|
||||
<ghprb>`.
|
||||
|
||||
:arg list admin-list: the users with admin rights (optional)
|
||||
:arg list white-list: users whose pull requests build (optional)
|
||||
|
|
@ -1290,8 +1294,9 @@ def github_pull_request(registry, xml_parent, data):
|
|||
def gitlab_merge_request(registry, xml_parent, data):
|
||||
"""yaml: gitlab-merge-request
|
||||
Build merge requests in gitlab and report results.
|
||||
Requires the Jenkins :jenkins-wiki:`Gitlab MergeRequest Builder Plugin
|
||||
<Gitlab+Merge+Request+Builder+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Gitlab MergeRequest Builder Plugin
|
||||
<ghprb>`.
|
||||
|
||||
:arg string cron: Cron syntax of when to run (required)
|
||||
:arg string project-path: Gitlab-relative path to project (required)
|
||||
|
|
@ -1375,8 +1380,8 @@ def gitlab_merge_request(registry, xml_parent, data):
|
|||
def gitlab(registry, xml_parent, data):
|
||||
"""yaml: gitlab
|
||||
Makes Jenkins act like a GitLab CI server.
|
||||
Requires the Jenkins :jenkins-wiki:`GitLab Plugin
|
||||
<GitLab+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`GitLab Plugin <gitlab-plugin>`.
|
||||
|
||||
:arg bool trigger-push: Build on Push Events (default true)
|
||||
:arg bool trigger-merge-request: Build on Merge Request Events (default
|
||||
|
|
@ -1540,8 +1545,9 @@ def build_result(registry, xml_parent, data):
|
|||
"""yaml: 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, ...).
|
||||
Requires the Jenkins :jenkins-wiki:`BuildResultTrigger Plugin
|
||||
<BuildResultTrigger+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`BuildResultTrigger Plugin
|
||||
<buildresult-trigger>`.
|
||||
|
||||
:arg list groups: List groups of jobs and results to monitor for
|
||||
:arg list jobs: The jobs to monitor (required)
|
||||
|
|
@ -1658,8 +1664,9 @@ def reverse(registry, xml_parent, data):
|
|||
def monitor_folders(registry, xml_parent, data):
|
||||
"""yaml: monitor-folders
|
||||
Configure Jenkins to monitor folders.
|
||||
Requires the Jenkins :jenkins-wiki:`Filesystem Trigger Plugin
|
||||
<FSTrigger+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Filesystem Trigger Plugin
|
||||
<fstrigger>`.
|
||||
|
||||
:arg str path: Folder path to poll. (default '')
|
||||
:arg list includes: Fileset includes setting that specifies the list of
|
||||
|
|
@ -1711,8 +1718,8 @@ def monitor_folders(registry, xml_parent, data):
|
|||
def monitor_files(registry, xml_parent, data):
|
||||
"""yaml: monitor-files
|
||||
Configure Jenkins to monitor files.
|
||||
Requires the Jenkins :jenkins-wiki:`Filesystem Trigger Plugin
|
||||
<FSTrigger+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Filesystem Trigger Plugin
|
||||
<fstrigger>`.
|
||||
|
||||
:arg list files: List of files to monitor
|
||||
|
||||
|
|
@ -1866,9 +1873,10 @@ def monitor_files(registry, xml_parent, data):
|
|||
|
||||
def ivy(registry, xml_parent, data):
|
||||
"""yaml: ivy
|
||||
Poll with an Ivy script
|
||||
Requires the Jenkins :jenkins-wiki:`IvyTrigger Plugin
|
||||
<IvyTrigger+Plugin>`.
|
||||
Poll with an Ivy script.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`IvyTrigger Plugin
|
||||
<ivytrigger>`.
|
||||
|
||||
:arg str path: Path of the ivy file. (optional)
|
||||
:arg str settings-path: Ivy Settings Path. (optional)
|
||||
|
|
@ -1911,6 +1919,7 @@ def ivy(registry, xml_parent, data):
|
|||
def script(registry, xml_parent, data):
|
||||
"""yaml: script
|
||||
Triggers the job using shell or batch script.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`ScriptTrigger Plugin
|
||||
<ScriptTrigger+Plugin>`.
|
||||
|
||||
|
|
@ -1951,6 +1960,7 @@ def script(registry, xml_parent, data):
|
|||
def groovy_script(registry, xml_parent, data):
|
||||
"""yaml: groovy-script
|
||||
Triggers the job using a groovy script.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`ScriptTrigger Plugin
|
||||
<ScriptTrigger+Plugin>`.
|
||||
|
||||
|
|
@ -2000,8 +2010,9 @@ def groovy_script(registry, xml_parent, data):
|
|||
def rabbitmq(registry, xml_parent, data):
|
||||
"""yaml: rabbitmq
|
||||
This plugin triggers build using remote build message in RabbitMQ queue.
|
||||
Requires the Jenkins :jenkins-wiki:`RabbitMQ Build Trigger Plugin
|
||||
<RabbitMQ+Build+Trigger+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`RabbitMQ Build Trigger Plugin
|
||||
<rabbitmq-build-trigger>`.
|
||||
|
||||
:arg str token: the build token expected in the message queue (required)
|
||||
:arg list filters: list of filters to apply (optional)
|
||||
|
|
@ -2039,8 +2050,8 @@ def rabbitmq(registry, xml_parent, data):
|
|||
def parameterized_timer(parser, xml_parent, data):
|
||||
"""yaml: parameterized-timer
|
||||
Trigger builds with parameters at certain times.
|
||||
Requires the Jenkins :jenkins-wiki:`Parameterized Scheduler Plugin
|
||||
<Parameterized+Scheduler+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Parameterized Scheduler Plugin
|
||||
<parameterized-scheduler>`.
|
||||
|
||||
:arg str cron: cron syntax of when to run and with which parameters
|
||||
(required)
|
||||
|
|
@ -2062,9 +2073,10 @@ def parameterized_timer(parser, xml_parent, data):
|
|||
|
||||
def jira_changelog(registry, xml_parent, data):
|
||||
"""yaml: jira-changelog
|
||||
Sets up a trigger that listens to JIRA issue changes
|
||||
Requires the Jenkins :jenkins-wiki:`JIRA Trigger Plugin
|
||||
<JIRA+Trigger+Plugin>`.
|
||||
Sets up a trigger that listens to JIRA issue changes.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`JIRA Trigger Plugin
|
||||
<jira-trigger>`.
|
||||
|
||||
:arg str jql-filter: Must match updated issues to trigger a build.
|
||||
(default '')
|
||||
|
|
@ -2175,8 +2187,9 @@ def jira_changelog(registry, xml_parent, data):
|
|||
def jira_comment_trigger(registry, xml_parent, data):
|
||||
"""yaml: jira-comment-trigger
|
||||
Trigger builds when a comment is added to JIRA.
|
||||
Requires the Jenkins :jenkins-wiki:`JIRA Trigger Plugin
|
||||
<JIRA+Trigger+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`JIRA Trigger Plugin
|
||||
<jira-trigger>`.
|
||||
|
||||
:arg str jql-filter: Must match updated issues to trigger a build.
|
||||
(default '')
|
||||
|
|
@ -2231,8 +2244,9 @@ def jira_comment_trigger(registry, xml_parent, data):
|
|||
def stash_pull_request(registry, xml_parent, data):
|
||||
"""yaml: stash-pull-request
|
||||
Trigger builds via Stash/Bitbucket Server Pull Requests.
|
||||
Requires the Jenkins :jenkins-wiki:`Stash Pull Request Builder Plugin
|
||||
<Stash+pullrequest+builder+plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Stash Pull Request Builder Plugin
|
||||
<stash-pullrequest-builder>`.
|
||||
|
||||
:arg str cron: cron syntax of when to run (required)
|
||||
:arg str stash-host: The HTTP or HTTPS URL of the Stash host (NOT ssh).
|
||||
|
|
@ -2305,8 +2319,9 @@ def stash_pull_request(registry, xml_parent, data):
|
|||
def generic_webhook_trigger(registry, xml_parent, data):
|
||||
"""yaml: generic-webhook-trigger
|
||||
Generic webhook trigger. Trigger when a set of parameters are submitted.
|
||||
Requires the Jenkins
|
||||
:jenkins-wiki:`Generic Webhook Trigger <Generic+Webhook+Trigger+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Generic Webhook Trigger
|
||||
<generic-webhook-trigger>`.
|
||||
|
||||
|
||||
:arg string token: A token to use to trigger the job. (default '')
|
||||
|
|
|
|||
|
|
@ -42,8 +42,9 @@ def docker_custom_build_env(registry, xml_parent, data):
|
|||
"""yaml: docker-custom-build-env
|
||||
Allows the definition of a build environment for a job using a Docker
|
||||
container.
|
||||
Requires the Jenkins :jenkins-wiki:`CloudBees Docker Custom Build
|
||||
Environment Plugin<CloudBees+Docker+Custom+Build+Environment+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`CloudBees Docker Custom Build
|
||||
Environment Plugin<docker-custom-build-environment>`.
|
||||
|
||||
:arg str image-type: Docker image type. Valid values and their
|
||||
additional attributes described in the image_types_ table
|
||||
|
|
@ -168,7 +169,8 @@ def ci_skip(registry, xml_parent, data):
|
|||
Skip making a build for certain push.
|
||||
Just add [ci skip] into your commit's message to let Jenkins know,
|
||||
that you do not want to perform build for the next push.
|
||||
Requires the Jenkins :jenkins-wiki:`Ci Skip Plugin <Ci+Skip+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Ci Skip Plugin <ci-skip>`.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -194,8 +196,9 @@ def config_file_provider(registry, xml_parent, data):
|
|||
"""yaml: config-file-provider
|
||||
Provide configuration files (i.e., settings.xml for maven etc.)
|
||||
which will be copied to the job's workspace.
|
||||
Requires the Jenkins :jenkins-wiki:`Config File Provider Plugin
|
||||
<Config+File+Provider+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Config File Provider Plugin
|
||||
<config-file-provider>`.
|
||||
|
||||
:arg list files: List of managed config files made up of three
|
||||
parameters
|
||||
|
|
@ -231,8 +234,9 @@ def config_file_provider(registry, xml_parent, data):
|
|||
def logfilesize(registry, xml_parent, data):
|
||||
"""yaml: logfilesize
|
||||
Abort the build if its logfile becomes too big.
|
||||
Requires the Jenkins :jenkins-wiki:`Logfilesizechecker Plugin
|
||||
<Logfilesizechecker+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Logfilesizechecker Plugin
|
||||
<logfilesizechecker>`.
|
||||
|
||||
:arg bool set-own: Use job specific maximum log size instead of global
|
||||
config value (default false).
|
||||
|
|
@ -265,8 +269,9 @@ def logfilesize(registry, xml_parent, data):
|
|||
def timeout(registry, xml_parent, data):
|
||||
"""yaml: timeout
|
||||
Abort the build if it runs too long.
|
||||
Requires the Jenkins :jenkins-wiki:`Build Timeout Plugin
|
||||
<Build-timeout+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Build Timeout Plugin
|
||||
<build-timeout>`.
|
||||
|
||||
:arg bool fail: Mark the build as failed (default false)
|
||||
:arg bool abort: Mark the build as aborted (default false)
|
||||
|
|
@ -479,7 +484,8 @@ def timeout(registry, xml_parent, data):
|
|||
def timestamps(registry, xml_parent, data):
|
||||
"""yaml: timestamps
|
||||
Add timestamps to the console log.
|
||||
Requires the Jenkins :jenkins-wiki:`Timestamper Plugin <Timestamper>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Timestamper Plugin <timestamper>`.
|
||||
|
||||
Example::
|
||||
|
||||
|
|
@ -492,7 +498,8 @@ def timestamps(registry, xml_parent, data):
|
|||
def ansicolor(registry, xml_parent, data):
|
||||
"""yaml: ansicolor
|
||||
Translate ANSI color codes to HTML in the console log.
|
||||
Requires the Jenkins :jenkins-wiki:`Ansi Color Plugin <AnsiColor+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Ansi Color Plugin <ansicolor>`.
|
||||
|
||||
:arg string colormap: Color mapping to use (default xterm)
|
||||
|
||||
|
|
@ -518,8 +525,9 @@ def ansicolor(registry, xml_parent, data):
|
|||
def build_keeper(registry, xml_parent, data):
|
||||
"""yaml: build-keeper
|
||||
Keep builds based on specific policy.
|
||||
Requires the Jenkins :jenkins-wiki:`Build Keeper Plugin
|
||||
<Build+Keeper+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Build Keeper Plugin
|
||||
<build-keeper-plugin>`.
|
||||
|
||||
:arg str policy: Policy to keep builds.
|
||||
|
||||
|
|
@ -790,8 +798,9 @@ def build_keeper(registry, xml_parent, data):
|
|||
def live_screenshot(registry, xml_parent, data):
|
||||
"""yaml: live-screenshot
|
||||
Show live screenshots of running jobs in the job list.
|
||||
Requires the Jenkins :jenkins-wiki:`Live-Screenshot Plugin
|
||||
<LiveScreenshot+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Live-Screenshot Plugin
|
||||
<livescreenshot>`.
|
||||
|
||||
:arg str full-size: name of screenshot file (default 'screenshot.png')
|
||||
:arg str thumbnail: name of thumbnail file (default 'screenshot-thumb.png')
|
||||
|
|
@ -822,8 +831,9 @@ def live_screenshot(registry, xml_parent, data):
|
|||
def mask_passwords(registry, xml_parent, data):
|
||||
"""yaml: mask-passwords
|
||||
Hide passwords in the console log.
|
||||
Requires the Jenkins :jenkins-wiki:`Mask Passwords Plugin
|
||||
<Mask+Passwords+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Mask Passwords Plugin
|
||||
<mask-passwords>`.
|
||||
|
||||
Example::
|
||||
|
||||
|
|
@ -839,8 +849,8 @@ def mask_passwords(registry, xml_parent, data):
|
|||
def workspace_cleanup(registry, xml_parent, data):
|
||||
"""yaml: workspace-cleanup (pre-build)
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Workspace Cleanup Plugin
|
||||
<Workspace+Cleanup+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Workspace Cleanup Plugin
|
||||
<ws-cleanup>`.
|
||||
|
||||
The post-build workspace-cleanup is available as a publisher.
|
||||
|
||||
|
|
@ -894,9 +904,10 @@ def workspace_cleanup(registry, xml_parent, data):
|
|||
|
||||
def m2_repository_cleanup(registry, xml_parent, data):
|
||||
"""yaml: m2-repository-cleanup
|
||||
Configure M2 Repository Cleanup
|
||||
Requires the Jenkins :jenkins-wiki:`M2 Repository Cleanup
|
||||
<M2+Repository+Cleanup+Plugin>`.
|
||||
Configure M2 Repository Cleanup.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`M2 Repository Cleanup
|
||||
<maven-repo-cleaner>`.
|
||||
|
||||
:arg list patterns: List of patterns for artifacts to cleanup before
|
||||
building. (optional)
|
||||
|
|
@ -922,8 +933,9 @@ def m2_repository_cleanup(registry, xml_parent, data):
|
|||
|
||||
def rvm_env(registry, xml_parent, data):
|
||||
"""yaml: rvm-env
|
||||
Set the RVM implementation
|
||||
Requires the Jenkins :jenkins-wiki:`Rvm Plugin <RVM+Plugin>`.
|
||||
Set the RVM implementation.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Rvm Plugin <rvm>`.
|
||||
|
||||
:arg str implementation: Type of implementation. Syntax is RUBY[@GEMSET],
|
||||
such as '1.9.3' or 'jruby@foo'.
|
||||
|
|
@ -962,7 +974,8 @@ def rvm_env(registry, xml_parent, data):
|
|||
def rbenv(registry, xml_parent, data):
|
||||
"""yaml: rbenv
|
||||
Set the rbenv implementation.
|
||||
Requires the Jenkins :jenkins-wiki:`rbenv plugin <rbenv+plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`rbenv plugin <rbenv>`.
|
||||
|
||||
All parameters are optional.
|
||||
|
||||
|
|
@ -1039,9 +1052,10 @@ def rbenv(registry, xml_parent, data):
|
|||
|
||||
def build_name(registry, xml_parent, data):
|
||||
"""yaml: build-name
|
||||
Set the name of the build
|
||||
Requires the Jenkins :jenkins-wiki:`Build Name Setter Plugin
|
||||
<Build+Name+Setter+Plugin>`.
|
||||
Set the name of the build.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Build Name Setter Plugin
|
||||
<build-name-setter>`.
|
||||
|
||||
:arg str name: Name for the build. Typically you would use a variable
|
||||
from Jenkins in the name. The syntax would be ${FOO} for
|
||||
|
|
@ -1062,9 +1076,10 @@ def build_name(registry, xml_parent, data):
|
|||
|
||||
def port_allocator(registry, xml_parent, data):
|
||||
"""yaml: port-allocator
|
||||
Assign unique TCP port numbers
|
||||
Requires the Jenkins :jenkins-wiki:`Port Allocator Plugin
|
||||
<Port+Allocator+Plugin>`.
|
||||
Assign unique TCP port numbers.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Port Allocator Plugin
|
||||
<port-allocator>`.
|
||||
|
||||
:arg str name: Deprecated, use names instead
|
||||
:arg list names: Variable list of names of the port or list of
|
||||
|
|
@ -1095,6 +1110,7 @@ def port_allocator(registry, xml_parent, data):
|
|||
def locks(registry, xml_parent, data):
|
||||
"""yaml: locks
|
||||
Control parallel execution of jobs.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Locks and Latches Plugin
|
||||
<Locks+and+Latches+plugin>`.
|
||||
|
||||
|
|
@ -1118,7 +1134,8 @@ def locks(registry, xml_parent, data):
|
|||
|
||||
def copy_to_slave(registry, xml_parent, data):
|
||||
"""yaml: copy-to-slave
|
||||
Copy files to slave before build
|
||||
Copy files to slave before build.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Copy To Slave Plugin
|
||||
<Copy+To+Slave+Plugin>`.
|
||||
|
||||
|
|
@ -1160,8 +1177,9 @@ def copy_to_slave(registry, xml_parent, data):
|
|||
|
||||
def inject(registry, xml_parent, data):
|
||||
"""yaml: inject
|
||||
Add or override environment variables to the whole build process
|
||||
Requires the Jenkins :jenkins-wiki:`EnvInject Plugin <EnvInject+Plugin>`.
|
||||
Add or override environment variables to the whole build process.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`EnvInject Plugin <envinject>`.
|
||||
|
||||
:arg str properties-file: path to the properties file (optional)
|
||||
:arg str properties-content: key value pair of properties (optional)
|
||||
|
|
@ -1201,8 +1219,9 @@ def inject(registry, xml_parent, data):
|
|||
def inject_ownership_variables(registry, xml_parent, data):
|
||||
"""yaml: inject-ownership-variables
|
||||
Inject ownership variables to the build as environment variables.
|
||||
Requires the Jenkins :jenkins-wiki:`EnvInject Plugin <EnvInject+Plugin>`
|
||||
and Jenkins :jenkins-wiki:`Ownership plugin <Ownership+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`EnvInject Plugin <envinject>`
|
||||
and Jenkins :jenkins-plugins:`Ownership plugin <ownership>`.
|
||||
|
||||
:arg bool job-variables: inject job ownership variables to the job
|
||||
(default false)
|
||||
|
|
@ -1228,7 +1247,8 @@ def inject_ownership_variables(registry, xml_parent, data):
|
|||
def inject_passwords(registry, xml_parent, data):
|
||||
"""yaml: inject-passwords
|
||||
Inject passwords to the build as environment variables.
|
||||
Requires the Jenkins :jenkins-wiki:`EnvInject Plugin <EnvInject+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`EnvInject Plugin <envinject>`.
|
||||
|
||||
:arg bool global: inject global passwords to the job
|
||||
:arg bool mask-password-params: mask password parameters
|
||||
|
|
@ -1264,8 +1284,8 @@ def vault_secrets(registry, xml_parent, data):
|
|||
|
||||
Secrets are generally masked in the build log.
|
||||
|
||||
Requires the Jenkins
|
||||
:jenkins-wiki:`HashiCorp Vault Plugin <HashiCorp+Vault+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`HashiCorp Vault Plugin
|
||||
<hashicorp-vault-plugin>`.
|
||||
|
||||
:arg str vault-url: Vault URL
|
||||
:arg str credentials-id: Vault Credential
|
||||
|
|
@ -1332,9 +1352,9 @@ def vault_secrets(registry, xml_parent, data):
|
|||
|
||||
def env_file(registry, xml_parent, data):
|
||||
"""yaml: env-file
|
||||
Add or override environment variables to the whole build process
|
||||
Requires the Jenkins :jenkins-wiki:`Environment File Plugin
|
||||
<Envfile+Plugin>`.
|
||||
Add or override environment variables to the whole build process.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Environment File Plugin <envfile>`.
|
||||
|
||||
:arg str properties-file: path to the properties file (optional)
|
||||
|
||||
|
|
@ -1352,8 +1372,9 @@ def env_file(registry, xml_parent, data):
|
|||
def env_script(registry, xml_parent, data):
|
||||
"""yaml: env-script
|
||||
Add or override environment variables to the whole build process.
|
||||
Requires the Jenkins :jenkins-wiki:`Environment Script Plugin
|
||||
<Environment+Script+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Environment Script Plugin
|
||||
<environment-script>`.
|
||||
|
||||
:arg script-content: The script to run (default '')
|
||||
:arg str script-type: The script type.
|
||||
|
|
@ -1389,7 +1410,8 @@ def jclouds(registry, xml_parent, data):
|
|||
"""yaml: jclouds
|
||||
Uses JClouds to provide slave launching on most of the currently
|
||||
usable Cloud infrastructures.
|
||||
Requires the Jenkins :jenkins-wiki:`JClouds Plugin <JClouds+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`JClouds Plugin <jclouds-jenkins>`.
|
||||
|
||||
:arg bool single-use: Whether or not to terminate the slave after use
|
||||
(default false).
|
||||
|
|
@ -1434,8 +1456,10 @@ def jclouds(registry, xml_parent, data):
|
|||
|
||||
def openstack(registry, xml_parent, data):
|
||||
"""yaml: openstack
|
||||
Provision slaves from OpenStack on demand. Requires the Jenkins
|
||||
:jenkins-wiki:`Openstack Cloud Plugin <Openstack+Cloud+Plugin>`.
|
||||
Provision slaves from OpenStack on demand.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Openstack Cloud Plugin
|
||||
<openstack-cloud>`.
|
||||
|
||||
:arg list instances: List of instances to be launched at the beginning of
|
||||
the build.
|
||||
|
|
@ -1492,8 +1516,9 @@ def openstack(registry, xml_parent, data):
|
|||
def build_user_vars(registry, xml_parent, data):
|
||||
"""yaml: build-user-vars
|
||||
Set environment variables to the value of the user that started the build.
|
||||
Requires the Jenkins :jenkins-wiki:`Build User Vars Plugin
|
||||
<Build+User+Vars+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Build User Vars Plugin
|
||||
<build-user-vars-plugin>`.
|
||||
|
||||
Example::
|
||||
|
||||
|
|
@ -1505,8 +1530,9 @@ def build_user_vars(registry, xml_parent, data):
|
|||
|
||||
def release(registry, xml_parent, data):
|
||||
"""yaml: release
|
||||
Add release build configuration
|
||||
Requires the Jenkins :jenkins-wiki:`Release Plugin <Release+Plugin>`.
|
||||
Add release build configuration.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Release Plugin <release>`.
|
||||
|
||||
:arg bool keep-forever: Keep build forever (default true)
|
||||
:arg bool override-build-parameters: Enable build-parameter override
|
||||
|
|
@ -1555,8 +1581,10 @@ def sauce_ondemand(registry, xml_parent, data):
|
|||
"""yaml: 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. Requires the Jenkins
|
||||
:jenkins-wiki:`Sauce OnDemand Plugin <Sauce+OnDemand+Plugin>`.
|
||||
the Sauce OnDemand results videos per test.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Sauce OnDemand Plugin
|
||||
<sauce-ondemand>`.
|
||||
|
||||
:arg bool enable-sauce-connect: launches a SSH tunnel from their cloud
|
||||
to your private network (default false)
|
||||
|
|
@ -1672,8 +1700,9 @@ def sauce_ondemand(registry, xml_parent, data):
|
|||
|
||||
def sonar(registry, xml_parent, data):
|
||||
"""yaml: sonar
|
||||
Wrapper for SonarQube Plugin
|
||||
Requires :jenkins-wiki:`SonarQube plugin <SonarQube+plugin>`
|
||||
Wrapper for SonarQube Plugin.
|
||||
|
||||
Requires :jenkins-plugins:`SonarQube plugin <sonar>`
|
||||
|
||||
:arg str install-name: Release goals and options (default '')
|
||||
|
||||
|
|
@ -1700,7 +1729,7 @@ def pathignore(registry, xml_parent, data):
|
|||
This plugin allows SCM-triggered jobs to ignore
|
||||
build requests if only certain paths have changed.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Pathignore Plugin <Pathignore+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Pathignore Plugin <pathignore>`.
|
||||
|
||||
:arg str ignored: A set of patterns to define ignored changes
|
||||
|
||||
|
|
@ -1737,8 +1766,10 @@ def pathignore(registry, xml_parent, data):
|
|||
|
||||
def pre_scm_buildstep(registry, xml_parent, data):
|
||||
"""yaml: pre-scm-buildstep
|
||||
Execute a Build Step before running the SCM
|
||||
Requires the Jenkins :jenkins-wiki:`pre-scm-buildstep <pre-scm-buildstep>`.
|
||||
Execute a Build Step before running the SCM.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Pre SCM BuildStep
|
||||
<preSCMbuildstep>`.
|
||||
|
||||
:arg string failOnError: Specifies if the job should fail on error
|
||||
(plugin >= 0.3) (default false).
|
||||
|
|
@ -1772,8 +1803,9 @@ def pre_scm_buildstep(registry, xml_parent, data):
|
|||
|
||||
def logstash(registry, xml_parent, data):
|
||||
"""yaml: logstash build wrapper
|
||||
Dump the Jenkins console output to Logstash
|
||||
Requires the Jenkins :jenkins-wiki:`logstash plugin <Logstash+Plugin>`.
|
||||
Dump the Jenkins console output to Logstash.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`logstash plugin <logstash>`.
|
||||
|
||||
:arg use-redis: Boolean to use Redis. (default true)
|
||||
:arg redis: Redis config params
|
||||
|
|
@ -1822,7 +1854,8 @@ def logstash(registry, xml_parent, data):
|
|||
def mongo_db(registry, xml_parent, data):
|
||||
"""yaml: mongo-db build wrapper
|
||||
Initializes a MongoDB database while running the build.
|
||||
Requires the Jenkins :jenkins-wiki:`MongoDB plugin <MongoDB+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`MongoDB plugin <mongodb>`.
|
||||
|
||||
:arg str name: The name of the MongoDB install to use (required)
|
||||
:arg str data-directory: Data directory for the server (default '')
|
||||
|
|
@ -1860,8 +1893,8 @@ def delivery_pipeline(registry, xml_parent, data):
|
|||
The version will be set to the environment variable PIPELINE_VERSION and
|
||||
will also be set in the downstream jobs.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Delivery Pipeline Plugin
|
||||
<Delivery+Pipeline+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Delivery Pipeline Plugin
|
||||
<delivery-pipeline-plugin>`.
|
||||
|
||||
:arg str version-template: Template for generated version e.g
|
||||
1.0.${BUILD_NUMBER} (default '')
|
||||
|
|
@ -1895,8 +1928,10 @@ def delivery_pipeline(registry, xml_parent, data):
|
|||
def matrix_tie_parent(registry, xml_parent, data):
|
||||
"""yaml: matrix-tie-parent
|
||||
Tie parent to a node.
|
||||
Requires the Jenkins :jenkins-wiki:`Matrix Tie Parent Plugin
|
||||
<Matrix+Tie+Parent+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Matrix Tie Parent Plugin
|
||||
<matrixtieparent>`.
|
||||
|
||||
Note that from Jenkins version 1.532 this plugin's functionality is
|
||||
available under the "advanced" option of the matrix project configuration.
|
||||
You can use the top level ``node`` parameter to control where the parent
|
||||
|
|
@ -1919,7 +1954,7 @@ def exclusion(registry, xml_parent, data):
|
|||
another job specifies the same resource, the second job will wait for the
|
||||
blocked resource to become available.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Exclusion Plugin <Exclusion-Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Exclusion Plugin <Exclusion>`.
|
||||
|
||||
:arg list resources: List of resources to add for exclusion
|
||||
|
||||
|
|
@ -1942,7 +1977,7 @@ def ssh_agent_credentials(registry, xml_parent, data):
|
|||
"""yaml: ssh-agent-credentials
|
||||
Sets up the user for the ssh agent plugin for jenkins.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`SSH-Agent Plugin <SSH+Agent+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`SSH-Agent Plugin <ssh-agent>`.
|
||||
|
||||
:arg list users: A list of Jenkins users credential IDs (required)
|
||||
:arg str user: The user id of the jenkins user credentials (deprecated)
|
||||
|
|
@ -2020,8 +2055,8 @@ def credentials_binding(registry, xml_parent, data):
|
|||
Binds credentials to environment variables using the credentials binding
|
||||
plugin for jenkins.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`Credentials Binding Plugin
|
||||
<Credentials+Binding+Plugin>` version 1.1 or greater.
|
||||
Requires the Jenkins :jenkins-plugins:`Credentials Binding Plugin
|
||||
<credentials-binding>` version 1.1 or greater.
|
||||
|
||||
:arg list binding-type: List of each bindings to create. Bindings may be
|
||||
of type `zip-file`, `file`, `username-password`, `text`,
|
||||
|
|
@ -2032,7 +2067,7 @@ def credentials_binding(registry, xml_parent, data):
|
|||
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
|
||||
:jenkins-wiki:`AWS Credentials Plugin <CloudBees+AWS+Credentials+Plugin>`
|
||||
:jenkins-plugins:`AWS Credentials Plugin <aws-credentials>`
|
||||
.
|
||||
|
||||
:Parameters: * **credential-id** (`str`) UUID of the credential being
|
||||
|
|
@ -2163,8 +2198,8 @@ def credentials_binding(registry, xml_parent, data):
|
|||
|
||||
def custom_tools(registry, xml_parent, data):
|
||||
"""yaml: custom-tools
|
||||
Requires the Jenkins :jenkins-wiki:`Custom Tools Plugin
|
||||
<Custom+Tools+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Custom Tools Plugin
|
||||
<custom-tools-plugin>`.
|
||||
|
||||
:arg list tools: List of custom tools to add
|
||||
(optional)
|
||||
|
|
@ -2198,8 +2233,10 @@ def custom_tools(registry, xml_parent, data):
|
|||
|
||||
def nodejs_installator(registry, xml_parent, data):
|
||||
"""yaml: nodejs-installator
|
||||
Requires the Jenkins :jenkins-wiki:`NodeJS Plugin
|
||||
<NodeJS+Plugin>`.
|
||||
Provides Jenkins integration for NodeJS & npm packages.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`NodeJS Plugin
|
||||
<nodejs>`.
|
||||
|
||||
:arg str name: nodejs installation name (required)
|
||||
|
||||
|
|
@ -2221,7 +2258,8 @@ def nodejs_installator(registry, xml_parent, data):
|
|||
def xvnc(registry, xml_parent, data):
|
||||
"""yaml: xvnc
|
||||
Enable xvnc during the build.
|
||||
Requires the Jenkins :jenkins-wiki:`xvnc plugin <Xvnc+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`xvnc plugin <xvnc>`.
|
||||
|
||||
:arg bool screenshot: Take screenshot upon build completion (default false)
|
||||
:arg bool xauthority: Create a dedicated Xauthority file per build (default
|
||||
|
|
@ -2250,11 +2288,11 @@ def xvnc(registry, xml_parent, data):
|
|||
def job_log_logger(registry, xml_parent, data):
|
||||
"""yaml: job-log-logger
|
||||
Enable writing the job log to the underlying logging system.
|
||||
Requires the Jenkins :jenkins-wiki:`Job Log Logger plugin
|
||||
<Job+Log+Logger+Plugin>`.
|
||||
|
||||
:arg bool suppress-empty: Suppress empty log messages
|
||||
(default true)
|
||||
Requires the Jenkins :jenkins-plugins:`Job Log Logger plugin
|
||||
<job-log-logger-plugin>`.
|
||||
|
||||
:arg bool suppress-empty: Suppress empty log messages (default true)
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -2271,7 +2309,8 @@ def job_log_logger(registry, xml_parent, data):
|
|||
def xvfb(registry, xml_parent, data):
|
||||
"""yaml: xvfb
|
||||
Enable xvfb during the build.
|
||||
Requires the Jenkins :jenkins-wiki:`Xvfb Plugin <Xvfb+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Xvfb Plugin <xvfb>`.
|
||||
|
||||
:arg str installation-name: The name of the Xvfb tool installation (default
|
||||
'default')
|
||||
|
|
@ -2328,8 +2367,9 @@ def android_emulator(registry, xml_parent, data):
|
|||
Automates many Android development tasks including SDK installation,
|
||||
build file generation, emulator creation and launch,
|
||||
APK (un)installation...
|
||||
Requires the Jenkins :jenkins-wiki:`Android Emulator Plugin
|
||||
<Android+Emulator+Plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Android Emulator Plugin
|
||||
<android-emulator>`.
|
||||
|
||||
:arg str avd: Enter the name of an existing Android emulator configuration.
|
||||
If this is exclusive with the 'os' arg.
|
||||
|
|
@ -2411,8 +2451,9 @@ def android_emulator(registry, xml_parent, data):
|
|||
|
||||
def artifactory_maven(registry, xml_parent, data):
|
||||
"""yaml: artifactory-maven
|
||||
Wrapper for non-Maven projects. Requires the
|
||||
:jenkins-wiki:`Artifactory Plugin <Artifactory+Plugin>`
|
||||
Wrapper for non-Maven projects.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Artifactory Plugin <artifactory>`
|
||||
|
||||
:arg str url: URL of the Artifactory server. e.g.
|
||||
https://jfrog.com/artifactory/ (default '')
|
||||
|
|
@ -2454,8 +2495,9 @@ def artifactory_maven(registry, xml_parent, data):
|
|||
|
||||
def artifactory_generic(registry, xml_parent, data):
|
||||
"""yaml: artifactory-generic
|
||||
Wrapper for non-Maven projects. Requires the
|
||||
:jenkins-wiki:`Artifactory Plugin <Artifactory+Plugin>`
|
||||
Wrapper for non-Maven projects.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Artifactory Plugin <artifactory>`
|
||||
|
||||
:arg str url: URL of the Artifactory server. e.g.
|
||||
https://jfrog.com/artifactory/ (default '')
|
||||
|
|
@ -2586,8 +2628,9 @@ def artifactory_generic(registry, xml_parent, data):
|
|||
|
||||
def artifactory_maven_freestyle(registry, xml_parent, data):
|
||||
"""yaml: artifactory-maven-freestyle
|
||||
Wrapper for Free Stype projects. Requires the Artifactory plugin.
|
||||
Requires :jenkins-wiki:`Artifactory Plugin <Artifactory+Plugin>`
|
||||
Wrapper for Free Stype projects.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`Artifactory Plugin <artifactory>`
|
||||
|
||||
:arg str url: URL of the Artifactory server. e.g.
|
||||
https://jfrog.com/artifactory/ (default '')
|
||||
|
|
@ -2734,7 +2777,8 @@ def artifactory_maven_freestyle(registry, xml_parent, data):
|
|||
def maven_release(registry, xml_parent, data):
|
||||
"""yaml: maven-release
|
||||
Wrapper for Maven projects
|
||||
Requires :jenkins-wiki:`M2 Release Plugin <M2+Release+Plugin>`
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`M2 Release Plugin <m2release>`
|
||||
|
||||
:arg str release-goals: Release goals and options (default '')
|
||||
:arg str dry-run-goals: DryRun goals and options (default '')
|
||||
|
|
@ -2780,8 +2824,8 @@ def version_number(parser, xml_parent, data):
|
|||
Generate a version number for the build using a format string. See the
|
||||
wiki page for more detailed descriptions of options.
|
||||
|
||||
Requires the Jenkins :jenkins-wiki:`version number plugin
|
||||
<Version+Number+Plugin>`.
|
||||
Requires the Jenkins :jenkins-plugins:`Version number plugin
|
||||
<versionnumber>`.
|
||||
|
||||
:arg str variable-name: Name of environment variable to assign version
|
||||
number to (required)
|
||||
|
|
@ -2834,8 +2878,9 @@ def version_number(parser, xml_parent, data):
|
|||
def github_pull_request(parser, xml_parent, data):
|
||||
"""yaml: github-pull-request
|
||||
Set GitHub commit status with custom context and message.
|
||||
Requires the Jenkins :jenkins-wiki:`GitHub Pull Request Builder Plugin
|
||||
<GitHub+pull+request+builder+plugin>`.
|
||||
|
||||
Requires the Jenkins :jenkins-plugins:`GitHub Pull Request Builder Plugin
|
||||
<ghprb>`.
|
||||
|
||||
:arg bool show-matrix-status: Only post commit status of parent matrix job
|
||||
(default false)
|
||||
|
|
|
|||
Loading…
Reference in New Issue