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.
See Policy for Orphan and Retired Packages for an overview of when to orphan and when to retire a package.
Please execute the following steps in the order indicated.
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.
fedpkg retire DESCRIPTION in all non-stable Fedora branches and EPEL
branches, if applicable. The retiring needs to start with the oldest branch
(e.g. retire on f31 before you retire on rawhide)
DESCRIPTIONparameter 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.packagecontaining the description and push the changes.
- 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.
Remove the package from comps if it is listed.
Remove the package from any spin kickstart file fork fedora-kickstarts and check out your clone. commit any fixes and send in a Pull Request
Upstream Release Monitoring
Remove the package from Upstream_release_monitoring if it is listed.
To keep retired packages from being pushed to the mirrors, they need to be blocked in koji. This will happen during the next compose (for rawhide, the branched release and for EPEL). If the package was not blocked automatically after two days, please file a ticket for release engineering and mention the package name and the branch the package needs to be blocked.
- Please wait two days before opening a ticket to allow for a compose to happen and then the mirrors to be updated.
- 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
currythere 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]
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
Unretire a Package
While not strictly part of the process, please consider what will happen to systems which have the now-retired packages installed. Generally, such packages will simply remain on the system as it is updated, becoming increasingly outdated.
Please follow relevant packaging guidelines if another package will be providing similar or identical functionality to the retired package, or if it is necessary that the package be removed from end-user systems on system updates.
If the retired package is not obsoleted by some replacement package, please consider adding your package to fedora-obsolete-packages.
Completely Removing a Package
In rare cases, such as when licensing issues are discovered, it may be necessary to completely remove a package from Fedora. This differs from normal retirement in that the package is removed also from stable and end-of-life releases. Complete removal is done as follows:
- Follow the procedure for normal removal.
- Additionally, retire the package in all dist-git branches. Since
fedpkg retirerefuses to work on stable branches, simulate it with the following:
- $ DESC="my description"; git rm -r . && echo "$DESC" > dead.package && git add dead.package && git commit -m "$DESC"
- Consider if the package should be added fedora-obsolete-packages for each branch.