Skip to content

Commit

Permalink
Update documentation for only_include
Browse files Browse the repository at this point in the history
  • Loading branch information
Hook25 committed Aug 16, 2024
1 parent 76d07e0 commit 9df9ada
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions docs/reference/launcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,25 @@ Note: To clear the exclude list use...

...in your 'last' config.

``only_include``
List of regex patterns that job ids will be matched against. Checkbox will
only run the matching jobs, their dependencies and any job included in the
testplan bootstrap section. This is useful to re-run the failing subset of
jobs included in a test plan

Only run ``bluetooth`` jobs and their dependencies:

.. code-block:: ini
[test selection]
only_include = .*bluetooth.*
.. note::
``exclude`` takes precedence over ``only_include``.

.. note::
You can use ``only_include`` only to select jobs already included in a test
plan. You can not use it to include additional tests in a test plan.

.. _launcher_ui:

Expand All @@ -227,7 +246,7 @@ This section controls which type of UI to use.
* ``silent`` skips the tests that would require human interaction. This UI
type requires forcing test selection and test plan selection. It's not
'silent' in the traditional command-line tool sense.
* ``converged`` launches the QML interface. It requires ``checkbox-converged``
* ``converged`` launches the QML interface. It requires ``checkbox-converged``
to be installed on your system.
* ``converged-silent`` launches the QML interface and skips the tests that
would require human interaction. It requires ``checkbox-converged`` to be
Expand Down Expand Up @@ -287,7 +306,7 @@ This section controls which type of UI to use.

.. note::

You can use ``auto-retry=no`` inline in the test plan to exclude a job
You can use ``auto-retry=no`` inline in the test plan to exclude a job
from auto-retrying. For more details, see :doc:`../how-to/launcher/auto-retry`.

``max_attempts``
Expand All @@ -300,7 +319,7 @@ This section controls which type of UI to use.
the testing session. This can be useful when the jobs rely on external
factors (e.g. a WiFi access point) and you want to wait before retrying the
same job. Default value: ``1``.

Restart section
===============

Expand Down

0 comments on commit 9df9ada

Please sign in to comment.