Skip to content

Commit

Permalink
Add documentation for flag:carryover
Browse files Browse the repository at this point in the history
  • Loading branch information
asdil12 committed Nov 16, 2023
1 parent 692eeaa commit 29a3102
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions docs/UsersGuide.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ image::images/review_badges.png[Review badges]

(To simplify, checking for false-negatives is not considered here.)

=== Bug references and labels
=== Bug references, labels and flags
==== Bug references
It is possible to reference a bug by writing `<bugtracker_shortname>#<bug_nr>`
in a comment, e.g. `bsc#1234`. It is also possible to spell out the full URL,
Expand All @@ -316,6 +316,8 @@ shortened automatically. A bug reference is rendered as link and a bug icon
is displayed for the job in various places as shown in the figure below.
A comment containing a bug reference will also be
<<UsersGuide.asciidoc#carry-over,carried over>> to reduce manual review work.
Refer to the Flags section below for other ways to trigger automated comment
carryover.

WARNING: If you want to reference a bug without making it count as a bug
reference you need to wrap it into a label (see subsequent section), e.g.
Expand Down Expand Up @@ -354,6 +356,13 @@ NOTE: A label containing a bug reference will still be treated as a label,
not a bugref. The bugref will still be rendered as a link. That means no bug
icon is shown and the comment does *not* become subject to carry over.

==== Flags
Currently there is only one flag for job comments supported.
===== flag:carryover
Adding `flag:carryover` to a comment, will result in this comment being
<<UsersGuide.asciidoc#carry-over,carried over>> to a new job failing for
the same reason, without a bugref required.

===== Overwrite result of job
One special label format is available which allows to forcefully overwrite the
result of an openQA job using a convenient openQA comment. The expected format
Expand All @@ -364,7 +373,7 @@ operator permissions.

NOTE: `force_result`-labels are evaluated when when a comment is
<<UsersGuide.asciidoc#carry-over,carried over>>. However, the carry over will
only happen when the comment *also* contains a bug reference.
only happen when the comment *also* contains a bug reference or `flag:carryover`.

=== Distinguish product and test issues bugref https://github.com/os-autoinst/openQA/pull/708[gh#708]

Expand Down Expand Up @@ -563,7 +572,9 @@ prefix the status with the build number.
Many test failures within the same scenario might be due to the same reason.
To avoid human reviewers having to add the same bug references again and
again, bug references are carried over from previous failures in the same
scenario if a job fails. This idea is inspired by the
scenario if a job fails. The same behaviour can be achieved by adding
`flag:carryover` to a comment.
This idea is inspired by the
https://wiki.jenkins-ci.org/display/JENKINS/Claim+plugin[Claim plugin] for
Jenkins.

Expand Down

0 comments on commit 29a3102

Please sign in to comment.