~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/ppa.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-05-30 15:01:10 UTC
  • mfrom: (4392.1.1 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090530150110-c87w11jf6sqevh16
(igc) fix locking in tags command

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