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 05a9f12 commit 7d28556
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 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, flags and labels
==== 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 Down Expand Up @@ -338,6 +338,12 @@ NOTE: Also GitHub pull requests and issues can be linked. Use the generic format
``<marker>[#<project/repo>]#<id>``, e.g.
https://github.com/os-autoinst/openQA/issues/1234[`gh#os-autoinst/openQA#1234`].

==== Flags
Currently there is only one flag for job comments supported.
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.

==== Labels
A comment can also contain labels. Use `label:<keyword>` where `<keyword>`
can be any valid character up to the next whitespace, e.g. `false_positive`.
Expand All @@ -364,7 +370,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 +569,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
`label: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 7d28556

Please sign in to comment.