How to remove a package at end of life

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Imported from MoinMoin)
 
(correct spins url)
(24 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 +
{{autolang|base=yes}}
 
<!-- page was renamed from Extras/PackageEndOfLife
 
<!-- page was renamed from Extras/PackageEndOfLife
 
-->
 
-->
When a package reaches the end of its useful life, the following steps will let other people -- and automated processes! -- know both not to expect any more releases, and why it was removed.  The process is simple.
+
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.
  
For this example, we'll remove the package ''foo''.
+
Please execute the following steps in the order indicated.
  
1. Make sure it is properly Obsoleted/Provided by something if it is being replaced, see [http://fedoraproject.org/wiki/Packaging/NamingGuidelines#head-3cfc1ea19d28975faad9d56f70a6ae55661d3c3d Renaming/Replacing Guidelines] .
+
# 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.
1. Add a <code>dead.package</code> file to CVS in affected <code>foo/*</code> branches (usually <code>foo/devel</code> only). This should briefly explain where this package went'Obsolete package.', 'Renamed to bar' or the like.
+
# 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.
1. <code>cvs rm</code> all the other files in the <code>foo/*</code> branches that you added <code>dead.package</code> to.  This should help make it clearly obvious what's going on here.  It's not necessary to remove the files in other branches, unless there are other factors at work.  (e.g., licensing issue, 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.
1. Remove the package from [[PackageMaintainers/CompsXml| comps]]  if it is listed.
+
# Remove the package from [[How_to_use_and_edit_comps.xml_for_package_groups| comps]]  if it is listed.
1. Mark the package as "retired" on ["PackageMaintainers/RetiredPackages"] . Do not mark the package this way if it is just being renamed in some but not all distro branches.
+
# Check for and remove the package from any spins kickstarts files: http://git.fedorahosted.org/git/spin-kickstarts.git
1. Send mail to rel-eng@fedoraproject.org asking the package to be blocked from the appropriate collections in which it is retired.
+
# 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.
 +
 
 +
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 14:46, 7 February 2013

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. Check for and remove the package from any spins kickstarts files: http://git.fedorahosted.org/git/spin-kickstarts.git
  6. 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.
  7. If the package was registered on Upstream_release_monitoring, remove it from that page
  8. 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)