From Fedora Project Wiki

No edit summary
(Redirect Package Maintainer wiki links to docs.fp.o)
 
(25 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{admon/important|This page is deprecated| All Fedora Release Engineering Documentation has moved [https://docs.pagure.org/releng/ here] with source hosted along side the code in the [https://pagure.io/releng releng pagure repository]}}
== Description ==
== Description ==


Every release prior to the Feature Freeze we purge all the orphans from the distribution. This keeps out unowned software and prevents future problems down the road.
Every release prior to the [[Schedule|Feature Freeze/Branching]] Release Engineering retires [https://docs.fedoraproject.org/en-US/package-maintainers/Package_Orphaning_Process/ orphaned packages]. This keeps out unowned software and prevents future problems down the road.


== Action ==
The orphan process takes place in stages:
The orphan process takes place in stages:
# Detecting a list of orphans and the dependencies that will be broken if the orphans are removed.
# Detecting a list of orphans and the dependencies that will be broken if the orphans are removed.
# Sending the list of potential orphans to devel@lists.fedoraproject.org for community review and removal from the orphan list.
# Sending the list of potential orphans to devel@lists.fedoraproject.org for community review and removal from the orphan list.
# Removing packages confirmed as ''orphans'' from the Fedora package respositories.
# Retriring packages nobody wants to adopt.


=== Detecting Orphans ===
=== Detecting Orphans ===


A script called <code>find-unblocked-orphans.py</code> assits in the detection process.  It should be run on a machine that has <code>koji</code> and <code>python-fedora installed</code>.  It runs without options, and should take about a minute to complete.
A script called <code>find_unblocked_orphans.py</code> assists in the detection process.  It should be run on a machine that has <code>koji</code> and <code>python-fedora</code> installed.  It runs without options and takes a while to complete.


<code>find-unblocked-orphans.py</code> is available in the Release Engineering git repo or downloaded from https://fedorahosted.org/rel-eng/browser/scripts/find-unblocked-orphans.py
<code>find_unblocked_orphans.py</code> is available in the [https://fedorahosted.org/rel-eng/browser/scripts/find_unblocked_orphans.py|Release Engineering git repository].


=== Announcing Packages to be Orphaned ===
=== Announcing Packages to be retired ===


<code>find-unglocked-orphans.py</code>outputs text to stdout on the command line in a forma  suitable for the body of an email message.   
<code>find_unblocked_orphans.py</code>outputs text to stdout on the command line in a form suitable for the body of an email message.   


<pre>
<pre>
Line 22: Line 25:
</pre>
</pre>


Email the output to devel@lists.fedodraproject.org at least a week before the feature freeze.  This gives maintainers an opportunity to pick up orphans that are important to them.
Email the output to the development list (devel@lists.fedodraproject.org) at least a month before the feature freeze, send mails with updated lists as necessary.  This gives maintainers an opportunity to pick up orphans that are important to them or are required by other packages.
 
=== Blocking orphans ===


Once maintainers have been given an opportunity to pick up orphans, we need to do the blocking.  Currently we don't have a script to do this, so we re-use the find-unblocked-orphans.py script to generate the list.  The 'block-pkg' koji command is used to do the blocking.
=== Retiring Orphans ===


<pre>
Once maintainers have been given an opportunity to pick up orphaned packages, the remaining packages are [https://docs.fedoraproject.org/en-US/package-maintainers/Package_Retirement_Process/ retired].
$ 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:
==== Bugs ====
  -h, --help  show this help message and exit
This procedure probably leaves open bugs for the d 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.
</pre>
 
This can take multiple packages and thus we can use the orphan list from the find command as input. We block packages from the latest dist-f## tag only, for example if we wished to block sbackup roxterm and uisp from rawhide during Fedora 13 development we would run:
 
<pre>
$ koji block-pkg dist-f13 sbackup roxterm uisp
</pre>
 
== Action ==
<!-- Describe the action and provide examples -->


== Verification ==
== Verification ==
To verify that the packages were blocked correctly we can use the
To verify that the packages were blocked correctly we can use the ''latest-pkg'' <code>koji</code> action.
'latest-pkg' koji action.


<pre>
<pre>
$ koji latest-pkg dist-f13 wdm
$ koji latest-pkg dist-f21 wdm
</pre>
</pre>


This should return nothing, as wdm is a blocked package.
This should return nothing, as the <code>wdm</code> package is blocked.


== Consider Before Running ==
== Consider Before Running ==
Generally we block anything that doesn't leave any deps, but if there are orphans that are still depended on a second warning sent to devel@lists.fedoraproject.org and to <package>-owner@fedoraproject.org for each dep.
Generally we retire anything that doesn't leave broken dependencies.  If there are orphans whose removal would result in broken dependencies a second warning should be sent to devel@lists.fedoraproject.org and to <package>-owner@fedoraproject.org for each dependent package.


We give another couple of days for maintainers to take notice and pick up packages or rebuild their packages without needing the orphansWe don't like to create broken deps by purging orphans so every effort should be made to find owners or to fix deps.
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  the packageIt 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.


[[Category:Release Engineering SOPs]]
[[Category:Release Engineering SOPs]]

Latest revision as of 20:28, 2 October 2021

This page is deprecated
All Fedora Release Engineering Documentation has moved here with source hosted along side the code in the releng pagure repository

Description

Every release prior to the Feature Freeze/Branching Release Engineering retires orphaned packages. This keeps out unowned software and prevents future problems down the road.

Action

The orphan process takes place in stages:

  1. Detecting a list of orphans and the dependencies that will be broken if the orphans are removed.
  2. Sending the list of potential orphans to devel@lists.fedoraproject.org for community review and removal from the orphan list.
  3. Retriring packages nobody wants to adopt.

Detecting Orphans

A script called find_unblocked_orphans.py assists in the detection process. It should be run on a machine that has koji and python-fedora installed. It runs without options and takes a while to complete.

find_unblocked_orphans.py is available in the Engineering git repository.

Announcing Packages to be retired

find_unblocked_orphans.pyoutputs text to stdout on the command line in a form suitable for the body of an email message.

$ ./find-unblocked-orphans.py > email-message

Email the output to the development list (devel@lists.fedodraproject.org) at least a month before the feature freeze, send mails with updated lists as necessary. This gives maintainers an opportunity to pick up orphans that are important to them or are required by other packages.

Retiring Orphans

Once maintainers have been given an opportunity to pick up orphaned packages, the remaining packages are retired.

Bugs

This procedure probably leaves open bugs for the d 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.

Verification

To verify that the packages were blocked correctly we can use the latest-pkg koji action.

$ koji latest-pkg dist-f21 wdm

This should return nothing, as the wdm package is blocked.

Consider Before Running

Generally we retire anything that doesn't leave broken dependencies. If there are orphans whose removal would result in broken dependencies a second warning should be sent to devel@lists.fedoraproject.org and to <package>-owner@fedoraproject.org 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 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.