PR#64: Update information about decision contexts usage in the gating - fedora-ci/docs

fedora-ci / docs

#64 Update information about decision contexts usage in the gating

Merged 3 years ago by psss. Opened 3 years ago by vmaljulin.

fedora-ci/ vmaljulin/docs RHELWF-2497 into master

Decision contexts usage in the gating

Valerij Maljulin • 3 years ago

6a16470

modules/ROOT/pages/gating.adoc

file modified

+10 -6

		`@@ -12,7 +12,7 @@`
		`--- !Policy`
		`product_versions:`
		`- fedora-*`
		`- decision_context: bodhi_update_push_testing`
		`+ decision_contexts: [bodhi_update_push_testing]`
		`subject_type: koji_build`
		`rules:`
		`- !PassingTestCaseRule {test_case_name: fedora-ci.koji-build.tier0.functional}`
		`@@ -22,7 +22,7 @@`
		`--- !Policy`
		`product_versions:`
		`- fedora-*`
		`- decision_context: bodhi_update_push_stable`
		`+ decision_contexts: [bodhi_update_push_stable]`
		`subject_type: koji_build`
		`rules:`
		`- !PassingTestCaseRule {test_case_name: fedora-ci.koji-build.tier0.functional}`
		`@@ -32,10 +32,14 @@`
		TIP: To add another test just extend the `rules` list with additional `!PassingTestCaseRule`.

		`This will enable gating for all Fedora releases based on the result of the CI xref:pipeline.adoc[Pipeline].`
		- The `decision_context` is to be https://pagure.io/greenwave/issue/282[clarified].
		`- Rules define test cases that should be considered for the gating decision, in this case`
		- `fedora-ci.koji-build.tier0.functional` which are tests that were run
		- in the CI based on the configuration in `tests/tests.yml` in package's dist-git.
		`+ A decision context identifies set of policies used for a specific gating.`
		+ For example, `bodhi_update_push_stable` decision context is used for gating RPM builds in Bodhi updates before getting to the stable repository.
		`+`
		+ The `decision_contexts` should match in both remote rules file and the policy in the Greenwave configuration (at least one decision context).
		+ Rules define test cases that should be considered for the gating decision, in this case `fedora-ci.koji-build.tier0.functional`
		+ which are tests that were run in the CI based on the configuration in `tests/tests.yml` in package's dist-git.
		+ If no tests are required for the particular decision context(s) rules should be set to an empty list, i. e. `rules: []`,
		`+ otherwise Greenwave will return, that it could not find any applicable policies.`

		`Other tests which can be enabled for gating:`

vmaljulin commented 3 years ago

This fixes greenwave#282 (https://pagure.io/greenwave/issue/282)

vmaljulin commented 3 years ago

@adamwill @lholecek please review

lholecek commented on line 24 of modules/ROOT/pages/gating.adoc 3 years ago

"Why" is not explained and "main policy" is not defined.

Maybe:

A decision context identifies set of policies used for a specific gating. For
example, `bodhi_update_push_stable` decision context is used for gating RPM
builds in Bodhi updates before getting to the stable repository.

If you create the `gating.yaml` file, make sure that policies for all required
decision contexts are defined. Gating for any missing decision context will
fail.

1 new commit added

fixup! Update information about decision contexts usage in the gating This fixes greenwave#282 (https://pagure.io/greenwave/issue/282)

3 years ago

vmaljulin commented 3 years ago

Updated

lholecek commented 3 years ago

+1 from me, but someone else should review.

@adamwill Can you help review the doc change?

psss commented 3 years ago

Looks good to me. Thanks for the clarification. Just two minor suggestions:

In the Fedora CI docs we keep one sentence per line (helps with future changes/diffs)
It's a good practice to keep the first line of the commit short and put the details after a blank line

rebased onto d8fda1b

3 years ago

vmaljulin commented 3 years ago

@psss Updated

rebased onto 6a16470

3 years ago

psss commented 3 years ago

Thanks!