ci: Add documentation to cover mapping format

to help people with adding new entries.

Signed-off-by: Lukáš Doktor <ldoktor@redhat.com>
This commit is contained in:
Lukáš Doktor 2024-10-23 10:31:36 +02:00
parent 64306dc888
commit 62e8815a5a
No known key found for this signature in database
GPG Key ID: 26B362E47FCF22C1

View File

@ -24,6 +24,19 @@ paths:
mapping:
# Mapping of set-of-tests to required test names and/or test name regexps
#
# Format is (test name includes workflow!):
# {set-of-tests-label}:
# names:
# - {required-test-name1}
# - {required-test-name2}
# regexps: "{python-regular-expression-matching-required-tests}|{another-regexp}|{yet-another-regexp}"
# required-labels:
# - {label-required-to-run-those-tests}
#
# TODO: Add support for "depends" to automatically add dependant set-of-tests
# (eg. "build" is required for "test")
# TODO: Add support for "ignore:" to remove individual tests from regexps
test:
# Checks the basic functional tests work
names:
@ -83,8 +96,6 @@ mapping:
- Kata Containers CI / kata-containers-ci-on-push / run-metrics-tests / run-metrics (qemu)
required-labels:
- ok-to-test
# TODO: Add support for "depends" to automatically add dependant set-of-tests
# (eg. "build" is required for "test")
build:
# Checks that the kata-containers static tarball is created
names: