Generate docs

enterprise-contract · Jan 27, 2025 · 782c37b · 782c37b
1 parent 91208aa
commit 782c37b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/antora/docs/modules/ROOT/pages/release_policy.adoc b/antora/docs/modules/ROOT/pages/release_policy.adoc
@@ -206,6 +206,13 @@ Rules included:
 * xref:release_policy.adoc#rpm_ostree_task__builder_image_param[rpm-ostree Task: Builder image parameter]
 * xref:release_policy.adoc#rpm_ostree_task__rule_data[rpm-ostree Task: Rule data]
 
+| [#redhat_rpms]`redhat_rpms`
+a| Include the set of policy rules required for building Red Hat RPMs.
+
+Rules included:
+
+* xref:release_policy.adoc#rpm_pipeline__invalid_pipeline[RPM Pipeline: Task version invalid_pipeline]
+
 | [#rhtap-multi-ci]`rhtap-multi-ci`
 a| A set of policy rules to validate artifacts built using RHTAP Multi-CI pipelines.
 
@@ -990,6 +997,23 @@ Verify an attestation created by the RHTAP Multi-CI build pipeline is present.
 * Code: `rhtap_multi_ci.attestation_found`
 * https://github.com/enterprise-contract/ec-policies/blob/{page-origin-refhash}/policy/release/rhtap_multi_ci/rhtap_multi_ci.rego#L16[Source, window="_blank"]
 
+[#rpm_pipeline_package]
+== link:#rpm_pipeline_package[RPM Pipeline]
+
+This package provides rules for verifying the RPMs are built in an approved pipeline
+
+* Package name: `rpm_pipeline`
+
+[#rpm_pipeline__invalid_pipeline]
+=== link:#rpm_pipeline__invalid_pipeline[Task version invalid_pipeline]
+
+The Tekton Task used specifies an invalid pipeline. The Task is annotated with `build.appstudio.redhat.com/pipeline` annotation, which must be in the set of `allowed_rpm_build_pipelines` in the rule data.
+
+* Rule type: [rule-type-indicator failure]#FAILURE#
+* FAILURE message: `Task %q uses invalid pipleline %s, which is not in the list of valid pipelines: %s`
+* Code: `rpm_pipeline.invalid_pipeline`
+* https://github.com/enterprise-contract/ec-policies/blob/{page-origin-refhash}/policy/release/rpm_pipeline/rpm_pipeline.rego#L18[Source, window="_blank"]
+
 [#rpm_repos_package]
 == link:#rpm_repos_package[RPM Repos]
 

diff --git a/antora/docs/modules/ROOT/partials/release_policy_nav.adoc b/antora/docs/modules/ROOT/partials/release_policy_nav.adoc
@@ -4,6 +4,7 @@
 *** xref:release_policy.adoc#minimal[minimal]
 *** xref:release_policy.adoc#policy_data[policy_data]
 *** xref:release_policy.adoc#redhat[redhat]
+*** xref:release_policy.adoc#redhat_rpms[redhat_rpms]
 *** xref:release_policy.adoc#rhtap-multi-ci[rhtap-multi-ci]
 *** xref:release_policy.adoc#slsa3[slsa3]
 ** Release Rules
@@ -74,6 +75,8 @@
 *** xref:release_policy.adoc#rhtap_multi_ci_package[RHTAP Multi-CI]
 **** xref:release_policy.adoc#rhtap_multi_ci__attestation_format[SLSA Provenance Attestation Format]
 **** xref:release_policy.adoc#rhtap_multi_ci__attestation_found[SLSA Provenance Attestation Found]
+*** xref:release_policy.adoc#rpm_pipeline_package[RPM Pipeline]
+**** xref:release_policy.adoc#rpm_pipeline__invalid_pipeline[Task version invalid_pipeline]
 *** xref:release_policy.adoc#rpm_repos_package[RPM Repos]
 **** xref:release_policy.adoc#rpm_repos__ids_known[All rpms have known repo ids]
 **** xref:release_policy.adoc#rpm_repos__rule_data_provided[Known repo id list provided]