How to remove a package at end of life

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(update for git)
Line 6: Line 6:
  
 
# 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]].
 
# 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]].
# Add a <code>dead.package</code> file to git in affected <code>foo</code> branches (usually <code>master</code> only).  The contents of this file should briefly explain where this package went:  'Obsolete package.', 'Renamed to bar' or the like.
+
# Add a <code>dead.package</code> file to git in affected <code>foo</code> branches (usually <code>master</code> only, but also the branched release if it has not yet released).  The contents of this file should briefly explain where this package went:  'Obsolete package.', 'Renamed to bar' or the like.
 
# <code>git 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 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.)
 
# Remove the package from [[PackageMaintainers/CompsXml| comps]]  if it is listed.
 
# Remove the package from [[PackageMaintainers/CompsXml| comps]]  if it is listed.

Revision as of 15:14, 7 October 2010

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.

For this example, we'll remove the package foo.

  1. Make sure the package is properly Obsoleted/Provided by something if it is being replaced, see Renaming/Replacing Guidelines.
  2. Add a dead.package file to git in affected foo branches (usually master only, but also the branched release if it has not yet released). The contents of this file should briefly explain where this package went: 'Obsolete package.', 'Renamed to bar' or the like.
  3. git rm all the other files in the foo branches that you added dead.package 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.)
  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. There is also a Wiki list of Retired Packages you can update if you choose, but it is now considered mostly obsoleted by the package database system.
  6. File a ticket for rel-eng asking the package to be blocked from the appropriate collections in which it is retired.