Adding Build Targets SOP

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Explanation of what koji_name means)
(nuke h1, legacy renames)
Line 1: Line 1:
<!-- page was renamed from ReleaseEngineering/RelEngSOPTemplate
<!-- page was renamed from ReleaseEngineering/SOP/RelEngSOPTemplate
= Adding Build Targets - SOP =
== Description ==
== Description ==
<!-- Put a description of the task here.
<!-- Put a description of the task here.

Revision as of 18:46, 10 June 2009



Each new release we create a build target for the next release. This SOP will describe the steps necessary to prepare the new build target.


Adding a build target is a complicated task. It involves updating koji, CVS, fedora-release package, puppet, and a few wiki pages.


In koji a couple collection tags need to be made, and a target created to tie them together. We create a base collection tag named after the release, and a build tag to hold a few things we use in the buildroots that are not part of the distribution (glibc32/glibc64). Inheritance to the previous release is used for ownership and package data, as well as buildroot content data.

The add-tag, add-tag-inheritance, and add-target commands are used.

$ koji add-tag --help
Usage: koji add-tag [options]  name
(Specify the --help global option for a list of other help options)

-h, --help       show this help message and exit
--parent=PARENT  Specify parent
--arches=ARCHES  Specify arches

$ koji add-tag-inheritance --help
Usage: koji add-tag-inheritance [options]  tag parent-tag
(Specify the --help global option for a list of other help options)

-h, --help            show this help message and exit
--priority=PRIORITY   Specify priority
--maxdepth=MAXDEPTH   Specify max depth
--intransitive        Set intransitive
--noconfig            Set to packages only
Specify the package filter
--force=FORCE         Force adding a parent to a tag that already has that
parent tag

$ koji add-target --help
Usage: koji add-target name build-tag <dest-tag>
(Specify the --help global option for a list of other help options)

-h, --help  show this help message and exit

For example if we wanted to create the Fedora 9 build target, we would do the following:

koji add-tag --parent dist-f8 --arches=i386,x86_64,ppc,ppc64 dist-f9
koji add-tag --parent dist-f9 --arches=i386,x86_64,ppc,ppc64 dist-f9-build
koji add-tag-inheritance --priority 2 dist-f9-build dist-f8-build
koji add-target dist-f9 dist-f9-build


Multiple parts of the CVS system need to be made aware of new build targets (and thus new branches).


The branches and Makefile.common file need to be updated.

branches simply needs a new line defining the next release:


The first field is the branch name as it would be seen on the file system. The second field is the build target for that branch, the third is what dist would define to, and the last to define the family and release (which are used by other macros). Depending on when the new target is introduced, you may need to also update the definition of the devel/ branch so that it targets the correct build target.

Makefile.common has potentially three changes. The first depends on if a new build target is being added for pre-branch purposes. If it is, the pre-branch logic check near the top of Makefile.common needs to be updated with this information.

# check to see if this is an early branched package; we should make this more
# generic in the future
ifeq ($(BRANCH),devel)
BRANCH:=$(shell cvs rlog rpms/$(NAME)/F-10/$(SPECFILE) >/dev/null 2>&1 && echo "F-11" || echo "devel")

This chunk of code only operates on builds from the devel/ branch, and it checks the cvs server to see if there is an F-10 branch for the package in question. If found, the system assumes the package was pre-branched, and that the build from devel/ should go to the F-11 target, instead of the F-10 target of a non-branched package.

The second Makefile.common change involves some logic inside of it to determine which branches use koji to build and which use plague. When new targets/branches are introduced, this logic needs to be updated (this should go away soon).

ifneq (, $(filter devel F-9 F-8 F-7 OLPC-2, $(BRANCH)))
build: koji
build: plague

Ensure that the new branch is listed in the set of branches for koji.

The third Makefile.common change is also related to pre-branch. When pre-branching, the branches that will be created need to use bodhi for the 'make update' target. To update the list of branches that use bodhi for updates change the following:

ifneq (, $(filter F-10 F-9 F-8 F-7, $(BRANCH)))
update: bodhi

Ensure the branches that will be pre-created are listed.


Within CVSROOT/admin/ there are several files that deal with making CVS branches. They are mkbranchwrapper,, and tag-check.

mkbranchwrapper simply needs the VALID_BRANCHES alias updated with the new branch:

VALID_BRANCHES="OLPC-2 FC-3 FC-4 FC-6 F-7 F-8 EL-4 EL-5" needs something similar. Update BRANCHES with the new branch information. The branch name maps to the branch that is its parent.

BRANCHES = {'EL-4': 'FC-3', 'EL-5': 'FC-6',
'OLPC-2': 'F-7',
'devel': None,
'RHL-8': None, 'RHL-9': None,
'FC-1': None, 'FC-2': None, 'FC-3': None, 'FC-4': None, 'FC-5': None,
'FC-6': None,
'F-7': 'devel', 'F-8': 'devel', 'F-9': 'devel'}

tag-check lists a set of tags that are valid and as such it needs to be updated with the tags that are created when a package is branched. These are branch starting tags and branch splitting tags. Each set needs to get updated with the new branch:

RHL-8-start | RHL-9-start | \
OLPC-2-start | \
EL-4-start | EL-5-start | \
FC-1-start | FC-2-start | FC-3-start | FC-4-start | FC-5-start | \
FC-6-start | F-7-start | F-8-start )
RHL-8-split | RHL-9-split | \
OLPC-2-split | \
EL-4-split | EL-5-split | \
FC-1-split | FC-2-split | FC-3-split | FC-4-split | FC-5-split | \
FC-6-split | F-7-split | F-8-split )


The Package Database has two tables that need to be updated with the new release information as well. These are the commands that were run to update for Fedora 9:

$ ssh bastion
$ ssh db2
$ sudo -u postgres psql pkgdb
pkgdb=# insert into collection (name, version, koji_name, statuscode, owner) values \
('Fedora', '9', 'dist-f9', 1, 100351);

pkgdb=# insert into branch (collectionid, branchname, disttag) \
select id, 'F-9', '.fc9' from collection where name = 'Fedora' and version = '9';
  • name and version define the release.
  • koji_name is the tag used for this release in koji.
  • statuscode for a new release will always be 1 (Active).
  • 100351 is Jesse Keating's id. Change this if someone else is the release manager for this release.
  • branchname is the name of branch directories in cvs.
  • disttag is the value for disttag in rpm.


Currently the fedora-release package provides the %{?dist} definitions used during building of packages. When a new target is created, fedora-release must be built for the collection with new dist definitions.


Puppet manages configs for our "static-repo" creation. When creating a new build target, it needs to be added to the list of static-repos so that users can access up to the hour repodata for this build target.


within puppet is the file that manages these repos. Add the new target to the TAGS alias and commit.


Various wiki pages need to be updated with the new target information. Below you'll find a (hopefully current) list of pages to change:


  • In the comps module in CVS (CVSROOT: /cvs/pkgs), create and add a new comps file based on the previous release. (Just copying it should be fine.) Add the new file to po/
  • When rawhide is retargeted in koji to point to the new release, update the Makefile to target comps-rawhide.xml at the new version


Given the complexity of all the changes necessary to create a new build target, the best way to verify is to attempt a build. Given that fedora-release has to be built before anything else so that dist tags translate correctly it is a good test case. For example, this was used to test the new Fedora 9 target:

  • Use pkgdb to request an F-8 branch of fedora-release
  • Use pkgdb2branch to actually make the branch
  • Update fedora-release checkout (and common/ directory)
  • Adjust .spec file in devel/ for new dist defines
  • commit/build
  • Track build in koji to ensure proper tagging is used

What this won't test is translations of dist at tag time given that fedora-release doesn't use dist in it's Release. Verifying with a second package that uses dist is a good idea.


Too many to list right now.