From Fedora Project Wiki

(→‎Koji: remove EPEL special case)
m (update epel branch name examples)
(24 intermediate revisions by 13 users not shown)
Line 4: Line 4:
  
 
== Procedure ==
 
== Procedure ==
{{admon/warning|Retire only in development/EPEL branches!|Do not retire packages in other branches than Branched (until the [[Schedule|Final Freeze]]), Rawhide (master) and EPEL branches (el5, el6, epel7).}}
+
{{admon/warning|Retire only in development/EPEL branches!|Do not retire packages in other branches than Branched (until the [[Schedule|Final Freeze]]), Rawhide (master) and EPEL branches (epel7, epel8).
 +
When you need to add package from EPEL to any RHEL release, only retire EPEL branch when package is released in that RHEL release.}}
 
Please execute the following steps in the order indicated.
 
Please execute the following steps in the order indicated.
  
 
=== RPM ===
 
=== RPM ===
If the package is being replaced by some other package, ensure that the Obsoletes/Provides tags are properly set by the new package, see [[Packaging:Guidelines#Renaming.2FReplacing_Existing_Packages|Renaming/Replacing Guidelines]].
+
If the package is being replaced by some other package, ensure that the Obsoletes/Provides tags are properly set by the new package, see [https://docs.fedoraproject.org/en-US/packaging-guidelines/#renaming-or-replacing-existing-packages Renaming/Replacing Guidelines].
  
 
=== GIT ===
 
=== GIT ===
Run <code>fedpkg retire DESCRIPTION</code> in all branches that need to be retired starting with the oldest branch (e.g. retire on f21 before you retire on master)
+
Run <code>fedpkg retire DESCRIPTION</code> in all non-stable Fedora branches and EPEL
 +
branches, if applicable. The retiring needs to start with the oldest branch
 +
(e.g. retire on f31 before you retire on rawhide)
 +
 
  
 
==== Remarks ====
 
==== Remarks ====
Line 17: Line 21:
 
** <code>Obsoleted by bar</code>
 
** <code>Obsoleted by bar</code>
 
** <code>Renamed to bar</code>
 
** <code>Renamed to bar</code>
* The command will remove all files from the branch, add a file name <code>dead.package</code> containing the description and push the changes. Starting with fedpkg 1.13 it will also retire the package in package DB.
+
* The command will remove all files from the branch, add a file name <code>dead.package</code> containing the description and push the changes.
 
* <code>git rm</code> all files in the other branches '''only if''' there are special factors at work, like licensing issues, or package being removed completely from Fedora.
 
* <code>git rm</code> all files in the other branches '''only if''' there are special factors at work, like licensing issues, or package being removed completely from Fedora.
 
* If you retired master before other older branches you want to retire, just continue with the older branches. It will still work, but will block the package in more Koji tags, because tag inheritance will not be used automatically then.
 
* If you retired master before other older branches you want to retire, just continue with the older branches. It will still work, but will block the package in more Koji tags, because tag inheritance will not be used automatically then.
 
=== Package DB ===
 
Ensure that the package is marked as retired in [https://admin.fedoraproject.org/pkgdb the package database system]. This should happend automatically with fedpkg 1.13 and newer if you provide your FAS credentials. If it failed, you can retire the packge in the web interface or with the following command:
 
    pkgdb-cli orphan --retire PACKAGENAME master
 
 
==== Remarks ====
 
* After the package was retired in package DB, you will not be able to commit changes to GIT unless you are a [[Provenpackager policy|provenpackager]]. Therefore clean up GIT first.
 
* Change <code>master</code> to the respective branch
 
* Start with the oldest branch
 
  
 
=== Comps ===
 
=== Comps ===
Line 34: Line 29:
  
 
=== Spins ===
 
=== Spins ===
Remove the package from any [https://fedorahosted.org/spin-kickstarts/ spin kickstart file]
+
Remove the package from any [https://pagure.io/fedora-kickstarts spin kickstart file]
     git clone ssh://git.fedorahosted.org/git/spin-kickstarts.git
+
fork fedora-kickstarts and check out your clone. commit any fixes and send in a Pull Request
 +
     git clone ssh://git@pagure.io/path/to/fork/fedora-kickstarts.git
  
 
=== Upstream Release Monitoring ===
 
=== Upstream Release Monitoring ===
 
Remove the package from [[Upstream_release_monitoring]] if it is listed.
 
Remove the package from [[Upstream_release_monitoring]] if it is listed.
 +
 +
{{admon/note|Use the Flag button|Currently, regular users can't delete a project from [[Upstream_release_monitoring]]. To delete a project, one must click on the Flag button and use the flagging form to request that the project be deleted.}}
 +
  
 
=== Koji ===
 
=== Koji ===
To keep retired packages from being pushed to the mirrors, they need to be blocked in koji. This will happen during the next Rawhide/Branched compose (also for EPEL). If it did not happen file a
+
To keep retired packages from being pushed to the mirrors, they need to be blocked in koji. This will happen during the next compose (for rawhide, the branched release and for EPEL). If the package was not blocked automatically after two days, please file a
[https://fedorahosted.org/rel-eng/newticket ticket] for rel-eng (component <code>koji</code>) and mention the package name and the branch the package needs to be blocked.
+
[https://pagure.io/releng/new_issue ticket] for release engineering and mention the package name and the branch the package needs to be blocked.
  
 
==== Remarks ====
 
==== Remarks ====
* Please wait long enough before opening a ticket to avoid unnecessary work.
+
* Please wait two days before opening a ticket to allow for a compose to happen and then the mirrors to be updated.
* Use one ticket for all packages you retired at once, do not open one ticket for each package if you  
+
* Use one ticket for all packages you retired at once, do not open one ticket for each package if you retired several packages.
retired several packages.
 
 
* You check whether a package is blocked in koji, e.g. for the package <code>curry</code> there should the a entry with <code>[BLOCKED]</code> for each branch the package was retired in. It is enough for a package to be retired in an older tag to be also blocked in a newer tag due to inheritance:  
 
* You check whether a package is blocked in koji, e.g. for the package <code>curry</code> there should the a entry with <code>[BLOCKED]</code> for each branch the package was retired in. It is enough for a package to be retired in an older tag to be also blocked in a newer tag due to inheritance:  
  
Line 66: Line 64:
 
== Unretire a Package ==
 
== Unretire a Package ==
 
See [[Orphaned_package_that_need_new_maintainers]]
 
See [[Orphaned_package_that_need_new_maintainers]]
 +
 +
== Obsoleting Packages ==
 +
While not strictly part of the process, please consider what will happen to systems which have the now-retired packages installed.  Generally, such packages will simply remain on the system as it is updated, becoming increasingly outdated.
 +
 +
Please consider adding your package to [https://src.fedoraproject.org/rpms/fedora-obsolete-packages/ fedora-obsolete-packages].
 +
 +
Please follow relevant [https://docs.fedoraproject.org/en-US/packaging-guidelines/#renaming-or-replacing-existing-packages packaging guidelines] if another package will be providing similar or identical functionality to the retired package, or if it is necessary that the package be removed from end-user systems on system updates.
  
 
[[Category:Package Maintainers]]
 
[[Category:Package Maintainers]]
[[Category:Packaging guidelines]]
 

Revision as of 02:32, 13 May 2021

When a package reaches the end of its useful life, the following procedure will let other people -- and automated processes! -- know both not to expect any more releases, and why it was removed. The process is called retirement.

Procedure

Warning.png
Retire only in development/EPEL branches!
Do not retire packages in other branches than Branched (until the Final Freeze), Rawhide (master) and EPEL branches (epel7, epel8). When you need to add package from EPEL to any RHEL release, only retire EPEL branch when package is released in that RHEL release.

Please execute the following steps in the order indicated.

RPM

If the package is being replaced by some other package, ensure that the Obsoletes/Provides tags are properly set by the new package, see Renaming/Replacing Guidelines.

GIT

Run fedpkg retire DESCRIPTION in all non-stable Fedora branches and EPEL branches, if applicable. The retiring needs to start with the oldest branch (e.g. retire on f31 before you retire on rawhide)


Remarks

  • The DESCRIPTION parameter should explain why the package was retired, good messages are:
    • Obsoleted by bar
    • Renamed to bar
  • The command will remove all files from the branch, add a file name dead.package containing the description and push the changes.
  • git rm all files in the other branches only if there are special factors at work, like licensing issues, or package being removed completely from Fedora.
  • If you retired master before other older branches you want to retire, just continue with the older branches. It will still work, but will block the package in more Koji tags, because tag inheritance will not be used automatically then.

Comps

Remove the package from comps if it is listed.

Spins

Remove the package from any spin kickstart file fork fedora-kickstarts and check out your clone. commit any fixes and send in a Pull Request

   git clone ssh://git@pagure.io/path/to/fork/fedora-kickstarts.git

Upstream Release Monitoring

Remove the package from Upstream_release_monitoring if it is listed.

Note.png
Use the Flag button
Currently, regular users can't delete a project from Upstream_release_monitoring. To delete a project, one must click on the Flag button and use the flagging form to request that the project be deleted.


Koji

To keep retired packages from being pushed to the mirrors, they need to be blocked in koji. This will happen during the next compose (for rawhide, the branched release and for EPEL). If the package was not blocked automatically after two days, please file a ticket for release engineering and mention the package name and the branch the package needs to be blocked.

Remarks

  • Please wait two days before opening a ticket to allow for a compose to happen and then the mirrors to be updated.
  • Use one ticket for all packages you retired at once, do not open one ticket for each package if you retired several packages.
  • You check whether a package is blocked in koji, e.g. for the package curry there should the a entry with [BLOCKED] for each branch the package was retired in. It is enough for a package to be retired in an older tag to be also blocked in a newer tag due to inheritance:
$ koji list-pkgs  --show-blocked --tag f21 --package curry                               
Package                 Tag                     Extra Arches     Owner          
----------------------- ----------------------- ---------------- ---------------
curry                   f20                                      gemi            [BLOCKED]

EPEL

Note that you can use this process for EPEL as well with one difference:

  • You can remove the package from any EPEL branch whether or not it has been released.

For example, if your package has been added to base RHEL in RHEL-6.4 then perform the steps above but use the el6 branch instead of master.

Unretire a Package

See Orphaned_package_that_need_new_maintainers

Obsoleting Packages

While not strictly part of the process, please consider what will happen to systems which have the now-retired packages installed. Generally, such packages will simply remain on the system as it is updated, becoming increasingly outdated.

Please consider adding your package to fedora-obsolete-packages.

Please follow relevant packaging guidelines if another package will be providing similar or identical functionality to the retired package, or if it is necessary that the package be removed from end-user systems on system updates.