fix spelling errors
Change-Id: I42b6bb46a9e5574f88ec5c0cb5726a65353a4fd7
This commit is contained in:
parent
b50f1ec840
commit
3264b244b5
|
@ -367,7 +367,7 @@ It's possible to assign an `id` to any of the blocks and then use that
|
|||
to reference it instead of the name. This has two primary functions:
|
||||
|
||||
* A unique identifier where you wish to use the same naming format for
|
||||
multiple templates. This allows to follow a naming scheme while
|
||||
multiple templates. This allows you to follow a naming scheme while
|
||||
still using multiple templates to handle subtle variables in job
|
||||
requirements.
|
||||
* Provides a simpler name for a `job-template` where you have multiple
|
||||
|
|
|
@ -798,7 +798,7 @@ def http_request(registry, xml_parent, data):
|
|||
being called (default false)
|
||||
:arg str valid-response-codes: Configure response code to mark an
|
||||
execution as success. You can configure simple code such as "200"
|
||||
or multiple codes separeted by comma(',') e.g. "200,404,500"
|
||||
or multiple codes separated by comma(',') e.g. "200,404,500"
|
||||
Interval of codes should be in format From:To e.g. "100:399".
|
||||
The default (as if empty) is to fail to 4xx and 5xx.
|
||||
That means success from 100 to 399 "100:399"
|
||||
|
@ -1341,9 +1341,9 @@ def conditional_step(registry, xml_parent, data):
|
|||
:SCRIPT_CAUSE: build was triggered by a script
|
||||
(ScriptTrigger Plugin)
|
||||
:BUILDRESULT_CAUSE: build was triggered by a
|
||||
result of an other job (BuildResultTrigger Plugin)
|
||||
result of another job (BuildResultTrigger Plugin)
|
||||
:exclusive-cause: (bool) There might by multiple
|
||||
casues causing a build to be triggered, with
|
||||
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)
|
||||
|
@ -2171,7 +2171,7 @@ def sbt(registry, xml_parent, data):
|
|||
|
||||
def critical_block_start(registry, xml_parent, data):
|
||||
"""yaml: critical-block-start
|
||||
Designate the start of a critical block. Must be used in conjuction with
|
||||
Designate the start of a critical block. Must be used in conjunction with
|
||||
critical-block-end.
|
||||
|
||||
Must also add a build wrapper (exclusion), specifying the resources that
|
||||
|
@ -2192,7 +2192,7 @@ def critical_block_start(registry, xml_parent, data):
|
|||
|
||||
def critical_block_end(registry, xml_parent, data):
|
||||
"""yaml: critical-block-end
|
||||
Designate the end of a critical block. Must be used in conjuction with
|
||||
Designate the end of a critical block. Must be used in conjunction with
|
||||
critical-block-start.
|
||||
|
||||
Must also add a build wrapper (exclusion), specifying the resources that
|
||||
|
@ -2553,7 +2553,7 @@ def tox(registry, xml_parent, data):
|
|||
|
||||
def managed_script(registry, xml_parent, data):
|
||||
"""yaml: managed-script
|
||||
This step allows to reference and execute a centrally managed
|
||||
This step allows you to reference and execute a centrally managed
|
||||
script within your build. Requires the Jenkins
|
||||
:jenkins-wiki:`Managed Script Plugin <Managed+Script+Plugin>`.
|
||||
|
||||
|
@ -3012,7 +3012,7 @@ def sonar(registry, xml_parent, data):
|
|||
|
||||
def xcode(registry, xml_parent, data):
|
||||
"""yaml: xcode
|
||||
This step allows to execute an xcode build step. Requires the Jenkins
|
||||
This step allows you to execute an xcode build step. Requires the Jenkins
|
||||
:jenkins-wiki:`Xcode Plugin <Xcode+Plugin>`.
|
||||
|
||||
:arg str developer-profile: the jenkins credential id for a
|
||||
|
@ -3963,7 +3963,7 @@ def nexus_artifact_uploader(registry, xml_parent, data):
|
|||
|
||||
def ansible_playbook(parser, xml_parent, data):
|
||||
"""yaml: ansible-playbook
|
||||
This plugin allows to execute Ansible tasks as a job build step.
|
||||
This plugin allows you to execute Ansible tasks as a job build step.
|
||||
Requires the Jenkins :jenkins-wiki:`Ansible Plugin <Ansible+Plugin>`.
|
||||
|
||||
:arg str playbook: Path to the ansible playbook file. The path can be
|
||||
|
@ -4001,7 +4001,7 @@ def ansible_playbook(parser, xml_parent, data):
|
|||
empty. (default '')
|
||||
:arg bool unbuffered-output: Skip standard output buffering for the ansible
|
||||
process. The ansible output is directly rendered into the Jenkins
|
||||
console. This option can be usefull for long running operations.
|
||||
console. This option can be useful for long running operations.
|
||||
(default true)
|
||||
:arg bool colorized-output: Check this box to allow ansible to render ANSI
|
||||
color codes in the Jenkins console. (default false)
|
||||
|
@ -4114,7 +4114,7 @@ def ansible_playbook(parser, xml_parent, data):
|
|||
|
||||
def nodejs(parser, xml_parent, data):
|
||||
"""yaml: nodejs
|
||||
This plugin allows to execute NodeJS scripts as a job build step.
|
||||
This plugin allows you to execute NodeJS scripts as a job build step.
|
||||
Requires the Jenkins :jenkins-wiki:`NodeJS Plugin <NodeJS+Plugin>`.
|
||||
|
||||
:arg str name: NodeJS installation name
|
||||
|
|
|
@ -888,7 +888,7 @@ def random_string_param(registry, xml_parent, data):
|
|||
|
||||
def git_parameter_param(registry, xml_parent, data):
|
||||
"""yaml: git-parameter
|
||||
This parameter allows to select a git tag, branch or revision number as
|
||||
This parameter allows you to select a git tag, branch or revision number as
|
||||
parameter in Parametrized builds.
|
||||
Requires the Jenkins :jenkins-wiki:`Git Parameter Plugin
|
||||
<Git+Parameter+Plugin>`.
|
||||
|
|
|
@ -796,7 +796,7 @@ def slack(registry, xml_parent, data):
|
|||
:arg bool include-custom-message: Include a custom message into the
|
||||
notification. (default false)
|
||||
:arg str custom-message: Custom message to be included. (default '')
|
||||
:arg str room: A comma seperated list of rooms / channels to send
|
||||
:arg str room: A comma separated list of rooms / channels to send
|
||||
the notifications to. (default '')
|
||||
|
||||
Example:
|
||||
|
@ -915,7 +915,7 @@ def build_discarder(registry, xml_parent, data):
|
|||
|
||||
def slave_prerequisites(registry, xml_parent, data):
|
||||
"""yaml: slave-prerequisites
|
||||
This plugin allows to check prerequisites on slave before
|
||||
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
|
||||
|
@ -953,7 +953,7 @@ def slave_prerequisites(registry, xml_parent, data):
|
|||
|
||||
def groovy_label(registry, xml_parent, data):
|
||||
"""yaml: groovy-label
|
||||
This plugin allows to use Groovy script to restrict where this project
|
||||
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
|
||||
|
|
|
@ -121,7 +121,7 @@ def archive(registry, xml_parent, data):
|
|||
:arg bool only-if-success: archive artifacts only if build is successful
|
||||
(default false)
|
||||
:arg bool fingerprint: fingerprint all archived artifacts (default false)
|
||||
:arg bool default-excludes: This option allows to enable or disable the
|
||||
:arg bool default-excludes: This option allows you to enable or disable the
|
||||
default Ant exclusions. (default true)
|
||||
:arg bool case-sensitive: Treat include and exclude patterns as case
|
||||
sensitive. (default true)
|
||||
|
@ -148,8 +148,8 @@ def archive(registry, xml_parent, data):
|
|||
|
||||
def blame_upstream(registry, xml_parent, data):
|
||||
"""yaml: blame-upstream
|
||||
Notify upstream commiters when build fails
|
||||
Requires the Jenkins :jenkins-wiki:`Blame upstream commiters Plugin
|
||||
Notify upstream committers when build fails
|
||||
Requires the Jenkins :jenkins-wiki:`Blame upstream committers Plugin
|
||||
<Blame+Upstream+Committers+Plugin>`.
|
||||
|
||||
Example:
|
||||
|
@ -6266,7 +6266,7 @@ def flowdock(registry, xml_parent, data):
|
|||
|
||||
:arg str token: API token for the targeted flow.
|
||||
(required)
|
||||
:arg str tags: Comma-separated list of tags to incude in message
|
||||
:arg str tags: Comma-separated list of tags to include in message
|
||||
(default "")
|
||||
:arg bool chat-notification: Send chat notification when build fails
|
||||
(default true)
|
||||
|
@ -6330,9 +6330,9 @@ def clamav(registry, xml_parent, data):
|
|||
Check files with ClamAV, an open source antivirus engine.
|
||||
Requires the Jenkins :jenkins-wiki:`ClamAV Plugin <ClamAV+Plugin>`.
|
||||
|
||||
:arg str includes: Comma seperated list of files that should be scanned.
|
||||
:arg str includes: Comma separated list of files that should be scanned.
|
||||
Must be set for ClamAV to check for artifacts. (default '')
|
||||
:arg str excludes: Comma seperated list of files that should be ignored
|
||||
:arg str excludes: Comma separated list of files that should be ignored
|
||||
(default '')
|
||||
|
||||
Full Example:
|
||||
|
@ -6378,7 +6378,7 @@ def testselector(registry, xml_parent, data):
|
|||
(default "")
|
||||
:arg str show-fields: Shown in the tests tree
|
||||
(default "")
|
||||
:arg str multiplicity-field: Amount of times the test should run
|
||||
:arg str multiplicity-field: Number of times the test should run
|
||||
(default "")
|
||||
|
||||
Example:
|
||||
|
@ -6616,7 +6616,7 @@ def slack(registry, xml_parent, data):
|
|||
(default '')
|
||||
:arg str build-server-url: Specify the URL for your server installation.
|
||||
(default '/')
|
||||
:arg str room: A comma seperated list of rooms / channels to post the
|
||||
:arg str room: A comma separated list of rooms / channels to post the
|
||||
notifications to. (default '')
|
||||
:arg bool notify-start: Send notification when the job starts (>=2.0).
|
||||
(default false)
|
||||
|
@ -7118,8 +7118,8 @@ def tasks(registry, xml_parent, data):
|
|||
should ensure that all new warnings will be finally fixed in subsequent
|
||||
builds. Depends on ``compute-new-warnings`` option. (default false)
|
||||
:arg bool only-use-stable-as-ref: Use the last stable build as the
|
||||
reference to compute the number of new warnings against. This allows to
|
||||
ignore interim unstable builds for which the number of warnings
|
||||
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 ``compute-new-warnings`` option. (default false)
|
||||
|
|
|
@ -1283,7 +1283,7 @@ def gitlab(registry, xml_parent, data):
|
|||
**include-branches** and **exclude-branches** lists.
|
||||
|
||||
RegexBasedFilter Filter branches by regex
|
||||
The target branch regex allows to limit the
|
||||
The target branch regex allows you to limit the
|
||||
execution of this job to certain branches. Any
|
||||
branch matching the specified pattern in
|
||||
**target-branch-regex** triggers the job. No
|
||||
|
|
|
@ -1479,7 +1479,7 @@ def logstash(registry, xml_parent, data):
|
|||
|
||||
def mongo_db(registry, xml_parent, data):
|
||||
"""yaml: mongo-db build wrapper
|
||||
Initalizes a MongoDB database while running the build.
|
||||
Initializes a MongoDB database while running the build.
|
||||
Requires the Jenkins :jenkins-wiki:`MongoDB plugin <MongoDB+Plugin>`.
|
||||
|
||||
:arg str name: The name of the MongoDB install to use (required)
|
||||
|
@ -1613,7 +1613,7 @@ def ssh_agent_credentials(registry, xml_parent, data):
|
|||
|
||||
|
||||
if both **users** and **user** parameters specified, **users** will be
|
||||
prefered, **user** will be ignored.
|
||||
preferred, **user** will be ignored.
|
||||
|
||||
Example:
|
||||
|
||||
|
@ -1876,12 +1876,12 @@ def xvfb(registry, xml_parent, data):
|
|||
Enable xvfb during the build.
|
||||
Requires the Jenkins :jenkins-wiki:`Xvfb Plugin <Xvfb+Plugin>`.
|
||||
|
||||
:arg str installation-name: The name of the Xvfb tool instalation (default
|
||||
:arg str installation-name: The name of the Xvfb tool installation (default
|
||||
'default')
|
||||
:arg bool auto-display-name: Uses the -displayfd option of Xvfb by which it
|
||||
chooses it's own display name (default false)
|
||||
:arg str display-name: Ordinal of the display Xvfb will be running on, if
|
||||
left empty choosen based on current build executor number (default '')
|
||||
left empty chosen based on current build executor number (default '')
|
||||
:arg str assigned-labels: If you want to start Xvfb only on specific nodes
|
||||
specify its name or label (default '')
|
||||
:arg bool parallel-build: When running multiple Jenkins nodes on the same
|
||||
|
|
Loading…
Reference in New Issue