diff --git a/doc/source/contributor/policies/gerrit-recheck.rst b/doc/source/contributor/gerrit-recheck.rst similarity index 54% rename from doc/source/contributor/policies/gerrit-recheck.rst rename to doc/source/contributor/gerrit-recheck.rst index e9a2a0eb684..6312316d8d2 100644 --- a/doc/source/contributor/policies/gerrit-recheck.rst +++ b/doc/source/contributor/gerrit-recheck.rst @@ -9,12 +9,14 @@ being tested, while other times the failure can be caused by a previously untracked bug. Such failures are usually related to tests that interact with a live system, like functional, fullstack and tempest jobs. -Before issuing a recheck on your patch, make sure that the gate failure is not -caused by your patch. Failed job can be also caused by some infra issue, for -example unable to fetch things from external resources like git or pip due to -outage. Such failures outside of OpenStack world are not worth tracking in -launchpad and you can recheck leaving couple of words what went wrong. Data -about gate stability is collected and visualized via +Unnecessary rechecks lead to wasted resources as well as longer result times +for patches in other projects. As a consequence, before issuing a recheck, +make sure that the gate failure is not caused by your patch. A failed job can +also be caused by some infra issue, for example the inability to fetch things +from external resources like git or pip due to an outage. Such failures outside +of the OpenStack world are not worth tracking in launchpad and you can recheck +by leaving a short comment indicating what went wrong. Data about gate +stability is collected and visualized via `Grafana `_. Please, do not recheck without providing the bug number for the failed job. @@ -24,3 +26,12 @@ exist yet, create one so other team members can have a look. It helps us maintain better visibility of gate failures. You can find how to troubleshoot gate failures in the :ref:`Gate Failure Triage ` documentation. + +Here are some real examples of proper rechecks: + +- Spurious issue in other component: **recheck tempest-integrated-storage : + intermittent failure nova bug #1836754** +- Deployment issue on the job: **recheck cinder-plugin-ceph-tempest timed out, + errors all over the place** +- External service failure: **recheck Third party grenade : Failed to retrieve + .deb packages** diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index e4480b81977..736d0a61552 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -47,6 +47,14 @@ Neutron Policies policies/index +Gerrit Rechecks +--------------- + +.. toctree:: + :maxdepth: 2 + + gerrit-recheck + Neutron Stadium --------------- diff --git a/doc/source/contributor/policies/index.rst b/doc/source/contributor/policies/index.rst index c40a79f1000..95ba2b9ed1f 100644 --- a/doc/source/contributor/policies/index.rst +++ b/doc/source/contributor/policies/index.rst @@ -32,4 +32,3 @@ items. code-reviews release-checklist thirdparty-ci - gerrit-recheck