Package maintenance guide

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(fix reference to gitweb to be cgit)
m (fix [fedpkg merge master] -> [git merge master])
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{autolang|base=yes}}
 
{{autolang|base=yes}}
{{admon/important | Git config needs| A config problem has been discovered which may make <code>fedpkg push</code> or <code>fedpkg commit -p</code> or even <code>git push</code> not understand your intentions.  As a short term work around, you can run: <code>git config --global push.default tracking</code>.  This option tells git that when it gets a push request with no other arguments, see if it's tracking a remote branch.  If it is, push to that remote branch.  This seems like it will usually be safe no matter what git repository you are using.}}
 
  
== Cookbooks ==
+
This page provides some basic instructions for day-to-day usage of the [http://git-scm.com/ git]-based package maintenance system for Fedora. It is intended primarily for new and current Fedora package maintainers, but does briefly [[#anon|cover anonymous read-only use of the system]]. It is not a guide to RPM packaging per se. Some pre-existing knowledge of git may be useful, but is not a pre-requisite (in fact, Fedora packaging can be a relatively painless introduction to it).
  
Refer to [[Package_update_HOWTO |How to update a package]] if you want to update an existing package.
+
You may have been looking for, or also be interested in:
  
[[New package process for existing contributors]] gives step-by-step instructions for that case.
+
* [[How_to_create_an_RPM_package|Learning to create packages]]
 +
* [[Join_the_package_collection_maintainers|Becoming a package maintainer]]
 +
* [[Package_update_HOWTO|Submitting package updates]]
 +
* [[New_package_process_for_existing_contributors|Adding a new package to the repository]] as an existing maintainer
 +
* [[Package_SCM_admin_requests#Package_Change_Requests_for_existing_packages|adding a new release branch]] to an existing package
 +
* [[Packaging:Guidelines|The Packaging Guidelines]]
  
== Commands ==
+
== Installing ''fedpkg'' and doing initial setup ==
  
Here is a basic table of equivalent commands:
+
The {{command|fedpkg}} tool will usually be your primary interface to the packaging system. Install it with {{command|yum install fedpkg}}, or any equivalent command. If you have not already done so, you will also need to install {{package|fedora-packager}} and run {{command|fedora-packager-setup}}. If you have run {{command|fedora-packager-setup}} before, but wish to set up a new machine for package maintenance, copy the files {{filename|~/.fedora*.cert}} to the new system.
{|
+
! OLD CVS !! NEW GIT !! Notes
+
|-
+
|cvs checkout libfoo || fedpkg clone libfoo || Note that branches are not separated out by directory with this command. <BR> To switch to a different branch with this layout, run: fedpkg switch-branch f13
+
|-
+
|cvs checkout libfoo '''(ALTERNATE)''' ||fedpkg clone -B libfoo || This command creates the same branch/directory layout that was used with cvs.
+
|-
+
|cvs update || fedpkg pull ||Retrieve latest content from fedora git
+
|-
+
|cvs commit . || fedpkg commit -p || The -p option to commit invokes a push, just like with git, but you can separate these actions, as shown just below
+
|-
+
|cvs commit . '''(ALTERNATE)''' || fedpkg commit && fedpkg push ||
+
|-
+
|cvs commit -m 'breaking things' . || fedpkg commit -m 'breaking things' -p ||
+
|-
+
|cvs add foo bar || git add foo bar ||
+
|-
+
|make clog || fedpkg clog || Create the "clog" file from the %changelog of the specfile.
+
|-
+
|cvs commit -F clog . || fedpkg commit -F clog -p || Use the contents of file "clog" as the commit message.
+
|-
+
|make tag || N/A || Explicitly tagging source states for package builds is no longer necessary.
+
|-
+
|make build || fedpkg build || When successful on Koji, the build will be tagged in koji with the corresponding koji tag (e.g., dist-f15 for Rawhide and dist-f14-updates-candidate for F14). No git tag will be created as of 2010-08-06. You can use <code>git tag $(fedpkg verrel) && git push --tags</code> to do this manually.
+
|-
+
|BUILD_FLAGS="--nowait" make build || fedpkg build --nowait || See above. The --nowait option to the build command avoid your waiting (for the build to complete before freeing up the Shell)
+
|-
+
|make prep || fedpkg prep ||
+
|-
+
|make chain-build CHAIN='foo bar : baz'|| fedpkg chain-build foo bar : baz || Just like before, the current directory package is always added to the end of the CHAIN list.
+
|-
+
|make scratch-build || fedpkg scratch-build ||
+
|-
+
|make srpm || fedpkg srpm ||
+
|-
+
|make srpm-scratch-build || fedpkg srpm<BR>fedpkg scratch-build --srpm <name of srpm> || Ideally this would be made a single "fedpkg srpm-scratch-build" command
+
|-
+
|make local || fedpkg local ||
+
|-
+
|make x86_64 || fedpkg local --arch x86_64 ||
+
|-
+
|make upload FILES='apollo starbuck'|| fedpkg upload apollo starbuck || Remember, this adds new source files without replacing others.
+
|-
+
|make new-sources FILES='red_fish blue_fish' || fedpkg new-sources red_fish blue_fish || This replaces any existing source files.
+
|-
+
|make help || fedpkg help || "fedpkg -h" also works
+
|-
+
|./cvs-import.sh libfoo-1.2-3.src.rpm || fedpkg clone libfoo <BR> cd libfoo <BR> fedpkg import libfoo-1.2-3.src.rpm <BR> (Review Changes) <BR> fedpkg commit -p ||
+
|}
+
  
=== Anonymous checkout ===
+
You also must have an ssh key configured in the [https://admin.fedoraproject.org/accounts/ Fedora Accounts System] to be able to make changes to any package (including your own). fedpkg will expect the correct ssh key to be available in your keyring.
  
If you need anonymous clone (checkout) without fedpkg, you can use git: <pre>git clone git://pkgs.fedoraproject.org/libfoo</pre> for package <code>libfoo</code>
+
== Common fedpkg commands ==
  
=== Merging ===
+
This section lists typical fedpkg commands in a normal workflow, with short descriptions. Longer explanations for each can be seen by clicking the 'Show' links. In this workflow, we will be operating on the [[Releases/Rawhide|Rawhide]] branch of the package.
  
Merging is one of the things that we can now do directly in the VCS that we had to do with an external diff program in CVSGetting used to how it works may take a little adjustment though.
+
* Check out a package:
 +
fedpkg co <source_package_name>
 +
cd <source_package_name>
 +
{{hidden|header=Details|content=This retrieves a copy of the package sources from the server. It's known as your 'working copy'.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Update your checked-out copy from the Fedora server:
 +
fedpkg pull
 +
* Retrieve the package sources:
 +
fedpkg sources
 +
{{hidden|header=Details|content=This pulls any sources stored in the "lookaside cache" (see below for more). Steps like {{command|fedpkg prep}} and {{command|fedpkg srpm}} will do this if necessary, but you may want a copy right away.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Make your changes to the package
 +
{{hidden|header=Details|content=This is not an RPM packaging guide, so we'll assume you know what you're doing here. New sources and patches go in the working copy directory for now.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Run the 'prep' stage (extract source, apply patches etc) within the checkout directory:
 +
fedpkg prep
 +
{{hidden|header=Details|content=This is useful for making sure your patches apply cleanly, and inspecting the source tree if you need to do so.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Do a local build of the current state:
 +
fedpkg local
 +
{{hidden|header=Details|content=This is the simplest kind of test build, but it's usually cleaner and a better test to do a Mock or Koji scratch build (see below).|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Do a mock build of the current state:
 +
fedpkg mockbuild
 +
{{hidden|header=Details|content=This fires off a [[Projects/Mock|Mock]] build, if you have Mock configured correctly. [[Using_Mock_to_test_package_builds]] can help there. |headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Generate a .src.rpm from the current state:
 +
fedpkg srpm
 +
{{hidden|header=Details|content=You can request a [[Koji]] 'scratch build' (a test build, which will not go to any repository) of the generated .src.rpm with the {{command|koji build --scratch}} command (see {{command|man koji}}).|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Check changes you have made:
 +
fedpkg diff
 +
{{hidden|header=Details|content=This is handy for making sure you didn't touch something by mistake, or forget to bump the release, or forget to include a changelog...|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Run some checks (rpmlint) on your package:
 +
fedpkg lint
 +
* Stage any small patches or new source files for commit:
 +
git add (somefile)
 +
{{hidden|header=Details|content=git does not consider all files in the working directory to be a part of the git repository by default (handy, for keeping other files around that are relevant, like the source tree). This tells git to start considering these files as part of the repository ''locally''. When you 'commit' and 'push' later, this change is communicated to the server.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Upload new source files to the lookaside cache:
 +
  fedpkg new-sources
 +
{{admon/warning|Alert|This will replace the current list of source files, not add to it. See ''Details'' for more details on the lookaside cache system.}}
 +
fedpkg upload
 +
{{hidden|header=Details|content='Pristine' upstream sources (like release tarballs) and other larger source files are stored in the [[Package_Source_Control#Lookaside_Cache|lookaside cache]] system, not committed directly to git. This provides more efficient storage and transfer of the files. The {{filename|sources}} and {{filename|.gitignore}} files in the repository keep it in sync with the lookaside cache. Any time you use {{command|fedpkg new-sources}} or {{command|fedpkg upload}}, you must remember to 'commit' changes to those files.
  
==== Initial Merging ====
+
{{command|new-sources}} 'starts from scratch', replacing all files currently in the lookaside cache - you'll typically use this command for many packages with just a single source tarball, each time you update to a new upstream version. {{command|upload}} just adds the given file to those already in the cache. Do remember not to leave stale sources lying around.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Switch to a different release branch:
 +
fedpkg switch-branch <f{{FedoraVersionNumber}}, el6, master>
 +
{{hidden|header=Details|content=Each Fedora release has its own branch in each package repository so different builds can be sent to each release. See below for more details on working with branches.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Generate git changelog from package changelog:
 +
fedpkg clog
 +
{{hidden|header=Details|content=This command extracts your package changelog entry to the file {{filename|clog}}, so you can use it as the git changelog if you like. Some maintainers draw a distinction between the two, some do not.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Commit changes:
 +
fedpkg commit (-F clog) (-p) (-c)
 +
{{admon/note|Difference from git|This behaves by default like {{command|git commit -a}} - it stages all modified files, though it does not add unstaged files.}}
 +
{{hidden|header=Details|content=This creates a sort of bundle, a 'commit', of your changes to the repository, with a unique identity and a changelog. Other maintainers - and you yourself, later - can view the history of changes to the repository with the 'commit' as the finest level of detail. It is good practice to use many relatively small commits, each for a single purpose - don't combine a version bump with a bunch of whitespace fixes and some scriptlet changes all in one commit, create separate commits for each.
  
First, the way we imported from cvs means that we have to do a little work to make the older release branches "mergable" (F-14, since it branched after the conversion to git, doesn't need this).
+
The {{command|-F clog}} parameter will use the {{filename|clog}} file from the previous step as the changelog. {{command|-p}} will push (see below) at the same time as committing. {{command|-c}} combines the {{command|clog}} and {{command|commit -F clog}} steps into one, if you like that.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Push changes:
 +
fedpkg push
 +
{{hidden|header=Details|content=This sends all the new 'commits' in your local working copy to the upstream server. If you are still learning the system, now is a good time to {{command|fedpkg co}} another copy of the repository somewhere else, compare what you get to your working copy, and run a test build on it.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Do an 'official' build of the latest pushed changes:
 +
fedpkg build
 +
{{admon/important|Going into production|This is the first point at which you might possibly cause real mess for a real user, so use it with caution. If you are following the example and operating on Rawhide, your build would go live for Rawhide users some few hours after you ran this command.}}
 +
{{admon/note|Uses pushed state|Unlike most of the above commands, this operates on the ''state you have pushed to git'', not the local state. If you have issues make sure you have pushed and committed all patches and handled the sources correctly.}}
 +
{{hidden|header=Details|content=This triggers a 'real' (not scratch) build of your package in [[Koji]]. Depending on the release you are building for, it may go directly to the [[Repositories#stable|''stable'' state]] or it may have to run through the [[Updates Policy|update process]]. See the [[Package_update_HOWTO|package update guide]] for more details on this. The command will output a URL where you can monitor the build's progress in Koji.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
 +
* Submit a package update for the latest build:
 +
fedpkg update
 +
{{hidden|header=Details|content=Again, see the [[Package_update_HOWTO|package update guide]] for more details on this process. This step is not actually applicable to Rawhide, but illustrated here for completeness.|headerstyle=background:#e5e5e5|fw1=normal|ta1=left}}
  
{{admon/note|Which branches should you apply this to?|For packages where F-12, F-13, the freshly branched F-14 and rawhide all have the same spec files and packages, merging all the branches together clearly makes sense. However, when, say F-12 and F-13 share a package NVR, and F-14 and rawhide do... what to do then? Merge the branches that are supposed to be the same, then.
+
== Typical ''fedpkg'' session ==
}}
+
  
 +
A typical session may look like this:
 
<pre>
 
<pre>
fedpkg clone bzrtools
+
fedpkg clone foo
cd bzrtools
+
cd foo
git merge origin/f13/master
+
fedpkg sources
# If no conflicts proceed to the next step.
+
fedpkg new-sources foo-0.0.2.tar.bz2
# Otherwise, resolve the conflicts, git add & git commit, and then move on
+
gedit foo.spec      # change the required things in the specfile.
git merge origin/f12/master
+
                    # rpmdev-bumpspec is useful for simple version updates
git merge origin/el6/master
+
fedpkg mockbuild    # check that the changes you made are correct
git merge origin/el5/master
+
fedpkg diff
 +
fedpkg lint
 +
fedpkg commit -p -c  # commit and push in one go
 
</pre>
 
</pre>
  
Potentially better alternative to the above (without conflicts, without actually changing the master content, and merging ALL former CVS branches which are supposed to be the same package):
+
== Working with branches ==
  
<pre>
+
Each Fedora release is represented by a branch in the git repository. You can switch between them like this:
fedpkg clone menu-cache
+
fedpkg switch-branch f{{FedoraVersionNumber}}
cd menu-cache
+
fedpkg switch-branch f{{FedoraVersionNumber|previous}}
# implicitly we have the master branch checked out here
+
fedpkg switch-branch master
git merge -m "Initial pseudo merge for dist-git setup" -s ours origin/{f12,f13}/master
+
The ''master'' branch is for [[Releases/Rawhide|Rawhide]]. You can maintain each branch entirely separately, if you like, laboriously copying changes between them (so long as you always stay within the [[Updates Policy]] requirements). However, git provides us with several handy tools for working with branches. Here's an example:
</pre>
+
{{#tag:pre|
 
+
==== Merging in normal operation ====
+
 
+
Now when you make changes on one branch and want to move them to a different branch, you can use git to merge those changes.
+
 
+
<pre>
+
 
fedpkg clone bzrtools
 
fedpkg clone bzrtools
 
# Make some changes in the master branch
 
# Make some changes in the master branch
 
fedpkg new-sources bzrtools-2.2.tar.gz
 
fedpkg new-sources bzrtools-2.2.tar.gz
vim bzrtools.spec
+
gedit bzrtools.spec
git commit
+
fedpkg commit
fedpkg switch-branch f14
+
fedpkg switch-branch f{{FedoraVersionNumber}}
 
git merge master
 
git merge master
 
# for push into repo
 
# for push into repo
git push
+
fedpkg push
</pre>
+
}}
 +
This will 'merge' the changes from the ''master'' (Rawhide) branch to the f{{FedoraVersionNumber}} branch. git aficionados may note this is a somewhat unusual workflow, but it is appropriate to the context of package management. Remember, after pushing to and building for a stable release or a [[Releases/Branched|Branched]] release after [[Updates Policy#Bodhi enabling|Bodhi has been enabled]], you will have to [[Package_update_HOWTO|submit an update]] before any other Fedora users will see your build.
  
==== Resolving merge conflicts ====
+
Note that merges will only be sure to work cleanly so long as the branches have not previously diverged. That is, if you do this:
 +
{{#tag:pre|
 +
fedpkg clone bzrtools
 +
# Make some changes in the master branch
 +
fedpkg commit
 +
fedpkg switch-branch f{{FedoraVersionNumber}}
 +
# Make some changes in the f{{FedoraVersionNumber}} branch
 +
fedpkg commit
 +
fedpkg switch-branch master
 +
# Make some more changes in the master branch
 +
fedpkg commit
 +
fedpkg switch-branch f{{FedoraVersionNumber}}
 +
git merge master
 +
}}
 +
you may encounter a ''merge conflict''.
  
When you git merge and a conflict occurs you still edit the files that have conflicts.  Remove the conflict markers in the files and merge the changes manually.  Then you need to commit your changes. Do that with <code>git add CONFLICTEDFILES ; git commit</code>
+
Remember that git is a ''collaborative'' system, and used as such in Fedora package management. It is often the case that you must consider changes made by others in working on a package, and consider how your changes will affect others.
  
===== Using <code>git mergetool</code> to resolve conflicts =====
+
=== Resolving merge conflicts ===
  
Git allows you to set a graphical diff program to help resolve conflicts.  This can be handy for visualizing what changes have occurred and deal with them as a set.
+
This is a large topic and somewhat beyond the scope of this guide, but we can give basic pointers. There are other good references in the [http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging git book] and at [https://help.github.com/articles/resolving-a-merge-conflict-from-the-command-line github].
<pre>
+
 
 +
When you git merge and a conflict occurs you can edit the files that have conflicts. Remove the conflict markers in the files and merge the changes manually. Use {{command|git diff}} or {{command|fedpkg diff}} to inspect the changes against the pre-conflict state and verify you are happy with the resolution. Then you can commit the files with {{command|fedpkg commit}} or {{command|git commit -a}}. git will know if you have resolved the conflict by checking that all the conflict markers have been removed.
 +
 
 +
=== Using <code>git mergetool</code> to resolve conflicts ===
 +
 
 +
Git provides a graphical diff program to help resolve conflicts.  This can be handy for visualizing what changes have occurred and dealing with them as a set.
 +
{{#tag:pre|
 
git config --global merge.tool meld
 
git config --global merge.tool meld
fedpkg switch-branch f13
+
fedpkg switch-branch f{{FedoraVersionNumber}}
 
git merge master
 
git merge master
 
# Conflicts occurred
 
# Conflicts occurred
git mergetool # Opens up a meld showing a three way diff of the merge, working tree, and the last commit
+
git mergetool           # Opens up a meld showing a three way diff of  
 +
                        # the merge, working tree, and the last commit
 
# Resolved all the conflicts in the GUI
 
# Resolved all the conflicts in the GUI
 
git add CONFLICTEDFILES
 
git add CONFLICTEDFILES
 
git commit
 
git commit
</pre>
+
}}
  
== Branch names ==
+
== Requesting special dist tags ==
{|
+
! Old CVS !! new remote git !! fedpkg local branch names !! Notes
+
|-
+
| devel || origin/master || master || This is the default when you do fedpkg co
+
|-
+
| F-16|| origin/f16/master || f16 ||
+
|-
+
| F-15 || origin/f15/master || f15 ||
+
|-
+
| F-14 || origin/f14/master || f14 ||
+
|-
+
| EL-6 || origin/el6/master || el6 ||
+
|-
+
| EL-5 || origin/el5/master || el5 ||
+
|}
+
  
{{admon/note|local branch names| If you use git commands to branch and checkout directly, you can define whatever local branch names you want. If you use <code>fedpkg switch-branch</code>, it will default to creating the names listed in the table above.  So you can do <code>fedpkg clone firefox ; fedpkg switch-branch f14</code> and then you'll have a new local branch named <code>f14</code>}}
+
When a change to a package affects a large number of dependencies (e.g. all perl, python, ruby or ghc packages), requiring them to be rebuilt, it may be better to initially do the builds in a special repository, so that there is less disruption in Rawhide.
  
{{admon/tip|Display current branch in your shell prompt| It is often helpful to know what branch you are working on at a glance. You can add this information to your bash prompt with the information [[Git_Quickref#Display_current_branch_in_bash|here]].}}
+
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 [[ReleaseEngineering|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.
  
== Errors ==
+
== Tips and tricks ==
  
=== Access denied ===
+
{{anchor|anon}}
 +
=== Using fedpkg anonymously ===
  
During the next few days and weeks, occasional tweaking to the servers might cause short periods (seconds or minutes) when the git server refuses you access. Just try again.
+
You can use fedpkg like this:
 +
fedpkg clone --anonymous <somepackage>
 +
to check out a package without requiring identification. Obviously, you will not be able to push any changes to this repository, but it is useful for non-packagers who simply want to examine a package and perhaps submit changes to a Fedora developer.
  
=== Unable to switch ===
+
=== Local branch names ===
  
If you are trying switch to another branch by fedpkg switch-branch f13 and see this:
+
If you use git commands to branch and checkout directly, you can define whatever local branch names you want. If you use {{command|fedpkg switch-branch}}, it will default to creating the names used in the examples above.
Unable to switch to another branch: Could not create branch f13
+
 
 +
=== Current branch and state in shell prompt ===
 +
 
 +
It is often helpful to know what branch you are working on at a glance.  You can add this information to your bash prompt with the information [[Git_Quickref#Display_current_branch_in_bash|here]].
 +
 
 +
=== Importing a .src.rpm to update ===
 +
 
 +
The {{command|fedpkg import}} command usually used to initially populate a git package repository from a .src.rpm that has been through the [[Package Review Process]] can also be used to update a normal working copy, if you have an old-school packaging process to which you are particularly attached. Just run {{command|fedpkg import file.src.rpm}} and it will upload new tarballs into lookaside cache, update a working copy of the last version found in git, and commit all changes. {{command|fedpkg import --help}} documents some other parameters it can accept.
 +
 
 +
{{admon/warning|Caution!|This approach makes it harder to verify that your changes are safe and do not overwrite changes made to the package by others. For this reason, its use is not recommended.}}
 +
 
 +
=== Making changes on an older branch without breaking the upgrade path ===
 +
 
 +
Here is the scenario: you've built your package successfully on the ''{{FedoraVersionNumber}}'' branch, but there is a problem keeping your package from building on ''{{FedoraVersionNumber|last}}''.
 +
 
 +
Solution: make your changes in the branch and then add a digit to the very right of the release tag. There is no need to change the release in the other branches. This allows upgrades to work smoothly if the user upgrades to a newer release of Fedora.
  
Then you probably have some un-commited changes in master. If you want them, call:
 
 
<pre>
 
<pre>
# this "saves" your changes
+
Name:    foo
git stash
+
Version: 1.0
# switch to preferred branch, now possible
+
Release: 1%{?dist}
fedpkg switch-branch f13
+
 
# apply "saved" changes into the current branch
+
Name:    foo
git stash apply
+
Version: 1.0
 +
Release: 1%{?dist}.1
 
</pre>
 
</pre>
  
== ssh fingerprint ==
+
Then tag and build as usual. This approach was initially discussed [https://www.redhat.com/archives/fedora-extras-list/2006-May/msg00083.html in this mailing list thread].
 +
 
 +
=== Removing a package build pending for [[Releases/Rawhide|Rawhide]] or [[Releases/Branched|Branched]] ===
 +
 
 +
From time to time you may want to remove a package build you submitted to Rawhide or to Branched prior to the Alpha freeze (both cases where the build would usually go out to the main [[Repositories|repository]] without further gating). 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, or you realize you made a significant mistake in the build that cannot easily be corrected.
 +
 
 +
{{admon/caution|Use this carefully!|This should only be done on the same day of the build, before it is included in a compose. If your build was already included in a compose you must not untag it! Check the [https://apps.fedoraproject.org/releng-dash/ Release Engineering Dashboard] to get the starting time of the last compose.}}
 +
 
 +
You can remove the package by using [[Koji]]: {{command|koji untag-pkg f{{FedoraVersionNumber|next}} foo-1.1.3-1.fc{{FedoraVersionNumber|next}}}}
 +
 
 +
where {{filename|foo-1.1.3-1.fc{{FedoraVersionNumber|next}}}} is replaced with the name of your package build.  See {{command|koji help}} or [[Using_the_Koji_build_system|using Koji]] for more information.
 +
 
 +
=== ssh fingerprint ===
  
 
The recommended option is to include "<code>VerifyHostKeyDNS yes</code>" in your ~/.ssh/config file. This will result in using DNS to check that the key is correct.
 
The recommended option is to include "<code>VerifyHostKeyDNS yes</code>" in your ~/.ssh/config file. This will result in using DNS to check that the key is correct.
  
 
But you can also manually check against the  list of keys at https://admin.fedoraproject.org . The strings there are what ends up in your ~/.ssh/known_hosts file. So you can accept the fingerprint when prompted and then check that the correct string for pkgs.fedoraproject.org ended up in your ~/.ssh/known_hosts file.
 
But you can also manually check against the  list of keys at https://admin.fedoraproject.org . The strings there are what ends up in your ~/.ssh/known_hosts file. So you can accept the fingerprint when prompted and then check that the correct string for pkgs.fedoraproject.org ended up in your ~/.ssh/known_hosts file.
 +
 +
=== Problems connecting to the repository ===
 +
 +
The ''fedpkg'' tool clones repositories using the ssh:// protocol, so this should not be a problem normally (as long as you have your ssh key).  If you cloned using the ''git'' utility itself, check the {{filename|.git/config}} file to ensure the remote repository is being accessed via an ssh:// protocol, and not git://.
 +
 +
=== Expired certificates (Error 255 or OpenSSL.SSL.Error) ===
 +
 +
This error usually means that your client certificate (~/.fedora.cert) has expired, so you need to run fedora-cert to get a new one. If you have trouble with this, you may try removing {{filename|~/.fedora*.cert}} and re-running {{command|fedora-packager-setup}}.
 +
 +
=== It builds here, why doesn't it build there? ===
 +
 +
Is your package building locally - even with Mock, even as a scratch build! - but not when you run {{command|fedpkg build}}? Before you get too frustrated, remember {{command|fedpkg build}} runs on the package as it exists in the upstream repository, not your local working copy. Make sure you have committed and pushed all changes and source files, and handled the lookaside cache correctly.
  
 
== References ==
 
== References ==
Line 187: Line 243:
 
* [[PackageMaintainers/BuildSystemClientSetup#Install_the_Client_Tools_.28Koji.29]]  
 
* [[PackageMaintainers/BuildSystemClientSetup#Install_the_Client_Tools_.28Koji.29]]  
 
* [[PackageMaintainers/MockTricks#How_do_I_use_Mock.3F]]  
 
* [[PackageMaintainers/MockTricks#How_do_I_use_Mock.3F]]  
 +
* [[Using_the_Koji_build_system]]
 
* [[Package_Review_Process]]  
 
* [[Package_Review_Process]]  
 
* [[Fedora_Release_Life_Cycle]]  
 
* [[Fedora_Release_Life_Cycle]]  
 
* [[PackageMaintainers/Join]]
 
* [[PackageMaintainers/Join]]
 
* [[Infrastructure/VersionControl/dist-git]]
 
* [[Infrastructure/VersionControl/dist-git]]
 +
 +
[[Category:Package Maintainers]]

Latest revision as of 12:02, 21 February 2015

This page provides some basic instructions for day-to-day usage of the git-based package maintenance system for Fedora. It is intended primarily for new and current Fedora package maintainers, but does briefly cover anonymous read-only use of the system. It is not a guide to RPM packaging per se. Some pre-existing knowledge of git may be useful, but is not a pre-requisite (in fact, Fedora packaging can be a relatively painless introduction to it).

You may have been looking for, or also be interested in:

Contents

[edit] Installing fedpkg and doing initial setup

The fedpkg tool will usually be your primary interface to the packaging system. Install it with yum install fedpkg, or any equivalent command. If you have not already done so, you will also need to install Package-x-generic-16.pngfedora-packager and run fedora-packager-setup. If you have run fedora-packager-setup before, but wish to set up a new machine for package maintenance, copy the files ~/.fedora*.cert to the new system.

You also must have an ssh key configured in the Fedora Accounts System to be able to make changes to any package (including your own). fedpkg will expect the correct ssh key to be available in your keyring.

[edit] Common fedpkg commands

This section lists typical fedpkg commands in a normal workflow, with short descriptions. Longer explanations for each can be seen by clicking the 'Show' links. In this workflow, we will be operating on the Rawhide branch of the package.

  • Check out a package:
fedpkg co <source_package_name>
cd <source_package_name>
  • Update your checked-out copy from the Fedora server:
fedpkg pull
  • Retrieve the package sources:
fedpkg sources
  • Make your changes to the package
  • Run the 'prep' stage (extract source, apply patches etc) within the checkout directory:
fedpkg prep
  • Do a local build of the current state:
fedpkg local
  • Do a mock build of the current state:
fedpkg mockbuild
  • Generate a .src.rpm from the current state:
fedpkg srpm
  • Check changes you have made:
fedpkg diff
  • Run some checks (rpmlint) on your package:
fedpkg lint
  • Stage any small patches or new source files for commit:
git add (somefile)
  • Upload new source files to the lookaside cache:
fedpkg new-sources
Warning (medium size).png
Alert
This will replace the current list of source files, not add to it. See Details for more details on the lookaside cache system.
fedpkg upload
  • Switch to a different release branch:
fedpkg switch-branch <f21, el6, master>
  • Generate git changelog from package changelog:
fedpkg clog
  • Commit changes:
fedpkg commit (-F clog) (-p) (-c)
Note.png
Difference from git
This behaves by default like git commit -a - it stages all modified files, though it does not add unstaged files.
  • Push changes:
fedpkg push
  • Do an 'official' build of the latest pushed changes:
fedpkg build
Important.png
Going into production
This is the first point at which you might possibly cause real mess for a real user, so use it with caution. If you are following the example and operating on Rawhide, your build would go live for Rawhide users some few hours after you ran this command.
Note.png
Uses pushed state
Unlike most of the above commands, this operates on the state you have pushed to git, not the local state. If you have issues make sure you have pushed and committed all patches and handled the sources correctly.
  • Submit a package update for the latest build:
fedpkg update

[edit] Typical fedpkg session

A typical session may look like this:

fedpkg clone foo
cd foo
fedpkg sources
fedpkg new-sources foo-0.0.2.tar.bz2
gedit foo.spec       # change the required things in the specfile.
                     # rpmdev-bumpspec is useful for simple version updates
fedpkg mockbuild     # check that the changes you made are correct
fedpkg diff
fedpkg lint
fedpkg commit -p -c  # commit and push in one go

[edit] Working with branches

Each Fedora release is represented by a branch in the git repository. You can switch between them like this:

fedpkg switch-branch f21
fedpkg switch-branch f20
fedpkg switch-branch master

The master branch is for Rawhide. You can maintain each branch entirely separately, if you like, laboriously copying changes between them (so long as you always stay within the Updates Policy requirements). However, git provides us with several handy tools for working with branches. Here's an example:

fedpkg clone bzrtools
# Make some changes in the master branch
fedpkg new-sources bzrtools-2.2.tar.gz
gedit bzrtools.spec
fedpkg commit
fedpkg switch-branch f21
git merge master
# for push into repo
fedpkg push

This will 'merge' the changes from the master (Rawhide) branch to the f21 branch. git aficionados may note this is a somewhat unusual workflow, but it is appropriate to the context of package management. Remember, after pushing to and building for a stable release or a Branched release after Bodhi has been enabled, you will have to submit an update before any other Fedora users will see your build.

Note that merges will only be sure to work cleanly so long as the branches have not previously diverged. That is, if you do this:

fedpkg clone bzrtools
# Make some changes in the master branch
fedpkg commit
fedpkg switch-branch f21
# Make some changes in the f21 branch
fedpkg commit
fedpkg switch-branch master
# Make some more changes in the master branch
fedpkg commit
fedpkg switch-branch f21
git merge master

you may encounter a merge conflict.

Remember that git is a collaborative system, and used as such in Fedora package management. It is often the case that you must consider changes made by others in working on a package, and consider how your changes will affect others.

[edit] Resolving merge conflicts

This is a large topic and somewhat beyond the scope of this guide, but we can give basic pointers. There are other good references in the git book and at github.

When you git merge and a conflict occurs you can edit the files that have conflicts. Remove the conflict markers in the files and merge the changes manually. Use git diff or fedpkg diff to inspect the changes against the pre-conflict state and verify you are happy with the resolution. Then you can commit the files with fedpkg commit or git commit -a. git will know if you have resolved the conflict by checking that all the conflict markers have been removed.

[edit] Using git mergetool to resolve conflicts

Git provides a graphical diff program to help resolve conflicts. This can be handy for visualizing what changes have occurred and dealing with them as a set.

git config --global merge.tool meld
fedpkg switch-branch f21
git merge master
# Conflicts occurred
git mergetool            # Opens up a meld showing a three way diff of 
                         # the merge, working tree, and the last commit
# Resolved all the conflicts in the GUI
git add CONFLICTEDFILES
git commit

[edit] Requesting special dist tags

When a change to a package affects a large number of dependencies (e.g. all perl, python, ruby or ghc packages), requiring them to be rebuilt, it may be better to initially do the builds in a special repository, 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.

[edit] Tips and tricks

[edit] Using fedpkg anonymously

You can use fedpkg like this:

fedpkg clone --anonymous <somepackage>

to check out a package without requiring identification. Obviously, you will not be able to push any changes to this repository, but it is useful for non-packagers who simply want to examine a package and perhaps submit changes to a Fedora developer.

[edit] Local branch names

If you use git commands to branch and checkout directly, you can define whatever local branch names you want. If you use fedpkg switch-branch, it will default to creating the names used in the examples above.

[edit] Current branch and state in shell prompt

It is often helpful to know what branch you are working on at a glance. You can add this information to your bash prompt with the information here.

[edit] Importing a .src.rpm to update

The fedpkg import command usually used to initially populate a git package repository from a .src.rpm that has been through the Package Review Process can also be used to update a normal working copy, if you have an old-school packaging process to which you are particularly attached. Just run fedpkg import file.src.rpm and it will upload new tarballs into lookaside cache, update a working copy of the last version found in git, and commit all changes. fedpkg import --help documents some other parameters it can accept.

Warning (medium size).png
Caution!
This approach makes it harder to verify that your changes are safe and do not overwrite changes made to the package by others. For this reason, its use is not recommended.

[edit] Making changes on an older branch without breaking the upgrade path

Here is the scenario: you've built your package successfully on the 21 branch, but there is a problem keeping your package from building on last.

Solution: make your changes in the branch and then add a digit to the very right of the release tag. There is no need to change the release in the other branches. This allows upgrades to work smoothly if the user upgrades to a newer release of Fedora.

Name:    foo
Version: 1.0
Release: 1%{?dist}

Name:    foo
Version: 1.0
Release: 1%{?dist}.1

Then tag and build as usual. This approach was initially discussed in this mailing list thread.

[edit] Removing a package build pending for Rawhide or Branched

From time to time you may want to remove a package build you submitted to Rawhide or to Branched prior to the Alpha freeze (both cases where the build would usually go out to the main repository without further gating). 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, or you realize you made a significant mistake in the build that cannot easily be corrected.

Stop (medium size).png
Use this carefully!
This should only be done on the same day of the build, before it is included in a compose. If your build was already included in a compose you must not untag it! Check the Release Engineering Dashboard to get the starting time of the last compose.

You can remove the package by using Koji: koji untag-pkg f22 foo-1.1.3-1.fc22

where foo-1.1.3-1.fc22 is replaced with the name of your package build. See koji help or using Koji for more information.

[edit] ssh fingerprint

The recommended option is to include "VerifyHostKeyDNS yes" in your ~/.ssh/config file. This will result in using DNS to check that the key is correct.

But you can also manually check against the list of keys at https://admin.fedoraproject.org . The strings there are what ends up in your ~/.ssh/known_hosts file. So you can accept the fingerprint when prompted and then check that the correct string for pkgs.fedoraproject.org ended up in your ~/.ssh/known_hosts file.

[edit] Problems connecting to the repository

The fedpkg tool clones repositories using the ssh:// protocol, so this should not be a problem normally (as long as you have your ssh key). If you cloned using the git utility itself, check the .git/config file to ensure the remote repository is being accessed via an ssh:// protocol, and not git://.

[edit] Expired certificates (Error 255 or OpenSSL.SSL.Error)

This error usually means that your client certificate (~/.fedora.cert) has expired, so you need to run fedora-cert to get a new one. If you have trouble with this, you may try removing ~/.fedora*.cert and re-running fedora-packager-setup.

[edit] It builds here, why doesn't it build there?

Is your package building locally - even with Mock, even as a scratch build! - but not when you run fedpkg build? Before you get too frustrated, remember fedpkg build runs on the package as it exists in the upstream repository, not your local working copy. Make sure you have committed and pushed all changes and source files, and handled the lookaside cache correctly.

[edit] References