Skip to content

Commit 847b31f

Browse files
committed
docs: ci: Clarify error handling
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
1 parent d841859 commit 847b31f

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/ci.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,10 @@ an error, a warning or something else.
6767
So the workflows separate the steps outputs into steps events named
6868
``err``, ``fail``, and ``warn``:
6969

70-
* ``err``: What a method return, if not captured (``|| true``), fails the CI.
70+
* ``err``: What a method that must succeed returns, if not captured
71+
(``|| true``), fails the CI. Internal to the bash methods, return codes
72+
expected to return known warnings and errors are filtered-out, deferring
73+
to the assertion step.
7174
* ``fail``: Indicates that a warning or error deemed strict was raised.
7275
Is collected at the assert job and ends the run with failure.
7376
* ``warn``: Indicates that a warning or error non-deemed strict was raised.

0 commit comments

Comments
 (0)