From 6062cb3eb45cc84b6ee345e50cef55a1b412c9c6 Mon Sep 17 00:00:00 2001 From: Otto Liljalaakso Date: Mar 16 2024 11:50:25 +0000 Subject: [PATCH 1/2] Suggest running `fedpkg retire` only in Rawhide Apparently, at some point the retirement process has changed slightly, and `fedpkg retire` is only needed for Rawhide. Simplify the instructions to suggest doing that, and relying on Git operations to duplicate the retirement commit for Branched, if needed. This approach is consitent with the approach that is also used in other places in Package Maintainer Docs, where basic Git operations are used to manipulate dist-git where possible, and `fedpkg` commands are only used when they perform some additional tasks. Fixes #148 --- diff --git a/modules/ROOT/pages/Package_Retirement_Process.adoc b/modules/ROOT/pages/Package_Retirement_Process.adoc index 080d1f9..f50feda 100644 --- a/modules/ROOT/pages/Package_Retirement_Process.adoc +++ b/modules/ROOT/pages/Package_Retirement_Process.adoc @@ -14,8 +14,8 @@ The process is governed by xref:fesco::Policy_for_orphan_and_retired_packages.ad Packages can normally only be retired in the following branches: -* Branched (until the Final Freeze) * Rawhide +* Branched (until the Final Freeze) * EPEL branches (`epel7`, `epel8`, `epel9`, and the corresponding `-next` branches) - see xref:epel::epel-policy-retirement.adoc/[EPEL @@ -33,24 +33,22 @@ as specified in xref:packaging-guidelines::index.adoc#renaming-or-replacing-exis === Git -Run `fedpkg retire DESCRIPTION` -in Fedora branches Rawhide and Branched (if it exists at the moment) -and all EPEL branches (if applicable). +Run `fedpkg retire DESCRIPTION` in Rawhide. `DESCRIPTION` should explain why the package was retired. -Examples of good messages are _Obsoleted by bar_ and _Renamed to bar_. +Examples of good messages are _Obsoleted by _ and _Renamed to _. + +`fedpkg retire` removes all files from the branch, +adds file `dead.package` that contains `DESCRIPTION`, +and pushes the changes. -The command will remove all files from the branch, -add a file name `dead.package` containing the description -and push the changes. +If Branched currently exists and Final Freeze has not started yet, +prevent the package from being released by merging (or cherry-picking, etc.) the retirement commit into that branch. +It is not necessary to run `fedpkg retire` separately for Branched. -Do not run the command in any supported or end-of-life Fedora release branch. +Do not run `fedpkg retire` or merge a retirement commit for any supported or end-of-life Fedora release branch. Packages must not be retired from stable releases. -Start retiring from the oldest branch, -i.e. retire on Branched before you retire on Rawhide. -If you retire Rawhide before Branched, -it will still work, but will block the package in more Koji tags, -because tag inheritance will not be used automatically then. +If the package is included in EPEL, consider also xref:epel::epel-policy-retirement.adoc[EPEL Retirement policy]. === Comps From b8bdfa3d8280692f20037a084591a8aaa297c37c Mon Sep 17 00:00:00 2001 From: Otto Liljalaakso Date: Mar 16 2024 12:09:20 +0000 Subject: [PATCH 2/2] Update link to Rawhide and Branched from wiki to releases site The wiki pages were already redirecting to the releases site, so functionally nothing changes. Also, added link to Package Retirement Process, which previously just used terms Rawhide and Branched without linking to their definitions. --- diff --git a/modules/ROOT/pages/New_Package_Process_for_New_Contributors.adoc b/modules/ROOT/pages/New_Package_Process_for_New_Contributors.adoc index 0081135..c492ba1 100644 --- a/modules/ROOT/pages/New_Package_Process_for_New_Contributors.adoc +++ b/modules/ROOT/pages/New_Package_Process_for_New_Contributors.adoc @@ -235,7 +235,7 @@ will make the Fedora update system automatically close the bug when your package submitted to Rawhide stable repository. This imports into, commits, and builds only the *main* -(https://fedoraproject.org/wiki/Releases/Rawhide[Rawhide]) +(xref:releases::rawhide.adoc[Rawhide]) branch. If the push fails with this kind of message: diff --git a/modules/ROOT/pages/Package_Maintenance_Guide.adoc b/modules/ROOT/pages/Package_Maintenance_Guide.adoc index 2a3d9a2..43fba29 100644 --- a/modules/ROOT/pages/Package_Maintenance_Guide.adoc +++ b/modules/ROOT/pages/Package_Maintenance_Guide.adoc @@ -28,7 +28,7 @@ Follow xref:Installing_Packager_Tools.adoc[Installing Packager Tools]. This section lists typical fedpkg commands in a normal workflow, with short descriptions. In this workflow, -we will be operating on the https://fedoraproject.org/wiki/Releases/Rawhide[Rawhide] branch of the package. +we will be operating on the xref:releases::rawhide.adoc[Rawhide] branch of the package. === Check out a package .... @@ -313,7 +313,7 @@ fedpkg switch-branch f{PREVIOUSOSVER} fedpkg switch-branch rawhide .... -The `rawhide` branch is for https://fedoraproject.org/wiki/Releases/Rawhide[Rawhide]. +The `rawhide` branch is for xref:releases::rawhide.adoc[Rawhide]. You can maintain each branch entirely separately, if you like, laboriously copying changes between them (so long as you always stay within the xref:fesco::Updates_Policy.adoc[Updates Policy] requirements). @@ -338,7 +338,7 @@ Git aficionados may note this is a somewhat unusual workflow, but it is appropriate to the context of package management. Remember, after pushing to and building for a stable release -or a https://fedoraproject.org/wiki/Releases/Branched[Branched] release +or a xref:releases::branched.adoc[Branched] release after xref:fesco::Updates_Policy.adoc#updates-testing-activation[updates-testing activation], you will have to xref:Package_Update_Guide.adoc[submit an update] before any other Fedora users will see your build. diff --git a/modules/ROOT/pages/Package_Retirement_Process.adoc b/modules/ROOT/pages/Package_Retirement_Process.adoc index f50feda..68fc5be 100644 --- a/modules/ROOT/pages/Package_Retirement_Process.adoc +++ b/modules/ROOT/pages/Package_Retirement_Process.adoc @@ -14,8 +14,8 @@ The process is governed by xref:fesco::Policy_for_orphan_and_retired_packages.ad Packages can normally only be retired in the following branches: -* Rawhide -* Branched (until the Final Freeze) +* xref:releases::rawhide.adoc[Rawhide] +* xref:releases::branched.adoc[Branched] (until the Final Freeze) * EPEL branches (`epel7`, `epel8`, `epel9`, and the corresponding `-next` branches) - see xref:epel::epel-policy-retirement.adoc/[EPEL diff --git a/modules/ROOT/pages/Package_Update_Guide.adoc b/modules/ROOT/pages/Package_Update_Guide.adoc index ba09f2f..b19550c 100644 --- a/modules/ROOT/pages/Package_Update_Guide.adoc +++ b/modules/ROOT/pages/Package_Update_Guide.adoc @@ -21,8 +21,8 @@ This page specifically covers the update submission process. There are two significantly different package update submission workflows in Fedora: -* https://fedoraproject.org/wiki/Releases/Rawhide[Rawhide] -and https://fedoraproject.org/wiki/Releases/Branched[Branched] up to the xref:fesco::Updates_Policy.adoc#updates-testing-activation[Updates-testing Activation]. +* xref:releases::rawhide.adoc[Rawhide] +and xref:releases::branched.adoc[Branched] up to the xref:fesco::Updates_Policy.adoc#updates-testing-activation[Updates-testing Activation]. * Branched releases after Updates-testing Activation, and stable releases.