From 62e8815a5a1ec2b8224616bcb686262eb2bda9b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Luk=C3=A1=C5=A1=20Doktor?= Date: Wed, 23 Oct 2024 10:31:36 +0200 Subject: [PATCH] ci: Add documentation to cover mapping format MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit to help people with adding new entries. Signed-off-by: Lukáš Doktor --- tools/testing/gatekeeper/required-tests.yaml | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/tools/testing/gatekeeper/required-tests.yaml b/tools/testing/gatekeeper/required-tests.yaml index 4b44674642..795523bddd 100644 --- a/tools/testing/gatekeeper/required-tests.yaml +++ b/tools/testing/gatekeeper/required-tests.yaml @@ -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: