Minor fixes to styling and coherency
Adds missing periods in item descriptions to bring in line with the rest of the documentation. Also fixes some typos and styling. Change-Id: I11ef0bf3f89ecf5f09bb5781cced9b655c71bc65
This commit is contained in:
parent
9f1245869b
commit
048acb4b20
|
@ -77,17 +77,17 @@ as well as to the running job as environment variables. They are as
|
||||||
follows:
|
follows:
|
||||||
|
|
||||||
**ZUUL_UUID**
|
**ZUUL_UUID**
|
||||||
Zuul provided key to link builds with Gerrit events
|
Zuul provided key to link builds with Gerrit events.
|
||||||
**ZUUL_REF**
|
**ZUUL_REF**
|
||||||
Zuul provided ref that includes commit(s) to build
|
Zuul provided ref that includes commit(s) to build.
|
||||||
**ZUUL_COMMIT**
|
**ZUUL_COMMIT**
|
||||||
The commit SHA1 at the head of ZUUL_REF
|
The commit SHA1 at the head of ZUUL_REF.
|
||||||
**ZUUL_PROJECT**
|
**ZUUL_PROJECT**
|
||||||
The project that triggered this build
|
The project that triggered this build.
|
||||||
**ZUUL_PIPELINE**
|
**ZUUL_PIPELINE**
|
||||||
The Zuul pipeline that is building this job
|
The Zuul pipeline that is building this job.
|
||||||
**ZUUL_URL**
|
**ZUUL_URL**
|
||||||
The url for the zuul server as configured in zuul.conf.
|
The URL for the zuul server as configured in zuul.conf.
|
||||||
A test runner may use this URL as the basis for fetching
|
A test runner may use this URL as the basis for fetching
|
||||||
git commits.
|
git commits.
|
||||||
|
|
||||||
|
@ -96,28 +96,28 @@ associated with changes (i.e., in response to patchset-created or
|
||||||
comment-added events):
|
comment-added events):
|
||||||
|
|
||||||
**ZUUL_BRANCH**
|
**ZUUL_BRANCH**
|
||||||
The target branch for the change that triggered this build
|
The target branch for the change that triggered this build.
|
||||||
**ZUUL_CHANGE**
|
**ZUUL_CHANGE**
|
||||||
The Gerrit change ID for the change that triggered this build
|
The Gerrit change ID for the change that triggered this build.
|
||||||
**ZUUL_CHANGE_IDS**
|
**ZUUL_CHANGE_IDS**
|
||||||
All of the Gerrit change IDs that are included in this build (useful
|
All of the Gerrit change IDs that are included in this build (useful
|
||||||
when the DependentPipelineManager combines changes for testing)
|
when the DependentPipelineManager combines changes for testing).
|
||||||
**ZUUL_PATCHSET**
|
**ZUUL_PATCHSET**
|
||||||
The Gerrit patchset number for the change that triggered this build
|
The Gerrit patchset number for the change that triggered this build.
|
||||||
|
|
||||||
The following additional parameters will only be provided for
|
The following additional parameters will only be provided for
|
||||||
post-merge (ref-updated) builds:
|
post-merge (ref-updated) builds:
|
||||||
|
|
||||||
**ZUUL_OLDREV**
|
**ZUUL_OLDREV**
|
||||||
The SHA1 of the old revision at this ref (recall the ref name is
|
The SHA1 of the old revision at this ref (recall the ref name is
|
||||||
in ZUUL_REF)
|
in ZUUL_REF).
|
||||||
**ZUUL_NEWREV**
|
**ZUUL_NEWREV**
|
||||||
The SHA1 of the new revision at this ref (recall the ref name is
|
The SHA1 of the new revision at this ref (recall the ref name is
|
||||||
in ZUUL_REF)
|
in ZUUL_REF).
|
||||||
**ZUUL_SHORT_OLDREV**
|
**ZUUL_SHORT_OLDREV**
|
||||||
The shortened (7 character) SHA1 of the old revision
|
The shortened (7 character) SHA1 of the old revision.
|
||||||
**ZUUL_SHORT_NEWREV**
|
**ZUUL_SHORT_NEWREV**
|
||||||
The shortened (7 character) SHA1 of the new revision
|
The shortened (7 character) SHA1 of the new revision.
|
||||||
|
|
||||||
In order to test the correct build, configure the Jenkins Git SCM
|
In order to test the correct build, configure the Jenkins Git SCM
|
||||||
plugin as follows::
|
plugin as follows::
|
||||||
|
|
|
@ -39,10 +39,10 @@ A simple email reporter is also available.
|
||||||
SMTP Configuration
|
SMTP Configuration
|
||||||
~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
zuul.conf contains the SMTP server and default to/from as describe
|
zuul.conf contains the SMTP server and default to/from as described
|
||||||
in :ref:`zuulconf`.
|
in :ref:`zuulconf`.
|
||||||
|
|
||||||
Each pipeline can overwrite the subject or the to or from address by
|
Each pipeline can overwrite the ``subject`` or the ``to`` or ``from`` address by
|
||||||
providing alternatives as arguments to the reporter. For example, ::
|
providing alternatives as arguments to the reporter. For example, ::
|
||||||
|
|
||||||
pipelines:
|
pipelines:
|
||||||
|
|
|
@ -10,11 +10,11 @@ Zuul has three configuration files:
|
||||||
|
|
||||||
**zuul.conf**
|
**zuul.conf**
|
||||||
Connection information for Gerrit and Gearman, locations of the
|
Connection information for Gerrit and Gearman, locations of the
|
||||||
other config files
|
other config files.
|
||||||
**layout.yaml**
|
**layout.yaml**
|
||||||
Project and pipeline configuration -- what Zuul does
|
Project and pipeline configuration -- what Zuul does.
|
||||||
**logging.conf**
|
**logging.conf**
|
||||||
Python logging config
|
Python logging config.
|
||||||
|
|
||||||
Examples of each of the three files can be found in the etc/ directory
|
Examples of each of the three files can be found in the etc/ directory
|
||||||
of the source distribution.
|
of the source distribution.
|
||||||
|
@ -46,7 +46,7 @@ gearman
|
||||||
``server=gearman.example.com``
|
``server=gearman.example.com``
|
||||||
|
|
||||||
**port**
|
**port**
|
||||||
Port on which the Gearman server is listening
|
Port on which the Gearman server is listening.
|
||||||
``port=4730``
|
``port=4730``
|
||||||
|
|
||||||
gearman_server
|
gearman_server
|
||||||
|
@ -365,14 +365,14 @@ explanation of each of the parameters::
|
||||||
If present, the approval must be older than this amount of time
|
If present, the approval must be older than this amount of time
|
||||||
to match. Provide a time interval as a number with a suffix of
|
to match. Provide a time interval as a number with a suffix of
|
||||||
"w" (weeks), "d" (days), "h" (hours), "m" (minutes), "s"
|
"w" (weeks), "d" (days), "h" (hours), "m" (minutes), "s"
|
||||||
(seconds). Example "48h" or "2d".
|
(seconds). Example ``48h`` or ``2d``.
|
||||||
|
|
||||||
*newer-than*
|
*newer-than*
|
||||||
If present, the approval must be newer than this amount of time
|
If present, the approval must be newer than this amount of time
|
||||||
to match. Same format as "older-than".
|
to match. Same format as "older-than".
|
||||||
|
|
||||||
Any other field is interpreted as a review category and value
|
Any other field is interpreted as a review category and value
|
||||||
pair. For example "verified: 1" would require that the approval
|
pair. For example ``verified: 1`` would require that the approval
|
||||||
be for a +1 vote in the "Verified" column.
|
be for a +1 vote in the "Verified" column.
|
||||||
|
|
||||||
**timer**
|
**timer**
|
||||||
|
@ -547,7 +547,7 @@ That kind of pipeline is nice to run regression or performance tests.
|
||||||
The ``change-merged`` event does not include the commit sha1 which can be
|
The ``change-merged`` event does not include the commit sha1 which can be
|
||||||
hazardous, it would let you report back to Gerrit though. If you were to
|
hazardous, it would let you report back to Gerrit though. If you were to
|
||||||
build a tarball for a specific commit, you should consider instead using
|
build a tarball for a specific commit, you should consider instead using
|
||||||
the ``ref-updated`` event which does include the commit sha1 (but lack the
|
the ``ref-updated`` event which does include the commit sha1 (but lacks the
|
||||||
Gerrit change number).
|
Gerrit change number).
|
||||||
|
|
||||||
Jobs
|
Jobs
|
||||||
|
|
Loading…
Reference in New Issue