Skip to content

Commit

Permalink
Document the sync_job_statuses config option (#907)
Browse files Browse the repository at this point in the history
Document the `sync_job_statuses` config option

Related to packit/packit-service#1943.
Merge after packit/packit-service#2470.

Reviewed-by: Laura Barcziová
  • Loading branch information
softwarefactory-project-zuul[bot] authored Jul 23, 2024
2 parents 030c798 + 5dd1bc0 commit b39979c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/configuration/upstream/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b39979c

Please sign in to comment.