diff options
| author | Zuul <zuul@review.opendev.org> | 2020-05-16 17:32:14 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2020-05-16 17:32:14 +0000 |
| commit | 931eac4030cc7e8e1a13a1e32947db90f37219a5 (patch) | |
| tree | 4ec0e70d458f61be7079186656c0317d405a099a /doc | |
| parent | 70dd710ed723ab0bfb96b6a7901a5a14178ed57b (diff) | |
| parent | af2c919ca727a80170aeac396441e37b50fc753b (diff) | |
| download | zuul-931eac4030cc7e8e1a13a1e32947db90f37219a5.tar.gz | |
Merge "Report dequeued changes via Github checks API"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/reference/drivers/github.rst | 4 | ||||
| -rw-r--r-- | doc/source/reference/pipeline_def.rst | 13 |
2 files changed, 15 insertions, 2 deletions
diff --git a/doc/source/reference/drivers/github.rst b/doc/source/reference/drivers/github.rst index c2c085eca..df649d3eb 100644 --- a/doc/source/reference/drivers/github.rst +++ b/doc/source/reference/drivers/github.rst @@ -366,8 +366,8 @@ itself. Status name, description, and context is taken from the pipeline. .. attr:: check If the reporter should utilize github's checks API to set the commit - status, this must be set to ``in_progress``, ``success`` or ``failure`` - (depending on which status the reporter should report). + status, this must be set to ``in_progress``, ``success``, ``failure`` + or ``cancelled`` (depending on which status the reporter should report). .. attr:: comment :default: true diff --git a/doc/source/reference/pipeline_def.rst b/doc/source/reference/pipeline_def.rst index e2c2d9587..da13570f7 100644 --- a/doc/source/reference/pipeline_def.rst +++ b/doc/source/reference/pipeline_def.rst @@ -219,6 +219,13 @@ success, the pipeline reports back to Gerrit with ``Verified`` vote of The introductory text in reports when an item is dequeued without running any jobs. Empty by default. + .. attr:: dequeue-message + :default: Build canceled. + + The introductory text in reports when an item is dequeued. + The dequeue message only applies if the item was dequeued without + a result. + .. attr:: footer-message Supplies additional information after test results. Useful for @@ -354,6 +361,12 @@ success, the pipeline reports back to Gerrit with ``Verified`` vote of These reporters describe what Zuul should do when a pipeline is disabled. See ``disable-after-consecutive-failures``. + .. attr:: dequeue + + These reporters describe what Zuul should do if an item is + dequeued. The dequeue reporters will only apply, if the item + was dequeued without a result. + The following options can be used to alter Zuul's behavior to mitigate situations in which jobs are failing frequently (perhaps due to a problem with an external dependency, or unusually high |