This document is divided in three sections to give Developers, Testers, and Mirror Admins some guidelines on how to submit packages for [[Releases/Rawhide | <code>rawhide]], development</code> and <code>pending</code>.

This document is divided in three sections to give Developers, Testers, and Mirror Admins some guidelines on how to submit packages for [[Releases/Rawhide | <code>rawhide]], development</code> and <code>pending</code>.

−

* For more information on becoming a package maintainer, refer to [[PackageMaintainers/Join]]

+

* For more guidance on package updates, refer to [[Updates_Policy]].

−

* For more guidance on package updates, refer to [[PackageMaintainers/Package update guidelines]].

+

== Overview ==

== Overview ==

Line 16:

Line 16:

In particular, these are the '''new paths on mirrors''':

In particular, these are the '''new paths on mirrors''':

* <code> /pub/fedora/linux/development/rawhide/ </code> will become the new path of Rawhide. It will continue to not have install images, and will be the place where builds from the <code> "devel" </code> branch in git go to. It'll be {{FedoraVersion|long|next}} intended content.

* <code> /pub/fedora/linux/development/rawhide/ </code> will become the new path of Rawhide. It will continue to not have install images, and will be the place where builds from the <code> "devel" </code> branch in git go to. It'll be {{FedoraVersion|long|next}} intended content.

−

* <code> /pub/fedora/linux/development/{{FedoraVersion}} </code> will become the new path of the branched Fedora 13 content. This is where builds from the F-{{FedoraVersion}}/ branch in git will go after they pass through Bodhi as "stable".

+

* <code> /pub/fedora/linux/development/{{FedoraVersion}} </code> will become the new path of the branched Fedora {{FedoraVersion}} content. This is where builds from the F-{{FedoraVersion}}/ branch in git will go after they pass through Bodhi as "stable".

* <code> /pub/fedora/linux/updates/testing/{{FedoraVersion}}/ </code> will be where potential Fedora {{FedoraVersion}} builds go after passing through bodhi as "testing". This is where you'll find the latest stuff proposed for ''freeze break'' and where testing and peer review of these freeze breaks will happen. When a maintainer feels enough testing has happened, or enough karma triggers the Bodhi auto request, the build will be marked "stable" and show up in the development/{{FedoraVersion}} tree at the next nightly compose.

* <code> /pub/fedora/linux/updates/testing/{{FedoraVersion}}/ </code> will be where potential Fedora {{FedoraVersion}} builds go after passing through bodhi as "testing". This is where you'll find the latest stuff proposed for ''freeze break'' and where testing and peer review of these freeze breaks will happen. When a maintainer feels enough testing has happened, or enough karma triggers the Bodhi auto request, the build will be marked "stable" and show up in the development/{{FedoraVersion}} tree at the next nightly compose.

|style="background-color:#DEF3FE" align=center| X<ref name="3">Provided the package has net positive Karma from QA or releng and at least one more net positive karma point. If karma autopush is checked submit to stable is done automatically</ref>

+

|style="background-color:#DEF3FE" align=center| X<ref name="ref3">Provided the package has net positive Karma from QA or releng and at least one more net positive karma point. If karma autopush is checked submit to stable is done automatically</ref>

|-

|-

−

|style="background-color:#DDDDDD"| To push a package built to handle an urgent issue (e.g. security problem, non-functioning system, etc.) to the {{FedoraVersion|short|next}} branch <ref name="4">In all cases, it's ''necessary'' to be very very very sure the update will not cause additional problems'''</ref>

+

|style="background-color:#DDDDDD"| To push a package built to handle an urgent issue (e.g. security problem, non-functioning system, etc.) to the {{FedoraVersion|short|next}} branch <ref name="ref4">In all cases, it's ''necessary'' to be very very very sure the update will not cause additional problems'''</ref>

|

|

|

|

Line 108:

Line 108:

|

|

|

|

−

|style="background-color:#DEF3FE" align=center| X<ref name="5">If the package is not in the critical path, nor addressing a security problem, then it can be requested a push to stable<BR>

+

|style="background-color:#DEF3FE" align=center| X<ref name="ref5">If the package is not in the critical path, nor addressing a security problem, then it can be requested a push to stable<BR>

If the package addresses a security issue then it should be marked as security. Wait for the Security team to sign off on the update (not sure how this happens right now) before requesting the package be pushed to stable<BR>

If the package addresses a security issue then it should be marked as security. Wait for the Security team to sign off on the update (not sure how this happens right now) before requesting the package be pushed to stable<BR>

If the package is in the critical path, then wait for a QA/Release Engineering/Peer net positive karma vote in Bodhi before requesting the package be pushed to stable</ref>

If the package is in the critical path, then wait for a QA/Release Engineering/Peer net positive karma vote in Bodhi before requesting the package be pushed to stable</ref>

Line 129:

Line 129:

{{admon/tip|

{{admon/tip|

−

To check and see if the build will be in the {{FedoraVersion|long|next}}, as they will be tagged with ''"dist-f1?"'', you can run ''koji latest-pkg dist-f1?'' to see what the latest build of your package is for {{FedoraVersion|long|next}}.}}

+

To check and see if the build will be in the {{FedoraVersion|long|next}}, as they will be tagged with ''"f1?"'', you can run ''koji latest-pkg f1?'' to see what the latest build of your package is for {{FedoraVersion|long|next}}.}}

<BR>

<BR>

Line 171:

Line 171:

<pre>fedpkg clone <package_name>

<pre>fedpkg clone <package_name>

</pre>

</pre>

+

+

{{Admon/important| Note: If you are not a member of the fedora packager group, you will receive a "permission denied" error. Use the -a flag to clone anonymously. }}

+

+

{{Admon/important| Note: If you you use a separate ssh key for FAS, remember to load it into your ssh-agent. }}

* If you update to a new upstream version, you have to upload the tarball to an external lookaside cache. Operations on the lookaside cache require a client-side certificate, to get one, run

* If you update to a new upstream version, you have to upload the tarball to an external lookaside cache. Operations on the lookaside cache require a client-side certificate, to get one, run

Line 187:

Line 191:

</pre>

</pre>

−

This also updates your local copy of the '''.cvsignore''' and '''sources''' files. You will need to do this for each branch that you will be building the new version for. The new tarball will be uploaded only once and the rest will be md5sum checked and not uploaded, only the '''.cvsignore''' and '''sources''' files will be updated.

+

This also updates your local copy of the '''.gitignore''' and '''sources''' files. You will need to do this for each branch that you will be building the new version for. The new tarball will be uploaded only once and the rest will be md5sum checked and not uploaded, only the '''.gitignore''' and '''sources''' files will be updated.

If you just want to add another tarball (e.g. a big gzipped patch or a documentation tarball), use:

If you just want to add another tarball (e.g. a big gzipped patch or a documentation tarball), use:

<pre>fedpkg upload somefile.tar.gz

<pre>fedpkg upload somefile.tar.gz

</pre>

</pre>

−

Contrary to <code>fedpkg new-sources</code>, this does not purge old files from the <code>.cvsignore</code> and <code>sources</code> files.

+

Contrary to <code>fedpkg new-sources</code>, this does not purge old files from the <code>.gitignore</code> and <code>sources</code> files.

If you just have a small patch, initscript, or otherwise plain text file, you can commit those directly to git. This can be done with the <code>git add</code> command, e.g.:

If you just have a small patch, initscript, or otherwise plain text file, you can commit those directly to git. This can be done with the <code>git add</code> command, e.g.:

Line 199:

Line 203:

* Use the command <code>fedpkg mockbuild</code> to test a package build on your local mock system. Then install and test the package. If something doesn't work, fix it and repeat this step. You can also use the koji build system to do a scratch build perhaps for some arch you don't have locally. For example, to build just for x86_64:

* Use the command <code>fedpkg mockbuild</code> to test a package build on your local mock system. Then install and test the package. If something doesn't work, fix it and repeat this step. You can also use the koji build system to do a scratch build perhaps for some arch you don't have locally. For example, to build just for x86_64:

{{Admon/important| Note: Be careful that requesting a build on Rawhide is enough, when that build is successful, for that build to reach the Rawhide repository/build-root after a few hours. Before pressing the Enter key after the following command, it is not a bad idea to think again at the potential consequences on the other packages. }}

+

+

<pre>

# request build

# request build

fedpkg build

fedpkg build

</pre>

</pre>

−

The package builders publish your package in the <code>development</code> tree, also called "Rawhide." If the package is a stable update, you may also provide it to users of the currently-maintained stable, or branched Fedora release. To make it available to F-11 or F-12 users, or testers of the branched F-13 for example, use the procedure outlined in the [[#Packages_in_the_stable_branches |next chapter]].

+

The package builders publish your package in the <code>development</code> tree, also called "Rawhide." If the package is a stable update, you may also provide it to users of the currently-maintained stable, or branched Fedora release. To make it available to F-11 or F-12 users, or testers of the branched F-13 for example, use the procedure outlined in the [[#Working_with_packages_in_the_stable_branches|next chapter]].

An alternative may be used, [[PackageMaintainers/UsingCvsFaq#Import_of_complete_src.rpm_packages| the import of a complete src.rpm]].

An alternative may be used, [[PackageMaintainers/UsingCvsFaq#Import_of_complete_src.rpm_packages| the import of a complete src.rpm]].

Line 257:

Line 267:

<pre>

<pre>

−

koji untag-pkg dist-f13 foo-1.1.3-1.fc13

+

koji untag-pkg f18 foo-1.1.3-1.fc18

</pre>

</pre>

−

Where <code>foo-1.1.3-1.fc13</code> is replaced with the name of your package build. See <code>koji help</code> or [[PackageMaintainers/UsingKoji | UsingKoji]] for more information.

+

Where <code>foo-1.1.3-1.fc18</code> is replaced with the name of your package build. See <code>koji help</code> or [[PackageMaintainers/UsingKoji | UsingKoji]] for more information.

=== Requesting special dist tags ===

=== Requesting special dist tags ===

Line 270:

Line 280:

Stable branches are branches within git for either released Fedoras, or a branched Fedora that is still in bugfix/polish mode but has not yet been released.

Stable branches are branches within git for either released Fedoras, or a branched Fedora that is still in bugfix/polish mode but has not yet been released.

−

# Make any required changes in the <code>F-11</code>, <code>F-12</code> or <code>F-13</code>, etc.. directory. In many cases, you can apply the same changes from the <code>devel/</code> branch to the other branches. Use the <code>diff</code> and <code>patch</code> utilities for this purpose.

+

# Switch to the branch which you would like to update with the <code>fedpkg switch-branch</code> command. Here is an example of an update for Fedora 16: <pre>fedpkg switch-branch f16</pre>

+

# Make any required changes. In many cases, you can apply the same changes from the <code>devel/</code> branch to the other branches. Use the <code>diff</code> and <code>patch</code> utilities for this purpose.

# Use the command <code>fedpkg local</code> to test a package build on your local system. Then install and test the package. If something doesn't work, fix it and repeat this step.

# Use the command <code>fedpkg local</code> to test a package build on your local system. Then install and test the package. If something doesn't work, fix it and repeat this step.

−

# Commit the verified changes to the branch you are working on: <pre>git commit and git push</pre> Example of <code>git push</code>: <pre>git push origin f14:refs/heads/f14/master</pre> See also [[Using_Fedora_GIT#Branch_names | Fedora branch names]].

+

# Commit the verified changes to the branch you are working on: <pre>git commit and git push</pre> Example of <code>git push</code>: <pre>git push origin f16:refs/heads/f16/master</pre> See also [[Using_Fedora_GIT#Branch_names | Fedora branch names]].

# Instruct the builders to build your package:<pre>fedpkg build</pre>

# Instruct the builders to build your package:<pre>fedpkg build</pre>

# Check the koji build page at http://koji.fedoraproject.org/koji/ for the build process.

# Check the koji build page at http://koji.fedoraproject.org/koji/ for the build process.

−

* If you want to build a package for the Pending {{FedoraVersion|long|next}} but it requires package that is not yet pushed "stable" for Fedora 13.

+

* If you want to build a package for the Pending {{FedoraVersion|long|next}} but it requires package that is not yet pushed "stable" for Fedora 16.

# You would need to file a buildroot override tag request as outlined in the policy page Alpha_Freeze_Policy

# You would need to file a buildroot override tag request as outlined in the policy page Alpha_Freeze_Policy

# Once tagged, you can proceed to build her package and issue the [[Package_update_HOWTO#Submit_your_update_to_Bodhi | Bodhi]] request

# Once tagged, you can proceed to build her package and issue the [[Package_update_HOWTO#Submit_your_update_to_Bodhi | Bodhi]] request

Line 282:

Line 293:

== Submit your update to Bodhi ==

== Submit your update to Bodhi ==

−

# This can be accomplished in a few different ways. The easiest being: <pre>fedpkg update</pre> If your local username differs from that of your Fedora account, you will need to specify it with the following command: <pre>BODHI_USER=foo fedpkg update</pre> Or you add <code>BODHI_USER=foo</code> to the file <code>~/.cvspkgsrc</code>.

+

# This can be accomplished in a few different ways. The easiest being: <pre>fedpkg update</pre> If your local username differs from that of your Fedora account, you will need to specify it with the following command: <pre>BODHI_USER=foo fedpkg update</pre> Or you add <code>export BODHI_USER=foo</code> to the file <code>~/.bashrc</code> and run the following command:

+

<pre>source ~/.bashrc

+

fedpkg update

+

</pre>

## Alternatively, you can also submit your update using the [https://fedorahosted.org/bodhi/wiki/CLI bodhi-client]

## Alternatively, you can also submit your update using the [https://fedorahosted.org/bodhi/wiki/CLI bodhi-client]

Overview

Here you can find detailed information on process of Package Management in Fedora. If you want to know the difference between rawhide, development and pending , and which one is suitable for you, along with an overall understanding of the release naming and repos, visit our new and improved Fedora Development Process Overview page.

New contributors (mandatory reading), new Testers (highly suggested reading), new Consumers (useful reading), or anybody interested in how Fedora is developed would find this page useful.

In particular, these are the new paths on mirrors:

/pub/fedora/linux/development/rawhide/ will become the new path of Rawhide. It will continue to not have install images, and will be the place where builds from the "devel" branch in git go to. It'll be Fedora 22 intended content.

/pub/fedora/linux/development/21 will become the new path of the branched Fedora 21 content. This is where builds from the F-21/ branch in git will go after they pass through Bodhi as "stable".

/pub/fedora/linux/updates/testing/21/ will be where potential Fedora 21 builds go after passing through bodhi as "testing". This is where you'll find the latest stuff proposed for freeze break and where testing and peer review of these freeze breaks will happen. When a maintainer feels enough testing has happened, or enough karma triggers the Bodhi auto request, the build will be marked "stable" and show up in the development/21 tree at the next nightly compose.

For Developers

If you want to build a new package, but you aren't sure if it should go to Rawhide or Fedora 22, then:

New packages should always be built at least for Rawhide

New packages can be built for Pending and existing Fedora Releases, however they should go through updates-testing first. If the new package is critical-path it will require net positive karma from Releng / QA and peers as outlined below.

↑Provided the package has net positive Karma from QA or releng and at least one more net positive karma point. If karma autopush is checked submit to stable is done automatically

↑In all cases, it's necessary to be very very very sure the update will not cause additional problems

↑If the package is not in the critical path, nor addressing a security problem, then it can be requested a push to stable
If the package addresses a security issue then it should be marked as security. Wait for the Security team to sign off on the update (not sure how this happens right now) before requesting the package be pushed to stable
If the package is in the critical path, then wait for a QA/Release Engineering/Peer net positive karma vote in Bodhi before requesting the package be pushed to stable

File a buildroot override tag request as outlined in the Policy page, and proceed to build the package

To install and run Fedora 22 as your desktop and participate in test days

X

X

To update a Fedora 12 system to the Pending Fedora 13 for testing

X

To provide test feedback for new packages

X

To represent the QA team in providing feedback on critical path package updates

X

X

If you are a member of the QA FAS group, and provided positive feedback on a 'pending' or 'stable' package update. The package update is released and includes a major regression. What now?

Review in weekly QA meeting. It's ok, mistakes happen.

Accident/omission.

Misuse

For Mirror Admins

If you are a mirror admin and want to prepare for additional repos coming to your mirror :

Read mirror-list(-d) and watch for announcements regarding new paths being added to the Master Mirror.

Check your sync exclusion settings to ensure you either get, or don't get the new path (depending on your needs).

Build a package for Rawhide

To build a package for Rawhide, check it out from the git devel/branch.

Install fedora-packager if not already installed.

Check out a local working copy of the git module you plan to edit, e.g. (for a description of the directory layout, see the Anatomy page:

fedpkg clone <package_name>

Note: If you are not a member of the fedora packager group, you will receive a "permission denied" error. Use the -a flag to clone anonymously.

Note: If you you use a separate ssh key for FAS, remember to load it into your ssh-agent.

If you update to a new upstream version, you have to upload the tarball to an external lookaside cache. Operations on the lookaside cache require a client-side certificate, to get one, run

fedora-cert -n

To upload a new source tarball and replace an older one, run

fedpkg new-sources /path/to/yournewtarball.tar.gz

You can omit the path if the source is the current directory.

In the branch directory (i.e. devel in this case) or for multiple files:

fedpkg new-sources yournewtarball.tar.gz yourdata.tar.gz

This also updates your local copy of the .gitignore and sources files. You will need to do this for each branch that you will be building the new version for. The new tarball will be uploaded only once and the rest will be md5sum checked and not uploaded, only the .gitignore and sources files will be updated.

If you just want to add another tarball (e.g. a big gzipped patch or a documentation tarball), use:

fedpkg upload somefile.tar.gz

Contrary to fedpkg new-sources, this does not purge old files from the .gitignore and sources files.

If you just have a small patch, initscript, or otherwise plain text file, you can commit those directly to git. This can be done with the git add command, e.g.:

git add packagename-fix-the-foobar.patch

Use the command fedpkg mockbuild to test a package build on your local mock system. Then install and test the package. If something doesn't work, fix it and repeat this step. You can also use the koji build system to do a scratch build perhaps for some arch you don't have locally. For example, to build just for x86_64:

As a test whether the full commit was fine, you can check out a fresh working copy into a different directory. It should succeed in fetching the binaries from lookaside cache and also pass simple build tests such as make i686 or make srpm at least.

Note: Be careful that requesting a build on Rawhide is enough, when that build is successful, for that build to reach the Rawhide repository/build-root after a few hours. Before pressing the Enter key after the following command, it is not a bad idea to think again at the potential consequences on the other packages.

# request build
fedpkg build

The package builders publish your package in the development tree, also called "Rawhide." If the package is a stable update, you may also provide it to users of the currently-maintained stable, or branched Fedora release. To make it available to F-11 or F-12 users, or testers of the branched F-13 for example, use the procedure outlined in the next chapter.

Removing a package build from the devel branch

From time to time you may want to remove a package build you pushed to the devel branch (rawhide). This could happen in a situation where a bug
or issue is found in your package that will be resolved upstream in the next release. You may want to wait for this release instead
of back-porting a fix yourself, so pulling the broken package from rawhide makes sense.

Use this carefully!This should only be done on the same day of the build. If your build has already been published in rawhide you must not untag it!

You can remove the package from rawhide by using koji as follows:

koji untag-pkg f18 foo-1.1.3-1.fc18

Where foo-1.1.3-1.fc18 is replaced with the name of your package build. See koji help or UsingKoji for more information.

Requesting special dist tags

When updating a package affects a large number of dependencies (e.g. all perl, python or ghc packages) it may be better to initially do the builds in another repo, so that there is less disruption in rawhide.

If you think you have an update that falls under this case you can request a special dist tag by filing a release engineering ticket. Someone from release engineering will likely want to discuss your needs to make sure this is really an appropriate case (it's OK ask if you aren't sure) and that you get what you need.

Working with packages in the stable branches

Stable branches are branches within git for either released Fedoras, or a branched Fedora that is still in bugfix/polish mode but has not yet been released.

Switch to the branch which you would like to update with the fedpkg switch-branch command. Here is an example of an update for Fedora 16:

fedpkg switch-branch f16

Make any required changes. In many cases, you can apply the same changes from the devel/ branch to the other branches. Use the diff and patch utilities for this purpose.

Use the command fedpkg local to test a package build on your local system. Then install and test the package. If something doesn't work, fix it and repeat this step.

Once submitted, bodhi will automatically request that your update be pushed to updates-testing. If you feel that community testing is unnecessary for your update, you can choose to push it straight to the stable fedora-updates repository instead. Pushing directly to stable skips peer review and is strongly discouraged!! Note that security updates follow a slightly different process .

A Release Engineer then signs and pushes out your updates. The signing step is currently a manual process, so your updates will not be instantly released once submitted to bodhi.

Once pushed to testing, people are able to +1/-1 the updates "karma", based on whether or not it seems to be functional for them. If your update reaches a karma of 3, it will automatically be pushed to stable. Likewise, if it reaches -3, it will be automatically unpushed. If your update does not receive enough feedback to automatically push it to stable, you will have to submit it as a final update yourself. This can easily be done with the command-line tool, or with the web interface.

You will then be notified when your update has been pushed to stable. Bodhi will close all associated bugs and send an announcement to fedora-package-announce. At this point, your update has been officially released!