Packaging using gbp

From LSDevLinux
Revision as of 16:55, 27 October 2015 by Mayhewn (talk | contribs) (Adding a new patch: Ensure releases are tagged, by including --git-tag in buildpackage options)

Jump to: navigation, search

Overview

gbp or git-buildpackage is a utility that supports maintaining a Debian/Ubuntu package in git. It takes care of a lot of the details and ensures consistency and correctness.

A gbp-compatible repository has two main branches:

  1. upstream
  2. master

The upstream branch is used to store the content of successive upstream ('orig') tarballs, and each upstream release is tagged.

The master branch is forked from upstream and adds the debian/ directory. It has tags for each package release.

When a new upstream version is integrated, the upstream branch is merged into master.

There's usually also a pristine-tar branch that's used in conjunction with upstream to recreate exact copies of the original upstream tarballs.

Adding a new patch

For a quilt-format package, differences from the upstream release are stored as a series of patches in debian/patches/. gbp can import these patches into a temporary branch called a patch-queue which is never pushed to the shared (remote) repository. The developer then makes new commit(s) on this branch, and uses gbp to export the branch back to debian/patches/. The updated debian/ directory is then committed to the master branch.

The exact steps are as follows:

git checkout master
Start from a known state
gbp pq import
Turn the patches into commits on a temporary branch and switch to it. You are now on patch-queue/master
HACK, COMMIT, HACK, COMMIT, HACK, COMMIT ...
Your commits will become new patches
git pq switch
Switch away from the patch-queue branch back to the main branch
git status
Check for extraneous files and uncommitted changes
git clean -dxf
Remove extraneous files
gbp pq export
Update debian/patches/
git status
Review the added/changed patches
git add debian
Stage everything under debian/
git commit -m "Add patch(es): ..."
List the patches in the commit message
gbp dch -R -c
Update the changelog and open it in an editor for final adjustment. You can usually just save and quit.
gbp buildpackage --git-pristine-tar --git-tag -nc -S
Build a source package

If the branch being used for packaging is not master but some other branch (eg sil) then above procedure needs to be modified slightly. As well as replacing all references to master with the actual branch name, the dch and buildpackage commands will need an extra parameter:

gbp dch -R -c --debian-branch=branchname
gbp buildpackage --git-pristine-tar --git-tag -nc -S --git-debian-branch=branchname

Note that the two commands use differently-named options!

When you've built and tested the package, please remember to push your changes (including tags) to origin.

Additional notes

  • It's also possible to pull from an upstream git repository directly, rather than using tarballs. See the gbp documentation for details.
  • gbp can run pbuilder builds directly, but we're not set up for that currently.