~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/ppa.txt

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
7
7
Background
8
8
----------
9
9
 
10
 
We build Ubuntu ``.deb`` packages for Bazaar as an important part of the release
11
 
process.  These packages are hosted in a few `Personal Package Archives (PPA)`__ on
12
 
Launchpad.
 
10
We build Ubuntu ``.deb`` packages for Bazaar as an important part of the
 
11
release process.  These packages are hosted in a few `Personal Package
 
12
Archives (PPA)`__ on Launchpad.
13
13
 
14
14
  __ https://help.launchpad.net/PPAQuickStart
15
15
 
16
 
As of June 2008, there are three PPAs:
17
 
 
18
 
<https://launchpad.net/~bzr/+archive>
19
 
    Final released versions.
20
 
 
21
 
<https://launchpad.net/~bzr-beta-ppa/+archive>
22
 
    Releases and release candidates.    
23
 
 
24
 
<https://launchpad.net/~bzr-nightly-ppa/+archive>
 
16
As of January 2011, there are the following PPAs:
 
17
 
 
18
<https://launchpad.net/~bzr/+archive/ppa>
 
19
    Final released versions and updates.
 
20
    Most users who want updates to bzr should add this.
 
21
 
 
22
<https://launchpad.net/~bzr/+archive/proposed>
 
23
    Proposed uploads to move into ~bzr/ppa, awaiting testing.
 
24
 
 
25
<https://launchpad.net/~bzr/+archive/obsolete>
 
26
    A preserved copy of the final version of packages from ~bzr/ppa for
 
27
    obsolete Ubuntu series.
 
28
 
 
29
<https://launchpad.net/~bzr/+archive/beta>
 
30
    Beta releases.
 
31
 
 
32
<https://launchpad.net/~bzr/+archive/beta-obsolete>
 
33
    A preserved copy of the final version of packages from
 
34
    ~bzr/beta for obsolete Ubuntu series.
 
35
 
 
36
<https://launchpad.net/~bzr/+archive/daily>
25
37
    Automatic nightly builds from trunk.
26
38
 
27
 
We build packages for every supported Ubuntu release
28
 
<https://wiki.ubuntu.com/Releases>.  Packages need no longer be updated
29
 
when the release passes end-of-life because all users should
30
 
have upgraded by then.  (As of May 2008, Edgy Eft is no longer supported.)
31
 
 
32
 
We build a distinct package for each distrorelease.  As of bzr 1.5, Dapper
33
 
uses ``python-support`` and later distributions use ``python-central``.
 
39
We build a distinct package for each distrorelease.
34
40
If you upload a release-specific version, you should add a suffix to the
35
 
package version, e.g. ``bzr.1.3-1~bazaar1~dapper1``.
36
 
 
37
 
Every package is first uploaded into the beta ppa.  For final release
38
 
versions it is also copied to the main PPA.
 
41
package version, e.g. ``1.3-1~bazaar1~dapper1``.
 
42
 
 
43
Dapper uses the ``python-support`` framework and later distributions use
 
44
``python-central``.  This has little effect on everyday packaging but does
 
45
mean that some of the control files are quite different.
 
46
 
 
47
Beta releases of bzr and plugins are uploaded into the beta PPA.
 
48
 
 
49
Final release versions are first uploaded into the proposed PPA, which
 
50
serves as a staging area to allow for new packages to be tested, and also
 
51
so that a complete set of Bazaar core and plugin updated versions can be
 
52
prepared together, when negotiating an API version transition.
 
53
 
 
54
Once ready, packages can be copied from the proposed PPA to the main PPA
 
55
using the lp-promote-ppa script found within the hydrazine project.  This
 
56
procedure reduces the risk of broken packages or dependencies between
 
57
packages in the main PPA from which many people get bzr updates.
39
58
 
40
59
The packaging information is kept in branches of bzr on Launchpad, named
41
 
like 
42
 
<https://code.launchpad.net/~bzr/bzr/packaging-hardy>.
 
60
like
 
61
<https://code.launchpad.net/~bzr/ubuntu/hardy/bzr/bzr-ppa>.
43
62
or
44
 
<lp:~bzr/bzr/packaging-hardy>.  These branches are intended to be used
 
63
<lp:~bzr/ubuntu/hardy/bzr/bzr-ppa>.  These branches are intended to be used
45
64
with the ``bzr-builddeb`` plugin.
46
65
 
 
66
The page <http://wiki.bazaar.canonical.com/PpaPackagingBranches> is a
 
67
reference to where the PPA packaging branches for each of the source
 
68
packages in the ``~bzr`` PPAs may be found.
 
69
 
 
70
 
 
71
Supported releases
 
72
------------------
 
73
 
 
74
We build packages for every supported Ubuntu release
 
75
<https://wiki.ubuntu.com/Releases>.  Packages need no longer be updated
 
76
when the release passes end-of-life because all users should
 
77
have upgraded by then.  
 
78
 
 
79
As of August 2010, the following releases are supported:
 
80
 
 
81
* Maverick 
 
82
* Lucid LTS
 
83
* Karmic
 
84
* Jaunty (support ends October 2010)
 
85
* Hardy LTS
 
86
* Dapper LTS (supported but no longer updated for new releases)
 
87
 
 
88
The ``rmadison bzr`` command will gives you an up-to-date summary
 
89
of which bzr releases are current in each Ubuntu release.
 
90
 
47
91
Preconditions
48
92
-------------
49
 
  
50
 
* You must have a Launchpad account and be a member of the teams 
51
 
  that own these PPAs (``~bzr``, ``~bzr-beta-ppa``).
 
93
 
 
94
* You must have a Launchpad account and be a member of the team
 
95
  that owns these PPAs (``~bzr``).
52
96
 
53
97
* You must have a GPG key registered to your Launchpad account.
54
98
 
55
 
* Configure ``dput`` to upload to our PPA with this section in your
56
 
  ``~/.dput.cf``::
57
 
 
58
 
    [bzr-beta-ppa]
59
 
    fqdn = ppa.launchpad.net
60
 
    method = ftp
61
 
    incoming = ~bzr-beta-ppa/ubuntu
62
 
    login = anonymous
63
 
    allow_unsigned_uploads = 0
64
 
 
65
 
    [bzr-ppa]
66
 
    fqdn = ppa.launchpad.net
67
 
    method = ftp
68
 
    incoming = ~bzr/ubuntu
69
 
    login = anonymous
70
 
    allow_unsigned_uploads = 0
71
 
 
72
 
  You may also want to add these lines to prevent inadvertently attempting
73
 
  to upload into Ubuntu or Debian, which will give a somewhat unclear
74
 
  error::
 
99
On reasonably recent versions of Ubuntu you no longer need special dput
 
100
configuration, because you can just say ::
 
101
 
 
102
  dput ppa:bzr/proposed source.changes
 
103
  
 
104
 
 
105
However, you may still want to add these lines to ``~/.dput.cf`` prevent 
 
106
inadvertently attempting to upload into Ubuntu or Debian, which will
 
107
give a somewhat unclear error::
75
108
 
76
109
    [DEFAULT]
77
110
    default_host_main = notspecified
78
 
  
79
 
* Configure ``bzr-builddeb`` to sign the package, which is required for
80
 
  Launchpad to build it.  Put this in ``~/.bazaar/builddeb.conf`` ::
81
 
 
82
 
      [BUILDDEB]
83
 
      builder = dpkg-buildpackage -rfakeroot
84
 
      source-builder= dpkg-buildpackage -rfakeroot -S -sa
85
111
 
86
112
* You need a Ubuntu (or probably Debian) machine, and ::
87
113
 
88
 
    sudo apt-get install build-essential devscripts dput quilt patch
89
 
 
90
 
* You will also want to have the `bzr-builddeb`_ plugin installed, which
91
 
  depends on `bzrtools`_.
 
114
    sudo apt-get install build-essential devscripts dput quilt patch libcrypt-ssleay-perl debhelper cdbs python-docutils
 
115
 
 
116
  Please update this document if you encounter unmet dependencies or find a
 
117
  shorter way to express them.
 
118
 
 
119
* You will also want to have the `bzr-builddeb`_ plugin installed.
92
120
 
93
121
.. _`bzr-builddeb`: http://launchpad.net/bzr-builddeb
94
 
.. _`bzrtools`: http://launchpad.net/bzrtools
95
122
 
96
123
 
97
124
Packaging Bazaar
98
125
----------------
99
126
 
 
127
Overview of packaging with builddeb
 
128
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
129
 
 
130
* First update the oldest supported branch, using ``bzr merge-upstream``.
 
131
 
 
132
* Run ``bzr builddeb -S -- -sa`` to build a source package, then put 
 
133
  that into the ppa.  
 
134
  
 
135
  (``-S`` says to make a source-only upload, which is
 
136
  required for Launchpad's builders.  ``-sa`` says to include the
 
137
  ``.orig.tgz`` even if this doesn't seem to be the first upload for an
 
138
  upstream release: this is often needed when rebuilding something that's
 
139
  previously been uploaded to Debian or Ubuntu or into a different PPA.)
 
140
 
 
141
* Now merge across that change into each supported branch with a 
 
142
  simple ``bzr merge``.
 
143
  
 
144
Locally testing using pbuilder
 
145
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
146
 
 
147
It may be useful to locally test builds inside pbuilder.  You may want to 
 
148
use the script from <http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=255165> 
 
149
to wrap it, and to give it sensible defaults for your local machine.
 
150
 
 
151
Update all packages in proposed before copying to the main ppa
 
152
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
153
 
 
154
If one updates bzr, and there are plugins that are not compatible with the
 
155
new version of bzr, this can cause pain for users using the ppa. In order to
 
156
avoid this, we first get all packages up to date in the proposed ppa, and then
 
157
copy them to the main ppa.
 
158
 
 
159
 
100
160
Short form
101
161
~~~~~~~~~~
102
162
 
104
164
release packages is as simple as::
105
165
 
106
166
  cd ~/dev/bzr/releases/packaging
107
 
  ln ~/dev/bzr/releases/bzr-1.6.tar.gz ./bzr_1.6.orig.tar.gz
108
 
  export UBUNTU_RELEASES="dapper feisty gutsy hardy intrepid"
 
167
  export VERSION="1.17~rc1-1~bazaar1"
 
168
  export PACKAGE="bzr"
 
169
  export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
109
170
  ~/dev/bzr/bzr.dev/tools/packaging/update-packaging-branches.sh
110
 
  ~/dev/bzr/bzr.dev/tools/packaging/update-changelogs.sh 1.6~beta3-1~bazaar1
111
 
  ~/dev/bzr/bzr.dev/tools/packaging/build-packages
112
 
  dput bzr-beta-ppa bzr_1.6~beta3-1~bazaar1*.changes
 
171
  * Optionaly merge debian unstable. 
 
172
  ~/dev/bzr/bzr.dev/tools/packaging/update-changelogs.sh
 
173
  ~/dev/bzr/bzr.dev/tools/packaging/update-control.sh 1.16 1.17 1.18
 
174
  ~/dev/bzr/bzr.dev/tools/packaging/build-packages.sh
 
175
  dput ppa:bzr/proposed ${PACKAGE}_$VERSION*.changes
 
176
 
 
177
Rinse and repeat for all the plugins by changing VERSION and PACKAGE.
113
178
 
114
179
Long Form
115
180
~~~~~~~~~
116
181
 
117
182
#. You will end up checking out a separate directory for each supported
118
 
   release. Such as ``~/dev/bzr/releases/packaging/hardy``
 
183
   release. Such as ``~/dev/bzr/releases/packaging/hardy``. In each of these
 
184
   branches, you will produce the package for the release.
 
185
 
 
186
   The scripts will also create the branches and produce packages for
 
187
   bzrtools and bzr-svn.
119
188
 
120
189
#. Decide on the final version number.  It should be of this form::
121
190
 
122
 
     bzr-1.6~beta3-1~bazaar1~hardy1
 
191
     bzr-1.17~rc1-1~bazaar1~hardy1
123
192
 
124
193
   **Note:** There are three hyphen-separated parts: the *package name*,
125
194
   the *upstream version*, and the *packaging version*.
126
195
 
127
196
   **Caution:** Upstream betas or release candidates must insert a tilde
128
197
   to make them sort before the final release, like this:
129
 
   ``bzr-1.6~beta3-1~bazaar1~hardy1``.
 
198
   ``bzr-1.17~rc1-1~bazaar1~hardy1``.
130
199
 
131
200
   Final releases will use a release string of the form:
132
 
   ``bzr-1.6-1~bazaar1~hardy1``
 
201
   ``bzr-1.17-1~bazaar1~hardy1``
 
202
 
 
203
   Set this base of this up as a usable environment variable::
 
204
 
 
205
      export VERSION="1.17~rc1-1~bazaar1"
133
206
 
134
207
#. Export the distroreleases that you will be packaging for::
135
208
 
136
 
      export UBUNTU_RELEASES="dapper feisty gutsy hardy intrepid"
 
209
      export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
 
210
 
 
211
#. Export the program you are packaging::
 
212
 
 
213
      export PACKAGE="bzr"
137
214
 
138
215
#. Checkout (or update) the packaging branch for each supported release::
139
216
 
140
 
      bzr co lp:~bzr/bzr/packaging-hardy
 
217
      bzr co lp:~bzr/ubuntu/hardy/bzr/bzr-ppa
141
218
 
142
219
   There is a script available to help::
143
220
 
144
221
      tools/packaging/update-packaging-branches.sh
145
222
 
 
223
#. Optionaly, merge the Debian unstable branch into each of the packaging
 
224
   branches. You can find the Debian unstable branch here:
 
225
   http://bzr.debian.org/pkg-bazaar/
 
226
 
146
227
#. The ``bzr-builddeb`` step will download the original tarball if you do
147
228
   not already have it, putting it into a ``tarballs`` directory.
148
229
 
151
232
 
152
233
   For bzrtools this is typically::
153
234
 
154
 
      Build-Depends-Indep: bzr (>= 1.6~), rsync
155
 
      Depends: ${python:Depends}, bzr (>= 1.6~), bzr (<< 1.7~), patch
 
235
      Build-Depends-Indep: bzr (>= 1.17~), rsync
 
236
      Depends: ${python:Depends}, bzr (>= 1.17~), bzr (<< 1.18~), patch
 
237
 
 
238
   There is a helper script which will update the control file and commit it
 
239
   for all of your ``$UBUNTU_RELEASES``. It is available as::
 
240
 
 
241
    tools/packaging/update-control.sh
 
242
 
 
243
   You must supply the versions as arguments as follows
 
244
   OLD_VERSION CURRENT_VERSION NEXT_VERSION, such as::
 
245
 
 
246
    tools/packaging/update-control.sh 1.16 1.17 1.18
156
247
 
157
248
#. Make a new ``debian/changelog`` entry for the new release,
158
249
   either by using ``dch`` or just editing the file::
159
250
 
160
 
      dch -v '1.6~beta3-1~bazaar1~hardy1' -D hardy
 
251
      dch -v '1.17~rc1-1~bazaar1~hardy1' -D hardy
161
252
 
162
253
   dch will default to the distro you're working in and this isn't checked
163
 
   against the version number (which is just our convention), so make sure 
 
254
   against the version number (which is just our convention), so make sure
164
255
   to specify it.
165
256
 
166
 
   Make sure you have the correct email address for yourself, version
167
 
   number, and distribution.  It should look something like this::
168
 
 
169
 
       bzr (1.6~beta3-1~bazaar1~hardy1) hardy; urgency=low
170
 
     
 
257
   Make sure you have the correct email address for yourself (you may need
 
258
   export DEBEMAIL=`bzr whoami` if it isn't already set), version number, and
 
259
   distribution.  It should look something like this::
 
260
 
 
261
       bzr (1.17~rc1-1~bazaar1~hardy1) hardy; urgency=low
 
262
 
171
263
        * New upstream release.
172
 
     
 
264
 
173
265
       -- John Sample <sample@example.com>  Mon, 31 Mar 2008 12:36:27 +1100
174
266
 
175
267
   If you need to upload the package again to fix a problem, normally you
180
272
 
181
273
   You will also want to commit these changes into the packaging branch.
182
274
 
183
 
   There is a helper script which will update the changelog and commit it
 
275
   There is a helper script which will build all the packages
184
276
   for all of your ``$UBUNTU_RELEASES``. It is available as::
185
277
 
186
278
      tools/packaging/update-changelogs.sh
187
279
 
188
 
   You must supply the release string, such as::
189
 
 
190
 
      tools/packaging/update-changelogs.sh 1.6~beta3-1~bazaar1
191
 
 
192
 
   It will automatically append the distro numbering on the end.
193
 
 
194
280
#. Build the source packages::
195
281
 
196
 
      cd packaging-$DISTRO; bzr builddeb -S
 
282
      cd bzr-$DISTRO; bzr builddeb -S
197
283
 
198
284
   This will create a ``.changes`` file.  If you didn't configure builddeb
199
285
   to automatically sign them, you can use ::
202
288
 
203
289
   where ``$UID`` is the gpg key you want to use to sign the changes.
204
290
 
205
 
#. Upload into the beta PPA for each release::
206
 
 
207
 
     dput bzr-beta-ppa bzr_1.6-1*.changes
208
 
 
209
 
#. For final release versions, also copy it into the ``~bzr`` PPA::
210
 
 
211
 
     dput bzr-ppa ../bzr_1.6-1\~bazaar1\~hardy1\_source.changes
212
 
 
213
 
   Alternatively, you can use Launchpad's "copy" feature to copy the
214
 
   packages between repositories.
 
291
   There is a helper script which will build the package
 
292
   for all of your ``$UBUNTU_RELEASES``. It is available as::
 
293
 
 
294
      tools/packaging/build-packages.sh
 
295
 
 
296
#. Upload into the PPA for each release::
 
297
 
 
298
     dput dput ppa:bzr/proposed bzr*1.17-1*.changes
215
299
 
216
300
#. You should soon get an "upload accepted" mail from Launchpad, which
217
301
   means that your package is waiting to be built.  You can then track its
218
 
   progress in <https://launchpad.net/~bzr-beta-ppa/+archive> and
219
 
   <https://launchpad.net/~bzr-beta-ppa/+archive/+builds>.
 
302
   progress in <https://launchpad.net/~bzr/+archive/proposed> and
 
303
   <https://launchpad.net/~bzr/+archive/proposed/+builds>.
220
304
 
221
305
 
222
306
Packaging bzr-svn
223
307
~~~~~~~~~~~~~~~~~
224
308
 
225
 
bzr-svn uses a packaging branch that contains both the source 
 
309
bzr-svn uses a packaging branch that contains both the source
226
310
(including any changes against upstream) and the ``debian/`` directory.
227
311
 
228
312
To build bzr-svn:
229
313
 
230
314
#. Get a checkout of ``lp:~bzr/bzr-svn/hardy-ppa/``
231
315
 
232
 
#. Merge from ``http://bzr.debian.org/pkg-bazaar/bzr-svn/experimental/``
233
 
  
 
316
#. Merge from ``http://bzr.debian.org/pkg-bazaar/bzr-svn/unstable/``
 
317
 
234
318
   This should bring in both upstream and packaging changes for the new
235
319
   release, and it's updated as part of the bzr-svn release process.
236
320
 
 
321
   It's quite possible you will need to resolve some conflicts.
 
322
 
237
323
#. Run ``dch -v 0.4.15-1~bazaar1-hardy1 -D hardy`` or similar
238
324
 
239
325
#. Run ``bzr builddeb --source``
241
327
   bzr-builddeb will automatically check out the appropriate tag from the
242
328
   main branch of bzr-svn, build, and package it.
243
329
 
244
 
#. ``dput bzr-beta-ppa ../bzr-svn_0.4.15-1~bazaar1~hardy1_source.changes``
 
330
#. ``dput ppa:bzr/proposed ../bzr-svn_0.4.15-1~bazaar1~hardy1_source.changes``
245
331
 
246
332
 
247
333
Monitoring the contents of PPAs
251
337
summary of current package versions with::
252
338
 
253
339
  apt-cache madison bzr
 
340
  
 
341
  
 
342
Testing the contents of the PPA
 
343
-------------------------------
 
344
 
 
345
A somewhat crude but useful way to test the contents of the PPA is to
 
346
install the relevant packages into an schroot::
 
347
 
 
348
 schroot -c hardy-test -u root -- \
 
349
   apt-get install -o 'APT::Install-Suggests="true"' \
 
350
   -o 'APT::Install-Recommends="true"' \
 
351
   bzr
 
352
 
 
353
This should make sure everything can be installed; it won't guarantee that 
 
354
  
 
355
 
 
356
Packaging dependencies
 
357
----------------------
 
358
 
 
359
Some of our updates to bzr in previous releases require backports of our
 
360
dependencies.  Specific branches holding these backports:
 
361
 
 
362
 * ``lp:~bzr/ubuntu/dapper/configobj/dapper-backport``
 
363
 * ``lp:~bzr/ubuntu/hardy/python-central-debhelper-sequence-addon/bzr-ppa``
254
364
 
255
365
 
256
366
..