How to remove a package at end of life: Difference between revisions

Revision as of 20:33, 13 October 2013

In other languages: English (en) español (es) [edit]

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

Retire only in development/EPEL branches!
Do not retire packages in other branches than Branched (until the Final Change Deadline), Rawhide (master) and EPEL branches (el5, el6).

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 branches that need to be retired starting with the oldest branch (e.g. retire on f21 before you retire on master)

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. Starting with fedpkg 1.13 it will also retire the package in package DB.
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.

Package DB

Ensure that the package is marked as retired in 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 devel

Remarks

After the package was retired in package DB, you will not be able to commit changes to GIT unless you are a provenpackager. Therefore clean up GIT first.
Change devel to the respective branch
Start with the oldest branch

Comps

Remove the package from comps if it is listed.

Spins

Remove the package from any spin kickstart file

   git clone ssh://git.fedorahosted.org/git/spin-kickstarts.git

Upstream Release Monitoring

Remove the package from Upstream_release_monitoring if it is listed.

Koji

To keep retired packages from being pushed to the mirrors, they need to be blocked in koji. This should happen automatically within a short time for Fedora Branched and Rawhide. If it did not happen or for EPEL please file a ticket for rel-eng (component koji) asking the package from the appropriate collections in which it is retired.

Remarks

Use one ticket for all packages you retired at once, do not open one ticket for each package if you retired several packages.
Use the epel component for EPEL 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 a few differences:

You can remove the package from any EPEL branch whether or not it has been released.
The component for the rel-eng ticket is epel rather than koji.

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. When you open your rel-eng ticket to have the package blocked, use component epel instead of koji.

Unretire a Package

See Orphaned_package_that_need_new_maintainers

@@ Line 1: / Line 1: @@
 {{autolang|base=yes}}
-<!-- page was renamed from Extras/PackageEndOfLife
--->
-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.
+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 ==
+{{admon/warning|Retire only in development/EPEL branches!|Do not retire packages in other branches than Branched (until the [[Schedule|Final Change Deadline]]), Rawhide (master) and EPEL branches (el5, el6).}}
 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:Guidelines#Renaming.2FReplacing_Existing_Packages|Renaming/Replacing Guidelines]]. If not, go on to the next step.
+=== RPM ===
-# 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.
+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]].
-# <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.
+=== GIT ===
-# Check for and remove the package from any spins kickstarts files: http://git.fedorahosted.org/spin-kickstarts.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)
-# 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
+==== Remarks ====
-# 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.
+* 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. Starting with fedpkg 1.13 it will also retire the package in package DB.
+* <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.
+=== 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 devel
+==== 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>devel</code> to the respective branch
+* Start with the oldest branch
+=== 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://fedorahosted.org/spin-kickstarts/ spin kickstart file]
+    git clone ssh://git.fedorahosted.org/git/spin-kickstarts.git
+=== Upstream Release Monitoring ===
+Remove the package from [[Upstream_release_monitoring]] if it is listed.
+=== Koji ===
+To keep retired packages from being pushed to the mirrors, they need to be blocked in koji. This should happen automatically within a short time for Fedora Branched and Rawhide. If it did not happen or for EPEL please file a
+[https://fedorahosted.org/rel-eng/newticket ticket] for rel-eng (component <code>koji</code>) asking the package from the appropriate collections in which it is retired.
+==== Remarks ====
+* Use one ticket for all packages you retired at once, do not open one ticket for each package if you retired several packages.
+* Use the <code>epel</code> component for EPEL 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 a few differences:
+* You can remove the package from any EPEL branch whether or not it has been released.
+* The component for the rel-eng ticket is <code>epel</code> rather than <code>koji</code>.
+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>.  When you open your rel-eng ticket to have the package blocked, use component <code>epel</code> instead of <code>koji</code>.
+== Unretire a Package ==
+See [[Orphaned_package_that_need_new_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)
+[[Category:Package Maintainers]]
+[[Category:Packaging guidelines]]

Search

How to remove a package at end of life: Difference between revisions

Revision as of 20:33, 13 October 2013

Contents

Procedure

RPM

GIT

Remarks

Package DB

Remarks

Comps

Spins

Upstream Release Monitoring

Koji

Remarks

EPEL

Unretire a Package