3 dgit-sponsorship - tutorial for Debian upload sponsorship, using git
5 =head1 INTRODUCTION AND SCOPE
7 This tutorial describes how a Debian sponsored contributor
9 a sponsoring DD (or DM)
10 can collaborate and publish using git.
12 The sponsor must to be intending to use dgit for the upload.
13 (If the sponsor does not use dgit,
14 it is not possible to properly publish
15 a sponsee's git branch.)
17 It is best if the sponsee also uses dgit;
18 but also covered (later on) is the case where
19 the sponsee provides a proposed upload in source package form,
20 but the sponsor would like to work in git.
22 This tutorial does not provide a checklist for the sponsor's review.
23 Both contributors are expected to be familiar with Debian
24 packaging and Debian's processes, and with git.
26 =head1 SPONSEE WORKFLOW
28 This section is addressed to the sponsee:
32 You should prepare the package as if you were going
33 to upload it with C<dgit push> yourself.
35 For a straightforward NMU, consult L<dgit-nmu-simple(7)>.
37 If you are the (prospective) maintainer,
38 you can adopt any suitable (dgit-compatible)
40 The L<dgit-maint-*(7)> tutorials describe some of the possibilities.
42 =head2 Upload preparation
44 You should go through all of the steps
45 a self-uploading maintainer would do,
46 including building for ad hoc tests,
47 and checking via a formal build (eg using C<dgit sbuild>)
48 that the package builds on sid (or the target release).
50 At the point where you would,
54 you hand off to your sponsor.
56 If you were going to use one of the
59 C<dgit --gbp> or C<dgit --dpm>,
60 you must specify that in your handoff email - see below.
62 =head1 GIT+ORIGS BASED HANDOFF
64 The elements of the handoff consists of:
74 Any .orig tarballs which will be needed.
78 A sample dgit push command, containing
79 any dgit --quilt=, --gbp or --dpm option needed
83 Plus of course all the usual information about the state
85 any caveats or areas you would like the sponsor to focus their review,
86 constraints about upload timing, etc.
90 If the handoff is done by email,
91 the elements above should be a in a single, signed, message.
92 This could be an RFS submission
93 against the sponsorship-requests pseudo-package.
97 The sponsee should push their HEAD as a git branch
98 to any suitable git server.
99 They can use their own git server;
100 alioth is another possibility.
102 The branch names used by the sponsee on their local machine,
103 and on the server, do not matter.
105 The sponsee should not make a C<debian/>I<version> tag.
107 Instead, the sponsee should include the
108 git commit id of their HEAD
109 in their handover email.
113 If there are any .origs that are not in the archive already,
114 the sponsor will need them as part of the upload.
116 The simplest approach is to
117 commit them with pristine-tar(1), e.g.
121 % pristine-tar commit ../foo_1.2.3.orig.tar.xz upstream/1.2.3
125 and be sure to push the pristine-tar branch.
126 If you are using git-buildpackage(1), just pass
127 I<--git-pristine-tar> and I<--git-pristine-tar-commit>.
130 the sponsee can put them on a suitable webserver,
131 or attach to the e-mail,
134 The sponsee should quote sha256sums of the .origs in their
139 Some workflows involve git branches which are not natively
141 Normally dgit will convert them as needed, during push.
143 Supply a sample "dgit push" command
145 C<--gbp> (aka C<--quilt=gbp>),
146 C<--dpm> (aka C<--quilt=dpm>),
147 or other C<--quilt=> option
159 =head1 SPONSOR WORKFLOW
161 This part is addressed to the sponsor:
163 =head2 Receiving and validating the sponsorship request
165 You should check the signature on the email.
167 Use C<git fetch> or C<git clone> to obtain the git branch
168 prepared by your sponsee,
169 and obtain any .origs mentioned by the sponsee
170 (to extract .origs committed with pristine-tar,
171 you can use origtargz(1).)
173 Check the git commit ID of the sponsee's branch tip,
174 and the sha256sums of the .origs,
175 against the handoff email.
177 Now you can check out the branch tip,
178 and do your substantive review.
180 =head2 Dealing with branches that want --quilt=
182 If your sponsee mentioned a C<--quilt>
183 option, and you don't want to grapple with their preferred tree format,
184 you can convert their tree into the standard dgit view:
188 % dgit -wgf quilt-fixup
189 [ Watch for a message about split brain, and if so: ]
190 % git checkout -b dgit-view-for-review refs/dgit-intern/quilt-cache
194 You should check that what you're looking at is a descendant of
195 the sponsee's branch.
197 =head2 Some hints which may help the review
199 C<dgit fetch sid> will get you an up-to-date
200 C<refs/remotes/dgit/dgit/sid>
201 showing what's in the archive already.
203 C<dgit -wgf --damp-run push>
204 will check that dgit can build an appropriate source package.
206 There is no need to run debdiff.
207 dgit will not upload anything that doesn't unpack
208 to exactly the git commit you are pushing,
209 so you can rely on what you see in C<git diff>.
211 =head2 Doing the upload
213 When you have completed your source review,
215 C<dgit -wgf [--quilt=...] sbuild -A -C>
216 or similar, to to the build, and then
217 C<dgit -wgf [--quilt=...] push>
220 (If you switched to the quilt-cache dgit view,
221 B<do not> pass the --quilt or --gbp or --dpm option again.)
223 If this was the first upload done with dgit,
229 =head1 SPONSORING A NON-GIT-USING SPONSEE
231 This part is addressed to the sponsor:
233 If your sponsee does not use git,
234 you can still do your review with git,
235 and use dgit for the upload.
237 Your sponsee will provide you with a source package:
238 that is, a .dsc and the files it refers to.
239 Obtain these files, and check signatures as appropriate.
246 % dgit import-dsc /path/to/sponsee's.dsc +sponsee
247 % git checkout sponsee
251 This will leave you looking at the sponsee's package,
252 formatted as a dgit branch.
254 When you have finished your review and your tests,
257 dgit push directly from the "sponsee" branch.
259 You will need to pass
261 to dgit push for every successive upload.
262 This disables a safety catch which would normally spot
263 situations where changes are accidentally lost.
264 When your sponsee is sending you source packages -
265 perhaps multiple source pacakges with the same version number -
266 these safety catches are inevitably ineffective.
270 dgit(1), dgit(7), dgit-nmu-simple(7), dgit-maint-*(7)