How to remove a package at end of life

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Update link to Deprecated packages list)
(update with note for epel)
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{{autolang|base=yes}}
 
<!-- page was renamed from Extras/PackageEndOfLife
 
<!-- page was renamed from Extras/PackageEndOfLife
 
-->
 
-->
Line 5: Line 6:
 
Please execute the following steps in the order indicated.
 
Please execute the following steps in the order indicated.
  
# Make sure the package is properly Obsoleted/Provided by something '''if''' it is being replaced, see [[Packaging/NamingGuidelines#Renaming.2Freplacing_existing_packages|Renaming/Replacing Guidelines]]. If not, go on to the next step.
+
# Make sure the package is properly Obsoleted/Provided by something '''if''' it is being replaced, see [[Packaging:Guidelines#Renaming.2FReplacing_Existing_Packages|Renaming/Replacing Guidelines]]. If not, go on to the next step.
 
# Run <code>fedpkg retire MSG</code>. This will recursively remove all files, then add a <code>dead.package</code> file to git.  Do it for all affected package branches (usually <code>master</code> only, but also the branched release if it has not yet released). The MSG parameter is a message which should briefly explain where this package went ('Obsolete package', 'Renamed to bar' or the like) and will be written in the dead.package file.
 
# Run <code>fedpkg retire MSG</code>. This will recursively remove all files, then add a <code>dead.package</code> file to git.  Do it for all affected package branches (usually <code>master</code> only, but also the branched release if it has not yet released). The MSG parameter is a message which should briefly explain where this package went ('Obsolete package', 'Renamed to bar' or the like) and will be written in the dead.package file.
 
# <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.
 
# Remove the package from [[How_to_use_and_edit_comps.xml_for_package_groups| comps]]  if it is listed.
 
# Remove the package from [[How_to_use_and_edit_comps.xml_for_package_groups| comps]]  if it is listed.
 
# Mark the package as "retired" in [https://admin.fedoraproject.org/pkgdb the package database system]: log in with your FAS credentials, go to the page for your package, and click the '''Retire package''' button for each branch on which you are retiring the package. Do '''not''' execute this step if you don't have already completed steps 2 and 3, otherwise you will have to ask a [[Provenpackager policy|provenpackager]] to perform those steps for you.
 
# Mark the package as "retired" in [https://admin.fedoraproject.org/pkgdb the package database system]: log in with your FAS credentials, go to the page for your package, and click the '''Retire package''' button for each branch on which you are retiring the package. Do '''not''' execute this step if you don't have already completed steps 2 and 3, otherwise you will have to ask a [[Provenpackager policy|provenpackager]] to perform those steps for you.
 +
# If the package was registered on [[Upstream_release_monitoring]], remove it from that page
 
# File a [https://fedorahosted.org/rel-eng/newticket ticket] for rel-eng (component koji) asking the package to be blocked from the appropriate collections in which it is retired.
 
# File a [https://fedorahosted.org/rel-eng/newticket ticket] for rel-eng (component koji) asking the package to be blocked from the appropriate collections in which it is retired.
# Optionally, you can update the Wiki list of [[Deprecated packages]], but it is now considered mostly obsoleted by the package database system.
+
 
[[Category:Package Maintainers]]
+
Note that you can use this process for specific EPEL branches as well, for example if your package has been added to base RHEL. Just do the steps only on/refering to the specific branch (eg, el6)

Revision as of 00:37, 5 December 2012

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 simple.

Please execute the following steps in the order indicated.

  1. Make sure the package is properly Obsoleted/Provided by something if it is being replaced, see Renaming/Replacing Guidelines. If not, go on to the next step.
  2. Run fedpkg retire MSG. This will recursively remove all files, then add a dead.package file to git. Do it for all affected package branches (usually master only, but also the branched release if it has not yet released). The MSG parameter is a message which should briefly explain where this package went ('Obsolete package', 'Renamed to bar' or the like) and will be written in the dead.package file.
  3. 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.
  4. Remove the package from comps if it is listed.
  5. Mark the package as "retired" in the package database system: log in with your FAS credentials, go to the page for your package, and click the Retire package button for each branch on which you are retiring the package. Do not execute this step if you don't have already completed steps 2 and 3, otherwise you will have to ask a provenpackager to perform those steps for you.
  6. If the package was registered on Upstream_release_monitoring, remove it from that page
  7. File a ticket for rel-eng (component koji) asking the package to be blocked from the appropriate collections in which it is retired.

Note that you can use this process for specific EPEL branches as well, for example if your package has been added to base RHEL. Just do the steps only on/refering to the specific branch (eg, el6)