From 4a410ccbe4711b0fb4ae0ef357eb48167d78e290 Mon Sep 17 00:00:00 2001 From: Vít Ondruch Date: Sep 07 2023 14:20:25 +0000 Subject: [PATCH 1/5] Describe usage of macros for side-tag Please note that the macros were approved and implemented in: https://pagure.io/fesco/issue/3046 https://pagure.io/releng/issue/11254 --- diff --git a/modules/ROOT/pages/Package_Update_Guide.adoc b/modules/ROOT/pages/Package_Update_Guide.adoc index c7a9d70..4aab2df 100644 --- a/modules/ROOT/pages/Package_Update_Guide.adoc +++ b/modules/ROOT/pages/Package_Update_Guide.adoc @@ -445,6 +445,33 @@ This can be achieved with `fedpkg` as follows: fedpkg remove-side-tag ---- +==== Using macros in a side tag + +Koji allows macros to be set in a side tag, +changing the configuration for builds done there. +This is useful in certain scenarios. +For example when performing +xref:packaging-guidelines::index.adoc#bootstrapping[bootstrapping], +the following commands may be used: + +---- +$ koji edit-sidetag --rpm-macro _with_bootstrap=1 f39-build-side-7863 +$ koji edit-sidetag --remove-rpm-macro _with_bootstrap f39-build-side-7863 +---- + +The following command can be used to review macros configured for the side tag: + +---- +koji list-history --tag f39-build-side-7863 +---- + +While modifying the macro configuration on side-tags can be useful, +it can also be problematic. +As such, +macros must be approved by FESCo +and the list of currently supported macros is available in the +xref:fesco:Policy_for_buildroot_macros.adoc[Policy for Buildroot Macros]. + === Bodhi multi package updates You can also create an update with multiple packages directly in Bodhi, From b0f00cde4ab030ea80522d1103e188758d38df5b Mon Sep 17 00:00:00 2001 From: Vít Ondruch Date: Sep 07 2023 14:20:25 +0000 Subject: [PATCH 2/5] Remove the bootstrapping references to make the document more generic. --- diff --git a/modules/ROOT/pages/Package_Update_Guide.adoc b/modules/ROOT/pages/Package_Update_Guide.adoc index 4aab2df..1d21373 100644 --- a/modules/ROOT/pages/Package_Update_Guide.adoc +++ b/modules/ROOT/pages/Package_Update_Guide.adoc @@ -447,22 +447,21 @@ fedpkg remove-side-tag ==== Using macros in a side tag -Koji allows macros to be set in a side tag, -changing the configuration for builds done there. -This is useful in certain scenarios. -For example when performing -xref:packaging-guidelines::index.adoc#bootstrapping[bootstrapping], -the following commands may be used: +Koji allows macros to be set in a side tag. +This is useful in certain scenarios, +such as changing configuration of builds in this side tag +without changing their sources. +The following commands may be used to set and unset macro respectively: ---- -$ koji edit-sidetag --rpm-macro _with_bootstrap=1 f39-build-side-7863 -$ koji edit-sidetag --remove-rpm-macro _with_bootstrap f39-build-side-7863 +$ koji edit-sidetag --rpm-macro = +$ koji edit-sidetag --remove-rpm-macro ---- The following command can be used to review macros configured for the side tag: ---- -koji list-history --tag f39-build-side-7863 +$ koji list-history --tag ---- While modifying the macro configuration on side-tags can be useful, From 30afcf98589318ef6a81320a332319b9f3142d55 Mon Sep 17 00:00:00 2001 From: Vít Ondruch Date: Sep 07 2023 14:20:25 +0000 Subject: [PATCH 3/5] Add TIP about `koji edit-sidetag` command --- diff --git a/modules/ROOT/pages/Package_Update_Guide.adoc b/modules/ROOT/pages/Package_Update_Guide.adoc index 1d21373..3ce10cf 100644 --- a/modules/ROOT/pages/Package_Update_Guide.adoc +++ b/modules/ROOT/pages/Package_Update_Guide.adoc @@ -458,6 +458,9 @@ $ koji edit-sidetag --rpm-macro = $ koji edit-sidetag --remove-rpm-macro ---- +TIP: Please make sure `python3-koji-cli-plugins` is installed on your sytem +to have the `koji edit-sidetag` command available. + The following command can be used to review macros configured for the side tag: ---- From bf81dfcac05d03432bf7d50a610961574c5db401 Mon Sep 17 00:00:00 2001 From: Vít Ondruch Date: Sep 07 2023 14:20:25 +0000 Subject: [PATCH 4/5] Info about `koji taginfo` might be also useful. --- diff --git a/modules/ROOT/pages/Package_Update_Guide.adoc b/modules/ROOT/pages/Package_Update_Guide.adoc index 3ce10cf..b2d61f7 100644 --- a/modules/ROOT/pages/Package_Update_Guide.adoc +++ b/modules/ROOT/pages/Package_Update_Guide.adoc @@ -461,9 +461,10 @@ $ koji edit-sidetag --remove-rpm-macro TIP: Please make sure `python3-koji-cli-plugins` is installed on your sytem to have the `koji edit-sidetag` command available. -The following command can be used to review macros configured for the side tag: +The following commands can be used to review macros configured for the side tag: ---- +$ koji taginfo $ koji list-history --tag ---- From e183215134059970bfe71bdcc1bbaeb5b6805d4e Mon Sep 17 00:00:00 2001 From: Vít Ondruch Date: Sep 07 2023 14:20:25 +0000 Subject: [PATCH 5/5] Document that there is a gap before the macros take an effect. --- diff --git a/modules/ROOT/pages/Package_Update_Guide.adoc b/modules/ROOT/pages/Package_Update_Guide.adoc index b2d61f7..30b61ed 100644 --- a/modules/ROOT/pages/Package_Update_Guide.adoc +++ b/modules/ROOT/pages/Package_Update_Guide.adoc @@ -468,6 +468,10 @@ $ koji taginfo $ koji list-history --tag ---- +TIP: Please note that the macro changes won't take effect immediately. +It is necessary to wait using `$ koji wait-repo ` command +until the repository data is refreshed. + While modifying the macro configuration on side-tags can be useful, it can also be problematic. As such,