~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/ppa.txt

  • Committer: Vincent Ladeuil
  • Date: 2008-09-11 19:36:38 UTC
  • mfrom: (3703 +trunk)
  • mto: (3705.1.1 trunk2)
  • mto: This revision was merged to the branch mainline in revision 3708.
  • Revision ID: v.ladeuil+lp@free.fr-20080911193638-wtjyc1kcmacc6t1f
merge bzr.dev

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
11
 
release process.  These packages are hosted in a few `Personal Package
12
 
Archives (PPA)`__ on Launchpad.
 
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.
13
13
 
14
14
  __ https://help.launchpad.net/PPAQuickStart
15
15
 
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>
37
 
    Automatic nightly builds from trunk.
38
 
 
39
 
We build a distinct package for each distrorelease.
40
 
If you upload a release-specific version, you should add a suffix to the
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.
58
 
 
59
 
The packaging information is kept in branches of bzr on Launchpad, named
60
 
like
61
 
<https://code.launchpad.net/~bzr/ubuntu/hardy/bzr/bzr-ppa>.
62
 
or
63
 
<lp:~bzr/ubuntu/hardy/bzr/bzr-ppa>.  These branches are intended to be used
64
 
with the ``bzr-builddeb`` plugin.
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
 
------------------
 
16
As of June 2008, there are two 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.    
73
23
 
74
24
We build packages for every supported Ubuntu release
75
25
<https://wiki.ubuntu.com/Releases>.  Packages need no longer be updated
76
26
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.
 
27
have upgraded by then.  (As of May 2008, Edgy Eft is no longer supported.)
 
28
 
 
29
We build a distinct package for each distrorelease.  As of bzr 1.5, Dapper
 
30
uses ``python-support`` and later distributions use ``python-central``.
 
31
If you upload a release-specific version, you should add a suffix to the
 
32
package version, e.g. ``bzr.1.3-1~bazaar1~dapper1``.
 
33
 
 
34
Every package is first uploaded into the beta ppa.  For final release
 
35
versions it is also copied to the main PPA.
 
36
 
 
37
The ``debian/`` directory containing the packaging information is kept in
 
38
branches on Launchpad, named like 
 
39
<https://code.launchpad.net/~bzr/bzr/packaging-hardy>.
 
40
or
 
41
<lp:~bzr/bzr/packaging-hardy>.
90
42
 
91
43
Preconditions
92
44
-------------
93
 
 
94
 
* You must have a Launchpad account and be a member of the team
95
 
  that owns these PPAs (``~bzr``).
 
45
  
 
46
* You must have a Launchpad account and be a member of the teams 
 
47
  that own these PPAs (``~bzr``, ``~bzr-beta-ppa``).
96
48
 
97
49
* You must have a GPG key registered to your Launchpad account.
98
50
 
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::
 
51
* Configure ``dput`` to upload to our PPA with this section in your
 
52
  ``~/.dput.cf``::
 
53
 
 
54
    [bzr-beta-ppa]
 
55
    fqdn = ppa.launchpad.net
 
56
    method = ftp
 
57
    incoming = ~bzr-beta-ppa/ubuntu
 
58
    login = anonymous
 
59
    allow_unsigned_uploads = 0
 
60
 
 
61
    [bzr-ppa]
 
62
    fqdn = ppa.launchpad.net
 
63
    method = ftp
 
64
    incoming = ~bzr/ubuntu
 
65
    login = anonymous
 
66
    allow_unsigned_uploads = 0
 
67
 
 
68
  You may also want to add these lines to prevent inadvertently attempting
 
69
  to upload into Ubuntu or Debian, which will give a somewhat unclear
 
70
  error::
108
71
 
109
72
    [DEFAULT]
110
73
    default_host_main = notspecified
111
 
 
 
74
  
112
75
* You need a Ubuntu (or probably Debian) machine, and ::
113
76
 
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.
120
 
 
121
 
.. _`bzr-builddeb`: http://launchpad.net/bzr-builddeb
 
77
    sudo apt-get install build-essential devscripts dput quilt patch
 
78
 
 
79
* You will also want to have the ``bzr-builddeb`` plugin installed.
122
80
 
123
81
 
124
82
Packaging Bazaar
125
83
----------------
126
84
 
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
 
 
160
85
Short form
161
86
~~~~~~~~~~
162
87
 
164
89
release packages is as simple as::
165
90
 
166
91
  cd ~/dev/bzr/releases/packaging
167
 
  export VERSION="1.17~rc1-1~bazaar1"
168
 
  export PACKAGE="bzr"
169
 
  export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
 
92
  export UBUNTU_RELEASES="dapper feisty gutsy hardy intrepid"
170
93
  ~/dev/bzr/bzr.dev/tools/packaging/update-packaging-branches.sh
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.
 
94
  ~/dev/bzr/bzr.dev/tools/packaging/update-changelogs.sh 1.6~beta3-1~bazaar1
 
95
  ~/dev/bzr/bzr.dev/tools/packaging/build-packages
 
96
  dput bzr-beta-ppa build-area/bzr_1.6~beta3~bazaar1*.changes
178
97
 
179
98
Long Form
180
99
~~~~~~~~~
181
100
 
182
101
#. You will end up checking out a separate directory for each supported
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.
 
102
   release. Such as ``~/dev/bzr/releases/packaging/hardy``
188
103
 
189
104
#. Decide on the final version number.  It should be of this form::
190
105
 
191
 
     bzr-1.17~rc1-1~bazaar1~hardy1
 
106
     bzr-1.6~beta3-1~bazaar1~hardy1
192
107
 
193
 
   **Note:** There are three hyphen-separated parts: the *package name*,
194
 
   the *upstream version*, and the *packaging version*.
 
108
   There are three hyphen-separated parts: the *package name*, the *upstream
 
109
   version*, and the *packaging version*.
195
110
 
196
111
   **Caution:** Upstream betas or release candidates must insert a tilde
197
112
   to make them sort before the final release, like this:
198
 
   ``bzr-1.17~rc1-1~bazaar1~hardy1``.
 
113
   ``bzr-1.6~beta3-1~bazaar1~hardy1``.
199
114
 
200
115
   Final releases will use a release string of the form:
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"
 
116
   ``bzr-1.6-1~bazaar1~hardy1``
206
117
 
207
118
#. Export the distroreleases that you will be packaging for::
208
119
 
209
 
      export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
210
 
 
211
 
#. Export the program you are packaging::
212
 
 
213
 
      export PACKAGE="bzr"
 
120
      export UBUNTU_RELEASES="dapper feisty gutsy hardy intrepid"
214
121
 
215
122
#. Checkout (or update) the packaging branch for each supported release::
216
123
 
217
 
      bzr co lp:~bzr/ubuntu/hardy/bzr/bzr-ppa
 
124
      bzr co lp:~bzr/bzr/packaging-hardy
218
125
 
219
126
   There is a script available to help::
220
127
 
221
128
      tools/packaging/update-packaging-branches.sh
222
129
 
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
 
 
227
130
#. The ``bzr-builddeb`` step will download the original tarball if you do
228
 
   not already have it, putting it into a ``tarballs`` directory.
 
131
   not already have it. Putting it into a ``tarballs`` directory.
229
132
 
230
133
#. For Bazaar plugins, change the ``debian/control`` file to express a
231
134
   dependency on the correct version of ``bzr``.
232
135
 
233
136
   For bzrtools this is typically::
234
137
 
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
 
138
      Build-Depends-Indep: bzr (>= 1.6~), rsync
 
139
      Depends: ${python:Depends}, bzr (>= 1.6~), bzr (<< 1.7~), patch
247
140
 
248
141
#. Make a new ``debian/changelog`` entry for the new release,
249
142
   either by using ``dch`` or just editing the file::
250
143
 
251
 
      dch -v '1.17~rc1-1~bazaar1~hardy1' -D hardy
 
144
      dch -v '1.6~beta3-1~bazaar1~hardy1' -D hardy
252
145
 
253
146
   dch will default to the distro you're working in and this isn't checked
254
 
   against the version number (which is just our convention), so make sure
 
147
   against the version number (which is just our convention), so make sure 
255
148
   to specify it.
256
149
 
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
 
 
 
150
   Make sure you have the correct email address for yourself, version
 
151
   number, and distribution.  It should look something like this::
 
152
 
 
153
       bzr (1.6~beta3-1~bazaar1~hardy1) hardy; urgency=low
 
154
     
263
155
        * New upstream release.
264
 
 
 
156
     
265
157
       -- John Sample <sample@example.com>  Mon, 31 Mar 2008 12:36:27 +1100
266
158
 
267
159
   If you need to upload the package again to fix a problem, normally you
272
164
 
273
165
   You will also want to commit these changes into the packaging branch.
274
166
 
275
 
   There is a helper script which will build all the packages
 
167
   There is a helper script which will update the changelog and commit it
276
168
   for all of your ``$UBUNTU_RELEASES``. It is available as::
277
169
 
278
170
      tools/packaging/update-changelogs.sh
279
171
 
 
172
   You must supply the release string, such as::
 
173
 
 
174
      tools/packaging/update-changelogs.sh 1.6~beta3-1~bazaar1
 
175
 
 
176
   It will automatically append the distro numbering on the end.
 
177
 
280
178
#. Build the source packages::
281
179
 
282
 
      cd bzr-$DISTRO; bzr builddeb -S
283
 
 
284
 
   This will create a ``.changes`` file.  If you didn't configure builddeb
285
 
   to automatically sign them, you can use ::
286
 
 
287
 
      debsign -m$UID *.changes
288
 
 
289
 
   where ``$UID`` is the gpg key you want to use to sign the changes.
290
 
 
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
 
180
      cd packaging-$DISTRO; bzr builddeb -S
 
181
 
 
182
   This will create a ``.changes`` file in ``build-area``. You will need
 
183
   to sign it with::
 
184
 
 
185
      debsign -m$UID build-area/*.changes
 
186
 
 
187
   Where ``$UID`` is the gpg key you want to use to sign the changes.
 
188
   Alternatively, you can configure ``~/.bazaar/builddeb.conf`` with::
 
189
 
 
190
      [BUILDDEB]
 
191
      builder = dpkg-buildpackage -rfakeroot
 
192
      source-builder= dpkg-buildpackage -rfakeroot -S -sa
 
193
 
 
194
   Which tells ``bzr builddeb`` to automatically sign the package with the
 
195
   key associated with the user who created the changelog entry.
 
196
     
 
197
#. Upload into the beta PPA for each release::
 
198
 
 
199
     dput bzr-beta-ppa build-area/*.changes
 
200
 
 
201
#. For final release versions, also copy it into the ``~bzr`` PPA::
 
202
 
 
203
     dput bzr-ppa ../bzr__1.6-1\~bazaar1\~hardy1\_source.changes
 
204
 
 
205
   Alternatively, you can use Launchpad's "copy" feature to copy the
 
206
   packages between repositories.
299
207
 
300
208
#. You should soon get an "upload accepted" mail from Launchpad, which
301
209
   means that your package is waiting to be built.  You can then track its
302
 
   progress in <https://launchpad.net/~bzr/+archive/proposed> and
303
 
   <https://launchpad.net/~bzr/+archive/proposed/+builds>.
304
 
 
305
 
 
306
 
Packaging bzr-svn
307
 
~~~~~~~~~~~~~~~~~
308
 
 
309
 
bzr-svn uses a packaging branch that contains both the source
310
 
(including any changes against upstream) and the ``debian/`` directory.
311
 
 
312
 
To build bzr-svn:
313
 
 
314
 
#. Get a checkout of ``lp:~bzr/bzr-svn/hardy-ppa/``
315
 
 
316
 
#. Merge from ``http://bzr.debian.org/pkg-bazaar/bzr-svn/unstable/``
317
 
 
318
 
   This should bring in both upstream and packaging changes for the new
319
 
   release, and it's updated as part of the bzr-svn release process.
320
 
 
321
 
   It's quite possible you will need to resolve some conflicts.
322
 
 
323
 
#. Run ``dch -v 0.4.15-1~bazaar1-hardy1 -D hardy`` or similar
324
 
 
325
 
#. Run ``bzr builddeb --source``
326
 
 
327
 
   bzr-builddeb will automatically check out the appropriate tag from the
328
 
   main branch of bzr-svn, build, and package it.
329
 
 
330
 
#. ``dput ppa:bzr/proposed ../bzr-svn_0.4.15-1~bazaar1~hardy1_source.changes``
 
210
   progress in <https://launchpad.net/~bzr-beta-ppa/+archive> and
 
211
   <https://launchpad.net/~bzr-beta-ppa/+archive/+builds>.
331
212
 
332
213
 
333
214
Monitoring the contents of PPAs
337
218
summary of current package versions with::
338
219
 
339
220
  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``
364
221
 
365
222
 
366
223
..