Add zuul:value xref

Use it and zuul:attr xrefs.

Change-Id: I5cac10bbf76b54d0f035cc7c69e9304a2e197303
This commit is contained in:
James E. Blair 2017-07-28 17:28:26 -07:00
parent 9437591162
commit 91fe48355e
5 changed files with 10 additions and 16 deletions

View File

@ -145,9 +145,9 @@ The supported pipeline trigger options are:
This may be used for any event. It requires that a certain kind of
approval be present for the current patchset of the change (the
approval could be added by the event in question). It follows the
same syntax as the :ref:`"approval" pipeline requirement
<gerrit-pipeline-require-approval>`. For each specified criteria
there must exist a matching approval.
same syntax as :attr:`pipeline.require.<gerrit
source>.approval`. For each specified criteria there must exist a
matching approval.
**reject-approval**
This takes a list of approvals in the same format as
@ -197,8 +197,6 @@ enqueued into the pipeline.
The dictionary passed to the Gerrit pipeline `require` attribute
supports the following attributes:
.. _gerrit-pipeline-require-approval:
.. attr:: approval
This requires that a certain kind of approval be present for the
@ -260,8 +258,8 @@ enqueued into the pipeline.
This takes a list of approvals. If an approval matches the
provided criteria the change can not be entered into the
pipeline. It follows the same syntax as the :ref:`approval
pipeline requirement above <gerrit-pipeline-require-approval>`.
pipeline. It follows the same syntax as
:attr:`pipeline.require.<gerrit source>.approval`.
Example to reject a change with any negative vote::

View File

@ -221,8 +221,6 @@ enqueued into the pipeline.
The dictionary passed to the GitHub pipeline `require` attribute
supports the following attributes:
.. _github-pipeline-require-review:
.. attr:: review
This requires that a certain kind of code review be present for
@ -300,5 +298,5 @@ enqueued into the pipeline.
This takes a list of code reviews. If a code review matches the
provided criteria the pull request can not be entered into the
pipeline. It follows the same syntax as the :ref:`review
pipeline requirement above <github-pipeline-require-review>`.
pipeline. It follows the same syntax as
:attr:`pipeline.require.<github source>.review`

View File

@ -138,8 +138,6 @@ success, the pipeline reports back to Gerrit with a *Verified* vote of
There are currently two schemes for managing pipelines:
.. _independent_pipeline_manager:
.. zuul:value:: independent
Every event in this pipeline should be treated as independent
@ -158,8 +156,6 @@ success, the pipeline reports back to Gerrit with a *Verified* vote of
pipeline. In that case, the changes have already merged, so
the results can not affect any other events in the pipeline.
.. _dependent_pipeline_manager:
.. zuul:value:: dependent
The dependent pipeline manager is designed for gating. It

View File

@ -41,7 +41,7 @@ projects, it may take hours to test changes, and it is easy for
developers to create changes at a rate faster than they can be tested
and merged.
Zuul's :ref:`dependent pipeline manager<dependent_pipeline_manager>`
Zuul's :value:`dependent pipeline manager<pipeline.manager.dependent>`
allows for parallel execution of test jobs for gating while ensuring
changes are tested correctly, exactly as if they had been tested one
at a time. It does this by performing speculative execution of test

View File

@ -116,6 +116,8 @@ class ZuulDomain(Domain):
roles = {
'attr': XRefRole(innernodeclass=nodes.inline, # type: ignore
warn_dangling=True),
'value': XRefRole(innernodeclass=nodes.inline, # type: ignore
warn_dangling=True),
}
initial_data = {