Package update HOWTO

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Build a package for Rawhide)
(add a note on FAS user names)
 
(43 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{autolang|base=yes}}
+
This document shows how to submit an update for a package you maintain in Fedora. It assumes you already have a package in the Fedora repositories. It is not a guide to using the Fedora package source control system: see the [[Package maintenance guide]] for that.
{{admon/note | Run git config --global --add push.default tracking which instructs git to "push" to whatever branch you are tracking }}
+
  
This document shows how to update a package you maintain in Fedora.  It assumes you already have a package in the Fedora repositories.
+
* For details of the policy on requirements for updates at various stages of the [[Fedora Release Life Cycle]], refer to [[Updates Policy]].
 
+
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 guidance on package updates, refer to [[Updates_Policy]].
+
  
 
== Overview ==
 
== Overview ==
  
Here you can find detailed information on process of Package Management in Fedora. If you want to know the difference between [[Releases/Rawhide | <code>rawhide]], development</code> and <code>pending</code> , and which one is suitable for you, along with an overall understanding of the release naming and repos, visit our new and improved [[ReleaseEngineering/Overview | Fedora Development Process Overview]] page.  
+
This page is intended for new and existing package maintainers. Testers and regular users may be interested in the [[QA:Updates_Testing|updates-testing]] repository and the [[QA:Update_feedback_guidelines|update feedback guidelines]]. This page specifically covers the update submission process.
  
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.
+
There are two significantly different package update submission workflows in Fedora:
  
In particular, these are the '''new paths on mirrors''':
+
* [[Releases/Rawhide|Rawhide]], and [[Releases/Branched|Branched]] up to the [[Updates Policy#Bodhi enabling|Bodhi enabling point]]
* <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.
+
* [[Releases/Branched|Branched]] releases after the Alpha change deadline, and stable releases
* <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.
+
  
(View [[No_Frozen_Rawhide_coming_soon | NFR coming soon! New paths on mirrors!]])
+
The repository layouts differ somewhat for Rawhide, Branched and stable releases, but the update workflows split up as described above.
  
== For Developers ==
+
== Rawhide and early Branched ==
  
{{admon/note|
+
The package update workflow for Rawhide and Branched before the ''Bodhi enabling point'' is simple:
If you want to build a new package, but you aren't sure if it should go to Rawhide or {{FedoraVersion|long|next}}, 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 [[ReleaseEngineering | Releng]] / [[QA]] and peers as outlined below.}}
+
<!------------------------------------------------------ FIRST TABLE -------------------------------------------------------------->
+
{|
+
|-
+
!
+
!valign=top| Check out and build from the devel/branch
+
!valign=top| No action required. Happens [[Releases/Rawhide#Nightly_live_builds | nightly automatically]]
+
!valign=top| Check out and build from the [https://admin.fedoraproject.org/updates/{{FedoraVersion|short|next}} {{FedoraVersion|short|next}}/branch] 
+
!valign=top| Request a testing update in [https://admin.fedoraproject.org/updates/ Bodhi] for {{FedoraVersion|short|next}}. Bodhi ''admins push'' it. 
+
!valign=top| Peers test the update and provide karma feedback via [https://admin.fedoraproject.org/updates/ Bodhi
+
!valign=top| Request a push to ''stable'' within [https://admin.fedoraproject.org/updates/ Bodhi]. Bodhi admins ''push'' it.
+
|-
+
|style="background-color:#DDDDDD" | Build for Rawhide
+
|style="background-color:#DEF3FE" align=center | X
+
+
+
+
+
|
+
|-
+
|style="background-color:#DDDDDD" | Build for Rawhide + testing in other branches
+
|
+
|style="background-color:#DEF3FE" align=center| X
+
+
+
+
|
+
|-
+
|style="background-color:#DDDDDD"| Build non-critical path package for {{FedoraVersion|short|next}} (branched)
+
|
+
|
+
|style="background-color:#DEF3FE" align=center| X
+
+
+
+
|-
+
|style="background-color:#DDDDDD"| Build critical-path for {{FedoraVersion|short|next}} (branched)
+
+
+
|style="background-color:#DEF3FE" align=center| X
+
+
+
|
+
|-
+
|style="background-color:#DDDDDD"| Push critical-path package waiting in "pending" updates-testing repo for a week without karma feedback
+
+
|
+
|
+
|style="background-color:#DEF3FE" align=center| X<ref name="ref1">Mutually exclusive.</ref> 
+
+
|style="background-color:#DEF3FE" align=center| X<ref name="ref1">Mutually exclusive.</ref>
+
|-
+
|style="background-color:#DDDDDD"| For a package, in critical path, in the "pending" updates-testing repo for a week that hasn't received karma feedback
+
+
+
|
+
+
|style="background-color:#DEF3FE" align=center| X<ref name="ref2">Query [[QA|QA]]/[[ReleaseEngineering|Release Engineering]], too</ref> 
+
|
+
|-
+
|style="background-color:#DDDDDD"| To mark, built package for {{FedoraVersion|short|next}}, available for testing
+
|
+
|
+
+
|style="background-color:#DEF3FE" align=center| X
+
|style="background-color:#DEF3FE" align=center| X
+
|
+
|-
+
|style="background-color:#DDDDDD"| To mark ''stable and tagged'' for {{FedoraVersion|short|next}} tested update 
+
|
+
|
+
+
+
+
|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="ref4">In all cases, it's ''necessary''  to be very very very sure the update will not cause additional problems'''</ref>
+
|
+
|
+
|
+
+
+
|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 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>
+
|}<BR>
+
  
Notes
+
# Build the package with {{command|fedpkg build}} (see the [[Package maintenance guide]] for more details)
----
+
<references/>
+
----
+
<BR>
+
  
<!------------------------------------------------------ SECOND TABLE -------------------------------------------------------------->
+
This is all you need to do. Your package will appear in the next daily compose of Rawhide or Branched and will be used in any image composes built from that tree.
{|
+
! || valign=top| File a buildroot override tag request as outlined in the [[Alpha_Freeze_Policy | Policy page]], and proceed to build the package || valign=top| Issue the [https://admin.fedoraproject.org/updates/ Bodhi] request || || || ||
+
|-
+
|style="background-color:#DDDDDD"| To build a package for the ''Pending'' {{FedoraVersion|short|next}} which requires a package not yet pushed ''stable'' for {{FedoraVersion|short|next}}||style="background-color:#DEF3FE" align=center| X ||style="background-color:#DEF3FE" align=center| X ||width="100px"| ||width="100px"| ||width="100px"| ||width="100px"|
+
|}
+
  
 +
== Later Branched and stable releases ==
  
 +
At the [[Updates Policy#Bodhi enabling|Bodhi enabling point]], the [[Bodhi]] update feedback system is enabled by [[ReleaseEngineering|Release Engineering]] and builds submitted with {{command|fedpkg build}} are no longer automatically sent to any official [[Repositories|repository]]. The update workflow for releases of this type is:
  
{{admon/tip|  
+
{{admon/tip|Fedora account name|{{command|fedpkg}} should be able to discover your [[Account_System|Fedora account system]] user name from the {{filename|~/.fedora.cert}} file set up by {{command|fedora-packager-setup}} when you first [[Join_the_package_collection_maintainers#Install_the_client_tools_.28Koji.29_and_set_up_your_certificate|configured your system for packaging]]. If this fails for any reason, you can specify it with {{command|--user (username)}}. For the {{command|bodhi}} command line tool, you may need to specify your Fedora user name with {{command|-u (username)}} if it differs from your system user name.}}
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>
+
  
== For Testers ==
+
# Build the package with {{command|fedpkg build}}
{|
+
# Submit an update for the package with {{command|fedpkg update}}, the [https://admin.fedoraproject.org/updates/ Bodhi web interface], or the [https://fedorahosted.org/bodhi/wiki/CLI Bodhi CLI tool]. This causes the package to be sent to the [[Repositories#updates-testing|''updates-testing'']] repository
!  || Read the [[Releases/Rawhide | Rawhide]] page and  follow instructions|| Keep the ''rawhide'' repo enabled and ''fedora'', ''updates'', & ''updates-testing'' repos disabled. || Consume the rawhide firehose and report issues as you find them.|| Install from Alpha, Beta, the Last Known Good ''Pending'' snapshot or a ''Pending'' nightly live image || <code>yum update</code> to the latest ''pending'' content || Update your Fedora 12 system by reading instructions at [[FIXME]] || Check the [[QA/Join]] page that describes the different testable repos, skill level and investment involved. || Read the [[QA:Package Acceptance Test Plan | Package Acceptance Test Plan]] and use it as a guideline
+
# Monitor the update's status and the feedback you receive via the web interface or the emails that are sent to you, and modify it with updated or additional builds if necessary
 +
# After the update meets the criteria in the [[Updates Policy]] and you are satisfied it should be released as a stable update, submit the update to ''[[Repositories#stable|stable]]'' with {{command|bodhi -R stable}} or the web interface
  
|-
+
{{admon/important|Updating inter-dependent packages|If a package you wish to update requires other package(s) to be rebuilt before it or they will work properly, you '''must''' submit the builds together as a multi-package update. See [[#multi|below]] for more details on this.}}
|style="background-color:#DDDDDD"| To install Rawhide on your system to test the latest packages ||style="background-color:#DEF3FE" align=center| X ||style="background-color:#DEF3FE" align=center| X ||style="background-color:#DEF3FE" align=center| X || || ||  ||  ||
+
|-
+
|style="background-color:#DDDDDD"| To install and run {{FedoraVersion|long|next}} as your desktop and participate in test days ||  ||  || ||style="background-color:#DEF3FE" align=center| X ||style="background-color:#DEF3FE" align=center| X || ||  ||
+
|-
+
|style="background-color:#DDDDDD"| To update a Fedora 12 system to the ''Pending'' Fedora 13 for testing || || || || || ||style="background-color:#DEF3FE" align=center| X ||  ||
+
|-
+
|style="background-color:#DDDDDD"| To provide test feedback for new packages || || || || || ||  ||style="background-color:#DEF3FE" align=center| X ||
+
|-
+
|style="background-color:#DDDDDD"| To represent the [[QA]] team in providing feedback on critical path package updates || || || || || ||  ||style="background-color:#DEF3FE" align=center| X  ||style="background-color:#DEF3FE" align=center| X
+
|-
+
|}
+
[[Category:Package Maintainers]][[Category:How to]]
+
<BR>
+
  
{{admon/note| |
+
=== Update attributes ===
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 ==
+
At the time you submit the update, you will be asked for several attributes. The type of the update should be fairly self-explanatory: either it fixes bugs, adds new features, or is a new package.
* If you are a mirror admin and want to prepare for additional repos coming to your mirror :
+
** Read <code>mirror-list(-d)</code> 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 ==
+
If you are asked whether you want to send the update to ''updates-testing'' or ''stable'', this is a no-op: all updates now go through ''updates-testing''. It does not matter what you choose.
To build a package for Rawhide, check it out from the git devel/branch.
+
  
Install fedora-packager if not already installed.
+
There are several schools of thought on filling out the update description. Some would suggest you consider the target audience: for a stable release, in particular, many Fedora users will see this text, and many of them may not be particularly familiar with your package. Consider not simply describing literally the changes in the update, but explaining as if to an outsider why your are updating the package, what benefits it will bring to them (if any), and anything they may want to note in order to have a smooth update experience.
  
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 [[PackageMaintainers/Anatomy| Anatomy]] page:
+
If you associate one or more bug reports with your update, Bodhi will post comments into Bugzilla to alert those following the bug reports that an update is available. If you mark your update as fixing the bug(s), Bodhi will move the report(s) through the '''MODIFIED''', '''ON_QA''' and '''CLOSED ERRATA''' states of the [[BugZappers/BugStatusWorkFlow|bug workflow]] as your update reaches various points in the process. Using this mechanism can be very useful both for you and for users of your package.
<pre>fedpkg clone <package_name>
+
</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. }}
+
You may set a ''karma'' (feedback) level at which the update will automatically be submitted to ''stable''. This is optional. If you choose to use it, please carefully consider an appropriate feedback level. For a relatively obscure package which is quite stable, 1 or 2 may be an appropriate value. For a popular, sensitive and complex package such as {{package|firefox}} or the {{package|kernel}}, the default of 3 may be insufficient and a choice of 5 or even 10 may be appropriate.
  
{{Admon/important| Note: If you you use a separate ssh key for FAS, remember to load it into your ssh-agent. }}
+
=== Who will receive your update, when? ===
  
* 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
+
When a release is in Branched state, the ''updates-testing'' repository is enabled by default so most users will see the package, but only packages from the stable ''fedora'' repository are used in building milestone releases (Alpha, Beta and Final) and nightly images.
  
<pre>fedora-cert -n</pre>
+
Where a package goes when it is marked as ''stable'' differs between Branched and stable releases. In Branched releases, ''stable'' packages are pushed to the base ''fedora'' repository. In stable releases, ''stable'' packages are pushed to the ''updates'' repository. However, from the point of view of the packager, this is an insignificant implementation detail. For more details, see [[Repositories]].
  
To upload a new source tarball and replace an older one, run
+
When a release is in stable state, the ''updates-testing'' repository is disabled by default, but [[QA]] team members and others run with it enabled in order to provide testing and Bodhi feedback. The main user population will see your update only when it passes Bodhi, is marked as ''stable'' and reaches the ''updates'' repository.
  
<pre>fedpkg new-sources /path/to/yournewtarball.tar.gz
+
{{anchor|multi}}
</pre>
+
=== Updating inter-dependent packages ===
  
You can omit the path if the source is the current directory.
+
If an update you wish to submit would cause a dependency issue of any kind (a strict package dependency error, or simply another package failing to operate correctly) if updated alone, you must not submit the package as a single-package update. You must always collect all inter-dependent or related packages together into a single multi-package update, such that no user will face problems if they install all the packages in the update together.
  
In the branch directory (i.e. devel in this case) or for multiple files:
+
For example: if you maintain a package ''libfoo'' which the package ''bar'' depends on, and you need to update ''libfoo'', you should check that ''bar'' continues to function correctly with the updated version of ''libfoo''. If it does not, you must ensure the appropriate changes are made to ''bar'', and include the updated ''bar'' in your update along with the updated ''libfoo''.
<pre>fedpkg new-sources yournewtarball.tar.gz yourdata.tar.gz
+
</pre>
+
  
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.
+
The ''fedpkg'' tool does not handle multi-package updates. You can add multiple packages to an update using the [https://admin.fedoraproject.org/updates/ Bodhi web application], or the {{command|bodhi}} command line tool. You can pass as many package names as you like to the {{command|bodhi --new}} to create a new multi-package update, or use {{command|bodhi --edit}} to edit an existing update.
  
If you just want to add another tarball (e.g. a big gzipped patch or a documentation tarball), use:
+
It is possible you will run into problems with permissions when trying to add builds of packages you do not have commit privileges for to an update, or trying to add a build for a package you do have privileges for to someone else's update. If you encounter a situation like this, you should contact the [[ReleaseEngineering|release engineering]] team or a proven packager for help.
<pre>fedpkg upload somefile.tar.gz
+
</pre>
+
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.:
+
You may need a ''buildroot override'' to complete a multi-package update successfully. For instance in the case described above, you may need to rebuild ''bar'' against the new ''libfoo'' package and submit both packages together as a multi-package update. However, in the normal course of events, you would not be able to build another package against your new ''libfoo'' build until it reached the [[Repositories#stable|''stable'']] state. To resolve this dilemma, you can request a buildroot override, which causes the ''libfoo'' build to be included in the buildroot for a short time in order to get the ''bar'' package build done.
<pre>git add packagename-fix-the-foobar.patch
+
</pre>
+
  
* 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:
+
You can request a buildroot override with bodhi: {{command|bodhi --buildroot-override<nowiki>=</nowiki>(name-version-release) --duration<nowiki>=</nowiki>2 --notes<nowiki>=</nowiki>"Useful details."}} This would submit a buildroot override with a duration of two days. Buildroot overrides are usually granted within 15-30 minutes of submission. If you submit an override request with the bodhi tool, it will suggest a command that will let you monitor when the package appears in the buildroot, so you can fire your dependent build at the appropriate time.
<pre>fedpkg srpm
+
koji build --scratch --arch-override x86_64 f18 packagename-version-release.src.rpm
+
</pre>
+
  
* Check if everything that has changed is correct with
+
You can also request buildroot overrides from the [https://admin.fedoraproject.org/updates/ Bodhi web application].
<pre>fedpkg diff
+
</pre>
+
  
* Commit the verified changes to the <code>devel/</code> branch.
+
The [[Bodhi/BuildRootOverrides|buildroot override instructions]] explain the buildroot override process in more detail.
<pre>fedpkg commit
+
git push
+
</pre>
+
  
* Commit and push in one go
+
=== Handling feedback from automated tests ===
<pre>fedpkg commit -p</pre>
+
  
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.
+
Fedora's old automated testing system, [[AutoQA]], or its new one, [[Taskotron]], may run automated tests on your update. At present, these include a ''depcheck'' test which attempts to determine if it causes dependency issues, and an ''upgradepath'' test which attempts to determine if it breaks the ''upgrade path'' - that is, if it causes a situation where an older Fedora release has a package considered to be of a higher version than the same package in a newer Fedora release (this is a violation of the [[Updates Policy]]).
  
* Instruct the builders to build your package:
+
The test system will post a comment to Bodhi indicating whether the tests passed or failed. The systems are not 100% accurate, but they are fairly often correct. If you see a failure, it is a very good idea to click on the link to the test results and investigate the issue. If you are unsure what the test indicates, you can contact the [[QA]] team for help.
<pre>fedpkg build
+
</pre>
+
  
* Check the koji build page at http://koji.fedoraproject.org/koji/ for the build process.
+
Automated test failures do not currently prevent your update from being released. However, if you enabled automatic stable push at a karma threshold, this will be disabled if an automated test fails. If you have examined the result and you are sure it is a false one and there is no problem with the package, you may re-enable the automatic push mechanism or submit the package to ''stable'' manually once it meets the other requirements of the [[Updates Policy]].
  
=== Example ===
+
=== Branched milestone freezes ===
  
<pre>
+
For a short period before each milestone release, the stable [[Repositories#fedora|''fedora'']] repository is frozen. These periods are shown as the [[Milestone freezes]] (Alpha Freeze, Beta Freeze, Final Freeze) on schedules. During these periods, builds will not be marked ''stable'' and pushed from [[Repositories#updates-testing|''updates-testing'']] to ''fedora'' even after being submitted manually or automatically. In the normal course of events, they will be pushed after the milestone release is approved at a [[Go_No_Go_Meeting]]. If you believe your update deserves to break a milestone freeze, a ''freeze exception'' may be granted through the [[QA:SOP_freeze_exception_bug_process|freeze exception process]]. Accepted release blocking bugs are granted the same status through the [[QA:SOP_blocker_bug_process|blocker bug process]].
fedpkg clone foo
+
cd foo
+
wget -N http://dl.sf.net/foo/foo-0.0.2.tar.bz2
+
fedpkg new-sources foo-0.0.2.tar.bz2
+
gedit foo.spec
+
# change the required things in the specfile
+
fedpkg mockbuild
+
# check that the changes you made are correct
+
fedpkg diff
+
# commit and push
+
fedpkg commit -m "Update to 0.0.2" -p
+
</pre>
+
  
{{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. }}
+
For more on the Fedora development process, see [[Fedora Release Life Cycle]].
  
<pre>
+
{{admon/tip|
# request build
+
If you are unsure whether your build is currently considered ''stable'' for a given release, you can check with {{command|koji latest-pkg fXX}} (where XX is the release).}}
fedpkg build
+
</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 [[#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]].
+
 
+
More in-depth information on the build system is at
+
[[PackageMaintainers/UsingKoji| UsingKoji]].
+
 
+
=== 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.
+
{{admon/caution|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:
+
 
+
<pre>
+
koji untag-pkg f18 foo-1.1.3-1.fc18
+
</pre>
+
 
+
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 ===
+
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 [https://fedorahosted.org/rel-eng/newticket 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.
+
== Security updates ==
  
= Working with packages in the stable branches =
+
There is an additional process that layers over the regular update process for bugs identified as security issues. If a bug is assigned to you that blocks a [[Security Tracking Bugs|security tracking bug]], you must follow that process in addition to this one.
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 <code>fedpkg switch-branch</code> command. Here is an example of an update for Fedora 16: <pre>fedpkg switch-branch f16</pre>
+
== New package submissions ==
# 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.
+
# 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>
+
# 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 16.
+
If you want to build a new package, but you aren't sure which releases to send it to:
# 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
+
  
== Submit your update to Bodhi ==
+
* New packages should always be built for Rawhide
 +
* New packages can be built for Branched and stable releases if adding them would provide value to users of those releases without significant risk of causing harm
  
# 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:
+
The submission process for new packages, after they have passed the [[Package_Review_Process]] and been [[Package_SCM_admin_requests|given an SCM repository]], is exactly the same as that for package updates.
<pre>source ~/.bashrc
+
fedpkg update
+
</pre>
+
## Alternatively, you can also submit your update using the [https://fedorahosted.org/bodhi/wiki/CLI bodhi-client]
+
## or the [https://admin.fedoraproject.org/updates web interface] .
+
# 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 [[Security/TrackingBugs |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!
+
  
== Get Automatically Notified on New Upstream Releases ==
+
== Consider creating a package test plan ==
To automatically get notifications via bugzilla whenever upstream has a new release, refer to [[Upstream_Release_Monitoring | upstream release monitoring]] page.
+
  
== Reference ==
+
If you [[QA:SOP_test_case_creation|create test cases]] for your package, and [[QA:SOP_package_test_plan_creation|categorize them appropriately]], they will be automatically linked in Bodhi, so that testers will have some guidance for planned update testing.
  
* http://fedoraproject.org/wiki/Using_git_FAQ_for_package_maintainers
+
[[Category:Package Maintainers]]

Latest revision as of 19:02, 27 September 2014

This document shows how to submit an update for a package you maintain in Fedora. It assumes you already have a package in the Fedora repositories. It is not a guide to using the Fedora package source control system: see the Package maintenance guide for that.

Contents

[edit] Overview

This page is intended for new and existing package maintainers. Testers and regular users may be interested in the updates-testing repository and the update feedback guidelines. This page specifically covers the update submission process.

There are two significantly different package update submission workflows in Fedora:

The repository layouts differ somewhat for Rawhide, Branched and stable releases, but the update workflows split up as described above.

[edit] Rawhide and early Branched

The package update workflow for Rawhide and Branched before the Bodhi enabling point is simple:

  1. Build the package with fedpkg build (see the Package maintenance guide for more details)

This is all you need to do. Your package will appear in the next daily compose of Rawhide or Branched and will be used in any image composes built from that tree.

[edit] Later Branched and stable releases

At the Bodhi enabling point, the Bodhi update feedback system is enabled by Release Engineering and builds submitted with fedpkg build are no longer automatically sent to any official repository. The update workflow for releases of this type is:

Idea.png
Fedora account name
fedpkg should be able to discover your Fedora account system user name from the ~/.fedora.cert file set up by fedora-packager-setup when you first configured your system for packaging. If this fails for any reason, you can specify it with --user (username). For the bodhi command line tool, you may need to specify your Fedora user name with -u (username) if it differs from your system user name.
  1. Build the package with fedpkg build
  2. Submit an update for the package with fedpkg update, the Bodhi web interface, or the Bodhi CLI tool. This causes the package to be sent to the updates-testing repository
  3. Monitor the update's status and the feedback you receive via the web interface or the emails that are sent to you, and modify it with updated or additional builds if necessary
  4. After the update meets the criteria in the Updates Policy and you are satisfied it should be released as a stable update, submit the update to stable with bodhi -R stable or the web interface
Important.png
Updating inter-dependent packages
If a package you wish to update requires other package(s) to be rebuilt before it or they will work properly, you must submit the builds together as a multi-package update. See below for more details on this.

[edit] Update attributes

At the time you submit the update, you will be asked for several attributes. The type of the update should be fairly self-explanatory: either it fixes bugs, adds new features, or is a new package.

If you are asked whether you want to send the update to updates-testing or stable, this is a no-op: all updates now go through updates-testing. It does not matter what you choose.

There are several schools of thought on filling out the update description. Some would suggest you consider the target audience: for a stable release, in particular, many Fedora users will see this text, and many of them may not be particularly familiar with your package. Consider not simply describing literally the changes in the update, but explaining as if to an outsider why your are updating the package, what benefits it will bring to them (if any), and anything they may want to note in order to have a smooth update experience.

If you associate one or more bug reports with your update, Bodhi will post comments into Bugzilla to alert those following the bug reports that an update is available. If you mark your update as fixing the bug(s), Bodhi will move the report(s) through the MODIFIED, ON_QA and CLOSED ERRATA states of the bug workflow as your update reaches various points in the process. Using this mechanism can be very useful both for you and for users of your package.

You may set a karma (feedback) level at which the update will automatically be submitted to stable. This is optional. If you choose to use it, please carefully consider an appropriate feedback level. For a relatively obscure package which is quite stable, 1 or 2 may be an appropriate value. For a popular, sensitive and complex package such as Package-x-generic-16.pngfirefox or the Package-x-generic-16.pngkernel, the default of 3 may be insufficient and a choice of 5 or even 10 may be appropriate.

[edit] Who will receive your update, when?

When a release is in Branched state, the updates-testing repository is enabled by default so most users will see the package, but only packages from the stable fedora repository are used in building milestone releases (Alpha, Beta and Final) and nightly images.

Where a package goes when it is marked as stable differs between Branched and stable releases. In Branched releases, stable packages are pushed to the base fedora repository. In stable releases, stable packages are pushed to the updates repository. However, from the point of view of the packager, this is an insignificant implementation detail. For more details, see Repositories.

When a release is in stable state, the updates-testing repository is disabled by default, but QA team members and others run with it enabled in order to provide testing and Bodhi feedback. The main user population will see your update only when it passes Bodhi, is marked as stable and reaches the updates repository.

[edit] Updating inter-dependent packages

If an update you wish to submit would cause a dependency issue of any kind (a strict package dependency error, or simply another package failing to operate correctly) if updated alone, you must not submit the package as a single-package update. You must always collect all inter-dependent or related packages together into a single multi-package update, such that no user will face problems if they install all the packages in the update together.

For example: if you maintain a package libfoo which the package bar depends on, and you need to update libfoo, you should check that bar continues to function correctly with the updated version of libfoo. If it does not, you must ensure the appropriate changes are made to bar, and include the updated bar in your update along with the updated libfoo.

The fedpkg tool does not handle multi-package updates. You can add multiple packages to an update using the Bodhi web application, or the bodhi command line tool. You can pass as many package names as you like to the bodhi --new to create a new multi-package update, or use bodhi --edit to edit an existing update.

It is possible you will run into problems with permissions when trying to add builds of packages you do not have commit privileges for to an update, or trying to add a build for a package you do have privileges for to someone else's update. If you encounter a situation like this, you should contact the release engineering team or a proven packager for help.

You may need a buildroot override to complete a multi-package update successfully. For instance in the case described above, you may need to rebuild bar against the new libfoo package and submit both packages together as a multi-package update. However, in the normal course of events, you would not be able to build another package against your new libfoo build until it reached the stable state. To resolve this dilemma, you can request a buildroot override, which causes the libfoo build to be included in the buildroot for a short time in order to get the bar package build done.

You can request a buildroot override with bodhi: bodhi --buildroot-override=(name-version-release) --duration=2 --notes="Useful details." This would submit a buildroot override with a duration of two days. Buildroot overrides are usually granted within 15-30 minutes of submission. If you submit an override request with the bodhi tool, it will suggest a command that will let you monitor when the package appears in the buildroot, so you can fire your dependent build at the appropriate time.

You can also request buildroot overrides from the Bodhi web application.

The buildroot override instructions explain the buildroot override process in more detail.

[edit] Handling feedback from automated tests

Fedora's old automated testing system, AutoQA, or its new one, Taskotron, may run automated tests on your update. At present, these include a depcheck test which attempts to determine if it causes dependency issues, and an upgradepath test which attempts to determine if it breaks the upgrade path - that is, if it causes a situation where an older Fedora release has a package considered to be of a higher version than the same package in a newer Fedora release (this is a violation of the Updates Policy).

The test system will post a comment to Bodhi indicating whether the tests passed or failed. The systems are not 100% accurate, but they are fairly often correct. If you see a failure, it is a very good idea to click on the link to the test results and investigate the issue. If you are unsure what the test indicates, you can contact the QA team for help.

Automated test failures do not currently prevent your update from being released. However, if you enabled automatic stable push at a karma threshold, this will be disabled if an automated test fails. If you have examined the result and you are sure it is a false one and there is no problem with the package, you may re-enable the automatic push mechanism or submit the package to stable manually once it meets the other requirements of the Updates Policy.

[edit] Branched milestone freezes

For a short period before each milestone release, the stable fedora repository is frozen. These periods are shown as the Milestone freezes (Alpha Freeze, Beta Freeze, Final Freeze) on schedules. During these periods, builds will not be marked stable and pushed from updates-testing to fedora even after being submitted manually or automatically. In the normal course of events, they will be pushed after the milestone release is approved at a Go_No_Go_Meeting. If you believe your update deserves to break a milestone freeze, a freeze exception may be granted through the freeze exception process. Accepted release blocking bugs are granted the same status through the blocker bug process.

For more on the Fedora development process, see Fedora Release Life Cycle.

Idea.png
If you are unsure whether your build is currently considered stable for a given release, you can check with koji latest-pkg fXX (where XX is the release).

[edit] Security updates

There is an additional process that layers over the regular update process for bugs identified as security issues. If a bug is assigned to you that blocks a security tracking bug, you must follow that process in addition to this one.

[edit] New package submissions

If you want to build a new package, but you aren't sure which releases to send it to:

  • New packages should always be built for Rawhide
  • New packages can be built for Branched and stable releases if adding them would provide value to users of those releases without significant risk of causing harm

The submission process for new packages, after they have passed the Package_Review_Process and been given an SCM repository, is exactly the same as that for package updates.

[edit] Consider creating a package test plan

If you create test cases for your package, and categorize them appropriately, they will be automatically linked in Bodhi, so that testers will have some guidance for planned update testing.