From Fedora Project Wiki

(→‎Obsoleting Packages: only recommend fedora-obsolete-packages if no other package is doing the obsoleting)
(Replaced content with "{{admon/warning |This page has been moved out of the wiki. The current version of this document is located at https://docs.fedoraproject.org/en-US/package-maintainers/Pack...")
Tag: Replaced
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{autolang|base=yes}}
+
{{admon/warning |This page has been moved out of the wiki. The current version of this document is located at https://docs.fedoraproject.org/en-US/package-maintainers/Package_Retirement_Process/ Please update your bookmarks.}}
 
 
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.
 
 
 
See [[Policy for Orphan and Retired Packages]] for an overview of when to orphan and when to retire a package.
 
 
 
== 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 (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 [https://docs.fedoraproject.org/en-US/packaging-guidelines/#renaming-or-replacing-existing-packages Renaming/Replacing Guidelines].
 
 
 
=== GIT ===
 
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 ====
 
* The <code>DESCRIPTION</code> parameter should explain why the package was retired, good messages are:
 
** <code>Obsoleted by 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.
 
* 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 [[How_to_use_and_edit_comps.xml_for_package_groups| comps]]  if it is listed.
 
 
 
=== Spins ===
 
Remove the package from any [https://pagure.io/fedora-kickstarts 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.
 
 
 
{{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 ===
 
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://pagure.io/releng/new_issue 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 <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:
 
 
 
<pre>
 
$ koji list-pkgs  --show-blocked --tag f21 --package curry                             
 
Package                Tag                    Extra Arches    Owner         
 
----------------------- ----------------------- ---------------- ---------------
 
curry                  f20                                      gemi            [BLOCKED]
 
</pre>
 
 
 
== 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 <code>el6</code> branch instead of <code>master</code>.
 
 
 
== 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 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.
 
 
 
If the retired package is not obsoleted by some replacement package, please consider adding your package to [https://src.fedoraproject.org/rpms/fedora-obsolete-packages/ fedora-obsolete-packages].
 
 
 
== Completely Removing a Package ==
 
 
 
In rare cases, such as when licensing issues are discovered,
 
it may be necessary to completely remove a package from Fedora.
 
This differs from normal retirement
 
in that the package is removed also from stable and end-of-life releases.
 
Complete removal is done as follows:
 
 
 
# Follow the [[#Procedure|procedure for normal removal]].
 
# Additionally, retire the package in '''all''' dist-git branches. Since <code>fedpkg retire</code> refuses to work on stable branches, simulate it with the following:
 
#:<pre>
 
#:: $ DESC="my description"; git rm -r . && echo "$DESC" > dead.package && git add dead.package && git commit -m "$DESC"</pre>
 
# Conside if the package should be added fedora-obsolete-packages for each branch.
 
 
 
[[Category:Package Maintainers]]
 

Revision as of 06:10, 7 September 2021

Warning.png
This page has been moved out of the wiki. The current version of this document is located at https://docs.fedoraproject.org/en-US/package-maintainers/Package_Retirement_Process/ Please update your bookmarks.