1
Managing the Bazaar PPA
2
=======================
4
See also: `Bazaar Developer Document Catalog <index.html>`_.
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.
14
__ https://help.launchpad.net/PPAQuickStart
16
As of January 2011, there are the following PPAs:
18
<https://launchpad.net/~bzr/+archive/ppa>
19
Final released versions and updates.
20
Most users who want updates to bzr should add this.
22
<https://launchpad.net/~bzr/+archive/proposed>
23
Proposed uploads to move into ~bzr/ppa, awaiting testing.
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.
29
<https://launchpad.net/~bzr/+archive/beta>
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.
36
<https://launchpad.net/~bzr/+archive/daily>
37
Automatic nightly builds from trunk.
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``.
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.
47
Beta releases of bzr and plugins are uploaded into the beta PPA.
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.
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.
59
The packaging information is kept in branches of bzr on Launchpad, named
61
<https://code.launchpad.net/~bzr/ubuntu/hardy/bzr/bzr-ppa>.
63
<lp:~bzr/ubuntu/hardy/bzr/bzr-ppa>. These branches are intended to be used
64
with the ``bzr-builddeb`` plugin.
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.
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.
79
As of August 2010, the following releases are supported:
84
* Jaunty (support ends October 2010)
86
* Dapper LTS (supported but no longer updated for new releases)
88
The ``rmadison bzr`` command will gives you an up-to-date summary
89
of which bzr releases are current in each Ubuntu release.
94
* You must have a Launchpad account and be a member of the team
95
that owns these PPAs (``~bzr``).
97
* You must have a GPG key registered to your Launchpad account.
99
On reasonably recent versions of Ubuntu you no longer need special dput
100
configuration, because you can just say ::
102
dput ppa:bzr/proposed source.changes
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::
110
default_host_main = notspecified
112
* You need a Ubuntu (or probably Debian) machine, and ::
114
sudo apt-get install build-essential devscripts dput quilt patch libcrypt-ssleay-perl debhelper cdbs python-docutils
116
Please update this document if you encounter unmet dependencies or find a
117
shorter way to express them.
119
* You will also want to have the `bzr-builddeb`_ plugin installed.
121
.. _`bzr-builddeb`: http://launchpad.net/bzr-builddeb
127
Overview of packaging with builddeb
128
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130
* First update the oldest supported branch, using ``bzr merge-upstream``.
132
* Run ``bzr builddeb -S -- -sa`` to build a source package, then put
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.)
141
* Now merge across that change into each supported branch with a
142
simple ``bzr merge``.
144
Locally testing using pbuilder
145
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
151
Update all packages in proposed before copying to the main ppa
152
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
163
For people who have already set up everything they need, building the
164
release packages is as simple as::
166
cd ~/dev/bzr/releases/packaging
167
export VERSION="1.17~rc1-1~bazaar1"
169
export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
170
~/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
177
Rinse and repeat for all the plugins by changing VERSION and PACKAGE.
182
#. 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.
186
The scripts will also create the branches and produce packages for
187
bzrtools and bzr-svn.
189
#. Decide on the final version number. It should be of this form::
191
bzr-1.17~rc1-1~bazaar1~hardy1
193
**Note:** There are three hyphen-separated parts: the *package name*,
194
the *upstream version*, and the *packaging version*.
196
**Caution:** Upstream betas or release candidates must insert a tilde
197
to make them sort before the final release, like this:
198
``bzr-1.17~rc1-1~bazaar1~hardy1``.
200
Final releases will use a release string of the form:
201
``bzr-1.17-1~bazaar1~hardy1``
203
Set this base of this up as a usable environment variable::
205
export VERSION="1.17~rc1-1~bazaar1"
207
#. Export the distroreleases that you will be packaging for::
209
export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
211
#. Export the program you are packaging::
215
#. Checkout (or update) the packaging branch for each supported release::
217
bzr co lp:~bzr/ubuntu/hardy/bzr/bzr-ppa
219
There is a script available to help::
221
tools/packaging/update-packaging-branches.sh
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/
227
#. The ``bzr-builddeb`` step will download the original tarball if you do
228
not already have it, putting it into a ``tarballs`` directory.
230
#. For Bazaar plugins, change the ``debian/control`` file to express a
231
dependency on the correct version of ``bzr``.
233
For bzrtools this is typically::
235
Build-Depends-Indep: bzr (>= 1.17~), rsync
236
Depends: ${python:Depends}, bzr (>= 1.17~), bzr (<< 1.18~), patch
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::
241
tools/packaging/update-control.sh
243
You must supply the versions as arguments as follows
244
OLD_VERSION CURRENT_VERSION NEXT_VERSION, such as::
246
tools/packaging/update-control.sh 1.16 1.17 1.18
248
#. Make a new ``debian/changelog`` entry for the new release,
249
either by using ``dch`` or just editing the file::
251
dch -v '1.17~rc1-1~bazaar1~hardy1' -D hardy
253
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
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::
261
bzr (1.17~rc1-1~bazaar1~hardy1) hardy; urgency=low
263
* New upstream release.
265
-- John Sample <sample@example.com> Mon, 31 Mar 2008 12:36:27 +1100
267
If you need to upload the package again to fix a problem, normally you
268
should increment the last number in the version number, following the
269
distro name. Make sure not to omit the initial ``-1``, and make sure
270
that the distro name in the version is consistent with the target name
271
outside the parenthesis.
273
You will also want to commit these changes into the packaging branch.
275
There is a helper script which will build all the packages
276
for all of your ``$UBUNTU_RELEASES``. It is available as::
278
tools/packaging/update-changelogs.sh
280
#. Build the source packages::
282
cd bzr-$DISTRO; bzr builddeb -S
284
This will create a ``.changes`` file. If you didn't configure builddeb
285
to automatically sign them, you can use ::
287
debsign -m$UID *.changes
289
where ``$UID`` is the gpg key you want to use to sign the changes.
291
There is a helper script which will build the package
292
for all of your ``$UBUNTU_RELEASES``. It is available as::
294
tools/packaging/build-packages.sh
296
#. Upload into the PPA for each release::
298
dput dput ppa:bzr/proposed bzr*1.17-1*.changes
300
#. You should soon get an "upload accepted" mail from Launchpad, which
301
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>.
309
bzr-svn uses a packaging branch that contains both the source
310
(including any changes against upstream) and the ``debian/`` directory.
314
#. Get a checkout of ``lp:~bzr/bzr-svn/hardy-ppa/``
316
#. Merge from ``http://bzr.debian.org/pkg-bazaar/bzr-svn/unstable/``
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.
321
It's quite possible you will need to resolve some conflicts.
323
#. Run ``dch -v 0.4.15-1~bazaar1-hardy1 -D hardy`` or similar
325
#. Run ``bzr builddeb --source``
327
bzr-builddeb will automatically check out the appropriate tag from the
328
main branch of bzr-svn, build, and package it.
330
#. ``dput ppa:bzr/proposed ../bzr-svn_0.4.15-1~bazaar1~hardy1_source.changes``
333
Monitoring the contents of PPAs
334
-------------------------------
336
If you add all the bzr PPAs to your ``sources.list`` then you can see a
337
summary of current package versions with::
339
apt-cache madison bzr
342
Testing the contents of the PPA
343
-------------------------------
345
A somewhat crude but useful way to test the contents of the PPA is to
346
install the relevant packages into an schroot::
348
schroot -c hardy-test -u root -- \
349
apt-get install -o 'APT::Install-Suggests="true"' \
350
-o 'APT::Install-Recommends="true"' \
353
This should make sure everything can be installed; it won't guarantee that
356
Packaging dependencies
357
----------------------
359
Some of our updates to bzr in previous releases require backports of our
360
dependencies. Specific branches holding these backports:
362
* ``lp:~bzr/ubuntu/dapper/configobj/dapper-backport``
363
* ``lp:~bzr/ubuntu/hardy/python-central-debhelper-sequence-addon/bzr-ppa``
367
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/ppa.txt
