From 5dd1bc09af37bdac76745b9cacbd28b472d39ad1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nikola=20Forr=C3=B3?= Date: Wed, 17 Jul 2024 14:46:20 +0200 Subject: [PATCH] Document the `sync_test_job_statuses_with_builds` config option MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Nikola Forró --- docs/configuration/index.md | 7 +++++++ docs/configuration/upstream/tests.md | 8 ++++++++ 2 files changed, 15 insertions(+) diff --git a/docs/configuration/index.md b/docs/configuration/index.md index e1a0cf04fb..5a5bf02c3b 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -774,6 +774,13 @@ The information about releases [is retrieved from Bodhi](https://bodhi.fedorapro cache and required availability on Copr, it might take a while to get the newest state. +#### sync_test_job_statuses_with_builds + +(*bool*) When set to `true` (the default), test job statuses are updated together with their corresponding +build job statuses. When set to `false`, while test jobs are waiting for their corresponding build jobs +to finish, their statuses remain in pending state and only build job statuses are updated, for example with +`SRPM build is in progress...` or `Starting RPM build...`. + ## User configuration file :::danger diff --git a/docs/configuration/upstream/tests.md b/docs/configuration/upstream/tests.md index b8f3b42e7a..d272336c1f 100644 --- a/docs/configuration/upstream/tests.md +++ b/docs/configuration/upstream/tests.md @@ -226,6 +226,14 @@ The labels should be in the format of comma-separated string. You can also configure [`test_command.default_labels`](/docs/configuration#default_labels) to allow commonly used job combinations to be triggered without the need for manual specification. +## Test job statuses +By default, while test jobs are waiting for their corresponding build jobs to finish, +their statuses share updates with the build jobs, for example `SRPM build is in progress...` +or `Starting RPM build...`. This can be disabled by setting +[`sync_test_job_statuses_with_builds`](/docs/configuration#sync_test_job_statuses_with_builds) +to `false`. If disabled, test job statuses remain in pending state until their corresponding +build jobs are finished. + ## Creating Tests The easiest way to get started with defining tests is to use the [tmt][tmt] tool