|
|
| (102 intermediate revisions by 36 users not shown) |
| Line 1: |
Line 1: |
| {{Draft|This page is under re-construction. It covers NFR only for developer Users. To complete for Tester, Mirror, & Other}}
| | {{admon/warning |This page has been moved out of the wiki. The current version of this document is located at https://docs.fedoraproject.org/en-US/package-maintainers/Package_Update_Guide/ Please update your bookmarks.}} |
| | |
| {{admon/note | Make sure you have updated to fedora-packager version 0.5.1 atleast before running any of the commands. Also 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. | |
| 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 [[PackageMaintainers/Package update guidelines]].
| |
| | |
| == Overview ==
| |
| Here you can find some preliminary information about the new process of Package Management. 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.
| |
| | |
| 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''':
| |
| * <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/13/ </code> will become the new path of the branched Fedora 13 content. This is where builds from the F-13/ branch in git will go after they pass through Bodhi as "stable".
| |
| * <code> /pub/fedora/linux/updates/testing/13/ </code> will be where potential Fedora 13 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/13 tree at the next nightly compose.
| |
| (View [[No_Frozen_Rawhide_coming_soon | NFR coming soon! New paths on mirrors!]])
| |
| | |
| == For Developers ==
| |
| {{admon/warning | This table is still under construction. Do not rely on it yet.}}
| |
| {{admon/note|
| |
| 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="1">Mutually exclusive.</ref>
| |
| |
| |
| |style="background-color:#DEF3FE" align=center| X<ref name="1">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="2">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="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:#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:#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>
| |
| 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
| |
| ----
| |
| <references/>
| |
| ----
| |
| <BR>
| |
| | |
| <!------------------------------------------------------ SECOND TABLE -------------------------------------------------------------->
| |
| {|
| |
| ! || 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"|
| |
| |}
| |
| | |
| | |
| | |
| {{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}}.}}
| |
| <BR>
| |
| | |
| == For Testers ==
| |
| {|
| |
| ! || 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
| |
| | |
| |-
| |
| |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| |
| |
| 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 <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 ==
| |
| 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 [[PackageMaintainers/Anatomy| Anatomy]] page:
| |
| <pre>fedpkg clone <package_name>
| |
| </pre>
| |
| | |
| * 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
| |
| | |
| <pre>fedora-cert -n</pre>
| |
| | |
| To upload a new source tarball and replace an older one, run
| |
| | |
| <pre>fedpkg new-sources /path/to/yournewtarball.tar.gz
| |
| </pre>
| |
| | |
| 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:
| |
| <pre>fedpkg new-sources yournewtarball.tar.gz yourdata.tar.gz
| |
| </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.
| |
| | |
| 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>
| |
| Contrary to <code>fedpkg new-sources</code>, this does not purge old files from the <code>.cvsignore</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.:
| |
| <pre>git add packagename-fix-the-foobar.patch
| |
| </pre>
| |
| | |
| * Use the command <code>fedpkg i686</code> or <code>fedpkg x86_64</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. 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:
| |
| <pre>fedpkg srpm; koji build --scratch --arch-override x86_64 dist-f14 packagename-version-release.src.rpm
| |
| </pre>
| |
| | |
| * Check if everything that has changed is correct with
| |
| <pre>fedpkg diff
| |
| </pre>
| |
| | |
| * Commit the verified changes to the <code>devel/</code> branch.
| |
| <pre>fedpkg commit
| |
| git push
| |
| </pre>
| |
| | |
| * Commit and push in one go
| |
| <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.
| |
| | |
| * 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.
| |
| | |
| === Example ===
| |
| | |
| <pre>
| |
| fedpkg clone foo
| |
| cd foo/devel
| |
| 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 i686
| |
| # check that the changes you made are correct
| |
| fedpkg diff
| |
| # commit and push
| |
| fedpkg commit -m "Update to 0.0.2" -p
| |
| # request build
| |
| 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 [[#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 dist-f13 foo-1.1.3-1.fc13
| |
| </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.
| |
| | |
| === 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.
| |
| | |
| = 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.
| |
| | |
| # 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.
| |
| # Use the command <code>fedpkg i686</code> or <code>fedpkg x86_64</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]].
| |
| # 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 13.
| |
| # 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 ==
| |
| | |
| # 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>fedpkg update BODHI_USER=foo</pre> Or you add <code>BODHI_USER=foo</code> to the file <code>~/.cvspkgsrc</code>.
| |
| ## 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 ==
| |
| To automatically get notifications via bugzilla whenever upstream has a new release, refer to [[Upstream_Release_Monitoring | upstream release monitoring]] page.
| |
| | |
| == Reference ==
| |
| http://fedoraproject.org/wiki/PackageMaintainers/UsingCvsFaq
| |
