Deprecate FTBFS packages
(→Action: add koji command)
(→GIT: simplify commands)
|Line 55:||Line 55:|
$ fedpkg clone roxterm
$ fedpkg clone roxterm
$ cd roxterm
$ cd roxterm
$ fedpkg retire
$ fedpkg retire "$-FTBFS Cleanup"
Revision as of 14:21, 25 August 2013
Every release prior to the Feature Freeze we deprecate all packages that FTBFS. This keeps out software that no longer builds from source, and prevents future problems down the road.
The FTBFS process takes place in stages:
- Detecting a list of FTBFS packages and the dependencies that will be broken if they are removed.
- Sending the list of potential deprecated FTBFS packages to firstname.lastname@example.org for community review and removal from the FTBFS list by fixing the package.
- Removing packages confirmed as FTBFS from the Fedora package repositories.
We will remove packages that have failed to build for at least two release cycles. For example, in preparation for Fedora 21 branching, packages which FTBFS since the Fedora 19 cycle (i.e. packages that have a dist tag of fc18 or earlier) will be considered candidates for removal. There is currently no proper way to identify FTBFS packages. One possiblity is to check whether packages in the current tag still contain old dist tags:
koji list-tagged --latest f21 | grep fc1[4-8]
Given a candidate list from above, rel-eng should attempt to build each of the candidate packages using koji. Should package building now succeed, the package may be removed from the candidate list.
Announcing Packages to be Deprecated
Email the output to the development list (email@example.com) at least a week before the feature freeze. This gives maintainers an opportunity to fix packages that are important to them. Follow-up on the list where necessary.
Blocking FTBFS packages
Once maintainers have been given an opportunity to pick up and fix FTBFS packages, the remaining packages are deprecated by blocking them, and creating the
dead.package file in git.
Deprecate Package button in PackageDB to deprecate a package. This shows interested maintainers, that the package is now deprecated. There might also be a way to do this with a command line client.
koji command is used to do the blocking.
$ koji block-pkg --help Usage: koji block-pkg [options] tag package [package2 ...] (Specify the --help global option for a list of other help options) Options: -h, --help show this help message and exit
Koji accepts multiple package names as input and thus we can use the FTBFS package list as input. Deprecated packages are only blocked from the latest
dist-f## tag. For example, if we wanted to deprecate (block)
sbackup, roxterm, and
uisp from rawhide during the development of Fedora 16 we would run the following command:
$ koji block-pkg dist-f16 sbackup roxterm uisp
We just have to remove the existing files from the
master branch and replace them with a
dead.package file whose contents describe why the package is dead.
For example, if we wished to clean up git for the roxterm package we would:
$ fedpkg clone roxterm $ cd roxterm $ fedpkg retire "Retired on $(date -I), because it failed to build for two releases (FTBFS Cleanup)."
This procedure probably leaves open bugs for the deprecated packages behind. It is not within the scope of releng to take care of these. If bugs are closed, only bugs targeted at Rawhide should be affected, since other branches might still be maintained.
To verify that the packages were blocked correctly we can use the latest-pkg
$ koji latest-pkg dist-f16 wdm
This should return nothing, as the
wdm package is blocked.
Consider Before Running
Generally we block anything that doesn't leave broken dependencies. If there are packages whose removal would result in broken dependencies a second warning should be sent to firstname.lastname@example.org and to <package>-email@example.com for each dependent package.
Allow another couple of days for maintainers to take notice and fix these package so the package repository can be maintained without broken dependencies or needing to deprecate the package. It is not good to have broken package dependencies in our package repositories so every effort should be made to find owners or to fix the broken dependencies.