Skip to content

Commit b39979c

Browse files
Document the sync_job_statuses config option (#907)
Document the `sync_job_statuses` config option Related to packit/packit-service#1943. Merge after packit/packit-service#2470. Reviewed-by: Laura Barcziová
2 parents 030c798 + 5dd1bc0 commit b39979c

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

docs/configuration/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -774,6 +774,13 @@ The information about releases [is retrieved from Bodhi](https://bodhi.fedorapro
774774
cache and required availability on Copr, it might take a while to get the
775775
newest state.
776776

777+
#### sync_test_job_statuses_with_builds
778+
779+
(*bool*) When set to `true` (the default), test job statuses are updated together with their corresponding
780+
build job statuses. When set to `false`, while test jobs are waiting for their corresponding build jobs
781+
to finish, their statuses remain in pending state and only build job statuses are updated, for example with
782+
`SRPM build is in progress...` or `Starting RPM build...`.
783+
777784
## User configuration file
778785

779786
:::danger

docs/configuration/upstream/tests.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,14 @@ The labels should be in the format of comma-separated string.
226226
You can also configure [`test_command.default_labels`](/docs/configuration#default_labels) to allow commonly used job combinations
227227
to be triggered without the need for manual specification.
228228

229+
## Test job statuses
230+
By default, while test jobs are waiting for their corresponding build jobs to finish,
231+
their statuses share updates with the build jobs, for example `SRPM build is in progress...`
232+
or `Starting RPM build...`. This can be disabled by setting
233+
[`sync_test_job_statuses_with_builds`](/docs/configuration#sync_test_job_statuses_with_builds)
234+
to `false`. If disabled, test job statuses remain in pending state until their corresponding
235+
build jobs are finished.
236+
229237
## Creating Tests
230238

231239
The easiest way to get started with defining tests is to use the [tmt][tmt] tool

0 commit comments

Comments
 (0)