From cd056521e612164947266cf911b592048f131eb5 Mon Sep 17 00:00:00 2001 From: Petr Písař Date: Mar 24 2022 16:04:02 +0000 Subject: Correct fedpkg request-branch commands and workflows around Addresses . It also explains the service levels and links to module review. --- diff --git a/modules/ROOT/pages/building-modules/fedora/adding-new-modules.adoc b/modules/ROOT/pages/building-modules/fedora/adding-new-modules.adoc index f7eed53..bd90320 100644 --- a/modules/ROOT/pages/building-modules/fedora/adding-new-modules.adoc +++ b/modules/ROOT/pages/building-modules/fedora/adding-new-modules.adoc @@ -21,16 +21,16 @@ Requesting new stream branches for existing packages is done with `fedpkg`, and To create a new branch for a package that shares a name with the module (e.g. "postgresql"), run the following command which will create the package stream branch as well as the module and its stream branch together: ---- -$ fedpkg request-branch --repo=NAME --sl rawhide:2020-12-01 -- BRANCH +$ fedpkg request-branch --repo=NAME BRANCH --sl SERVICE_LEVEL:YYYY-MM-DD ---- * `NAME` — name of the package and the module * `BRANCH` — name of the stream branch of the package and the module -* `rawhide:2020-12-01` — expected end of life, must end with either `12-01` or `06-01`. Right now, this is not actively used to do anything useful, although some systems might block you from maintaining your module. Please choose a date far in the future so you're not affected. [Work to fix this is in progress](https://tree.taiga.io/project/modularity-wg/epic/3). +* `SERVICE_LEVEL:YYYY-MM-DD`[[SLA]] — expected end of life (e.g. `bug_fixes:2020-12-01`). The date must end with either `12-01` or `06-01`. There are various service levels like `bug_fixes`, `security_fixes`, and `rawhide`. Right now, this is used for locking the branch from pushing new commits there. You can change the date later with a https://pagure.io/releng/new_issue?template=module_eol[releng ticket]. Current dates are stored in https://pdc.fedoraproject.org/rest_api/v1/component-branch-slas/?branch_type=rpm[Product Definition Center]. Other option is to choose a date far in the future so you're not affected. (https://tree.taiga.io/project/modularity-wg/epic/3[Work to fix this is in progress].) If this package does not share a name with the module (such as for dependencies), then only request the stream branch for this package: ---- -$ fedpkg request-branch --repo=NAME --no-auto-module --sl rawhide:2020-12-01 -- BRANCH +$ fedpkg request-branch --repo=NAME BRANCH --no-auto-module --sl SERVICE_LEVEL:YYYY-MM-DD ---- * `--no-auto-module` — Skip the creation of a module of the same name @@ -43,30 +43,33 @@ The last thing to do is to import the RPM sources into dist-git. Please refer to == Module Definition -For your module definition, you also need to have a dist-git **repository**, this time under `dist-git/modules`, with an appropriate **stream branch**. +For your module definition, you also need to have a dist-git **repository**, this time under `dist-git/modules`, with an appropriate **stream branch**. New modules also need to go through a https://bugzilla.redhat.com/buglist.cgi?component=Module%20Review&product=Fedora%20Modules[module review in Bugzilla] adhering to xref:policies/packaging-guidelines.adoc[Fedora Packagining Guidelines for Modules]. === Repositories and Stream Branches — New modules To request a new module repository in dist-git run: ---- -$ fedpkg request-repo --namespace modules --exception NAME -$ fedpkg request-branch --namespace modules --repo NAME BRANCH +$ fedpkg request-repo --namespace modules NAME BUG +$ fedpkg request-branch --namespace modules --repo NAME BRANCH --sl SERVICE_LEVEL:YYYY-MM-DD ---- * `NAME` — name of the module +* `BUG` — bug number with an approved https://bugzilla.redhat.com/buglist.cgi?component=Module%20Review&product=Fedora%20Modules[module review in Bugzilla] * `BRANCH` — name of the stream branch of the module +* `SERVICE_LEVEL:YYYY-MM-DD` — expected end of life. See <> for more details. Stream end of lives are available in https://pdc.fedoraproject.org/rest_api/v1/component-branch-slas/?branch_type=module[Product Definition Center]. === Repositories and Stream Branches — Existing modules to request a new stream branch, run: ---- -$ fedpkg request-branch --namespace modules --repo NAME BRANCH +$ fedpkg request-branch --namespace modules --repo NAME BRANCH --sl SERVICE_LEVEL:YYYY-MM-DD ---- * `NAME` — name of the module * `BRANCH` — name of the stream branch of the module +* `SERVICE_LEVEL:YYYY-MM-DD` — expected end of life. See <> for more details. === Write and push the modulemd