3 dgit - tutorial for package maintainers already using git-buildpackage(1)
7 This document explains how B<dgit> can be incorporated into a
8 git-buildpackage(1) package-maintenance workflow. This should be read
9 jointly with git-buildpackage(1)'s documentation. Some reasons why
10 you might want to incorporate B<dgit> into your existing workflow:
16 Benefit from dgit's safety catches. In particular, ensure that your
17 upload always matches exactly your git HEAD.
21 Provide a better, more detailed git history to downstream dgit users,
22 such as people using dgit to do an NMU (see dgit-nmu-simple(7) and
27 Incorporate NMUs with a single command (see below).
31 Note that we assume a patches-unapplied repository: the upstream
32 source committed to the git repository is unpatched.
33 git-buildpackage(1) can work with patched-applied repositories, but is
34 normally used with patches-unapplied.
36 =head1 GIT CONFIGURATION
42 % git config dgit.default.quilt-mode gbp
46 in your repository, you can omit I<--gbp> wherever it occurs below.
48 Note that this does require that you always work from your gbp master
49 branch, never the dgit patches-applied branch.
53 If you use gbp-buildpackage(1) to generate your orig tarballs, you
54 will need to perform the first build with gbp-buildpackage(1) directly
55 (this is due to Debian bug #841084).
57 Otherwise, you can perform builds like this:
61 % dgit [--allow-dirty] gbp-build [OPTIONS]
65 where I<--allow-dirty> is needed for testing uncommitted changes, and
66 I<OPTIONS> are any further options to be passed on to
69 When you are ready to build for upload, you will probably want to use
70 sbuild(1) or pbuilder(1), or do a source-only upload. Either
74 % dgit --rm-old-changes --gbp sbuild
82 % dgit --rm-old-changes gbp-build --git-pbuilder
90 % dgit --rm-old-changes --gbp build-source
94 We use I<--rm-old-changes> to ensure that there is exactly one changes
95 file corresponding to this package, so we can be confident we're
96 uploading what we intend (though B<dgit push> will do some safety
99 Note that all of the commands in this section are not required to
100 upload with dgit. You can invoke gbp-buildpackage(1), pbuilder(1) and
101 sbuild(1) directly. However, the defaults for these tools may leave
102 you with something that dgit will refuse to upload because it doesn't
103 match your git HEAD. As a general rule, leave all signing and tagging
108 Don't use I<--git-tag>: B<dgit push> will do this for you. To upload:
116 This will push your git history to the dgit-repos, but you probably
117 want to follow it up with a push to alioth.
119 You will need to pass I<--overwrite> if the previous upload was not
122 =head1 INCORPORATING NMUS
130 Alternatively, you can apply the NMU diff to your repository. The
131 next push will then require I<--overwrite>.
139 This tutorial was written and is maintained by Sean Whitton <spwhitton@spwhitton.name>.