Skip to content

Commit a48b752

Browse files
committed
Update description of /test-os-variants GH CI workflow
1 parent b0b89b4 commit a48b752

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -373,8 +373,22 @@ tests, and PRs usually just run a few tests so that flakes are much less likely
373373
to ruin the result.
374374

375375
To test a PR on all supported os versions (including rhel) there is a
376-
`test-os-variants`_ workflow running the tests on a comment in a PR.
377-
Running it requires admin repository permissions.
376+
`test-os-variants`_ workflow running the tests on a comment in a PR. Running
377+
it requires admin repository permissions. The usage is documented at the top of
378+
the workflow file. The test should pass before merging. If it fails for some
379+
variant and it is okay to wait for release of the tested feature in a variant,
380+
it can be marked by ``feature pending`` label so it is easily clear why the PR is
381+
waiting. Other option to make the test pass and merge the PR would be disabling
382+
the feature temporarily for the variant with a reference to a ticket
383+
tracking/describing the disabling
384+
(`example <https://github.com/rhinstaller/kickstart-tests/commit/db5a3ac2b08a7ed3d0b9df5d7ca1964697ae4823>`__
385+
for issue tracked externally,
386+
`example <https://github.com/rhinstaller/kickstart-tests/pull/1271>`__ for an
387+
`issue <https://github.com/rhinstaller/kickstart-tests/issues/1270>`__ tracked in
388+
the repository). If the test should not be run on the variant at all it can be
389+
disabled explicitly for the variant
390+
(`example <https://github.com/rhinstaller/kickstart-tests/pull/1444>`__).
391+
378392

379393
Service jobs
380394
------------
@@ -397,6 +411,7 @@ GitHub's infrastructure and can be run manually by a developer.
397411
.. _skip-testtypes file: ./containers/runner/skip-testtypes
398412
.. _GitHub Daily run workflows page: https://github.com/rhinstaller/kickstart-tests/actions?query=workflow%3A%22Daily+run%22
399413
.. _tmt workflow: ./.github/workflows/testingfarm.yml
414+
.. _test-os-variants: ./.github/workflows/test-os-variants.yml
400415
.. _TMT: https://docs.testing-farm.io/
401416
.. _Travis: https://travis-ci.com/
402417
.. _.travis.yml: ./.travis.yml

0 commit comments

Comments
 (0)