From Fedora Project Wiki

(add some categories)
(→‎Remarks: fix list formatting)
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{autolang|base=yes}}
{{autolang|base=yes}}


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 ==
== 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 (el5, el6, epel7).}}
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 [[Packaging:Guidelines#Renaming.2FReplacing_Existing_Packages|Renaming/Replacing Guidelines]].
=== 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)
==== 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. 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 happen automatically with fedpkg 1.13 and newer if you provide your FAS credentials. If it failed, you can retire the package with the following command:
    pkgdb-cli orphan --retire PACKAGENAME master
==== 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>master</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 will happen during the next Rawhide/Branched compose (also for EPEL). If it did not happen file a
[https://fedorahosted.org/rel-eng/newticket ticket] for rel-eng (component <code>koji</code>) and mention the package name and the branch the package needs to be blocked.


Please execute the following steps in the order indicated.
==== Remarks ====
* Please wait long enough before opening a ticket to avoid unnecessary work.
* 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:


# 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.
<pre>
# Run <code>fedpkg retire MSG</code>. This will recursively remove all files, then add a <code>dead.package</code> file to git. This should be done for <code>master</code> and sometimes the branched release if it has not yet released ('''Do not''' do this for released Fedora versions as there's no way to remove the package from end-user's systems) . 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.
$ koji list-pkgs --show-blocked --tag f21 --package curry                             
# <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.
Package                Tag                    Extra Arches    Owner         
# Remove the package from [[How_to_use_and_edit_comps.xml_for_package_groups| comps]]  if it is listed.
----------------------- ----------------------- ---------------- ---------------
# Check for and remove the package from any spins kickstarts files: http://git.fedorahosted.org/git/spin-kickstarts.git
curry                  f20                                      gemi            [BLOCKED]
# Do '''not''' execute this step if you have not 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.
</pre>
# 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 <code>koji</code>) asking the package to be blocked from the appropriate collections in which it is retired.


== EPEL ==
== EPEL ==
Note that you can use this process for EPEL as well with a few differences:
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.
* 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>.
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]]


[[Category:Package Maintainers]]
[[Category:Package Maintainers]]
[[Category:Packaging guidelines]]
[[Category:Packaging guidelines]]

Revision as of 18:46, 11 November 2014

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

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

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 happen automatically with fedpkg 1.13 and newer if you provide your FAS credentials. If it failed, you can retire the package with the following command:

   pkgdb-cli orphan --retire PACKAGENAME master

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 master 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 will happen during the next Rawhide/Branched compose (also for EPEL). If it did not happen file a ticket for rel-eng (component koji) and mention the package name and the branch the package needs to be blocked.

Remarks

  • Please wait long enough before opening a ticket to avoid unnecessary work.
  • 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 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 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 el6 branch instead of master.

Unretire a Package

See Orphaned_package_that_need_new_maintainers