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 September 2010, there are four 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, awaiting testing.
25
<https://launchpad.net/~bzr-beta-ppa/+archive>
28
<https://launchpad.net/~bzr-nightly-ppa/+archive>
29
Automatic nightly builds from trunk.
31
We build a distinct package for each distrorelease.
32
If you upload a release-specific version, you should add a suffix to the
33
package version, e.g. ``bzr.1.3-1~bazaar1~dapper1``.
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.
39
Every package is first uploaded into the beta ppa. For final release
40
versions it is also copied to the main PPA.
42
The packaging information is kept in branches of bzr on Launchpad, named
44
<https://code.launchpad.net/~bzr/ubuntu/hardy/bzr/bzr-ppa>.
46
<lp:~bzr/ubuntu/hardy/bzr/bzr-ppa>. These branches are intended to be used
47
with the ``bzr-builddeb`` plugin.
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.
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.
62
As of August 2010, the following releases are supported:
67
* Jaunty (support ends October 2010)
69
* Dapper LTS (supported but no longer updated for new releases)
71
The ``rmadison bzr`` command will gives you an up-to-date summary
72
of which bzr releases are current in each Ubuntu release.
77
* You must have a Launchpad account and be a member of the teams
78
that own these PPAs (``~bzr``, ``~bzr-beta-ppa``).
80
* You must have a GPG key registered to your Launchpad account.
82
On reasonably recent versions of Ubuntu you no longer need special dput
83
configuration, because you can just say ::
85
dput ppa:bzr/proposed <source.changes
88
However, you may still want to add these lines to ``~/.dput.cf`` prevent
89
inadvertently attempting to upload into Ubuntu or Debian, which will
90
give a somewhat unclear error::
93
default_host_main = notspecified
95
* Configure ``bzr-builddeb`` to sign the package, which is required for
96
Launchpad to build it. Put this in ``~/.bazaar/builddeb.conf`` ::
99
builder = dpkg-buildpackage -rfakeroot
100
source-builder= dpkg-buildpackage -rfakeroot -S -sa
102
* You need a Ubuntu (or probably Debian) machine, and ::
104
sudo apt-get install build-essential devscripts dput quilt patch libcrypt-ssleay-perl debhelper cdbs python-docutils
106
Please update this document if you encounter unmet dependencies or find a
107
shorter way to express them.
109
* You will also want to have the `bzr-builddeb`_ plugin installed, which
110
depends on `bzrtools`_.
112
.. _`bzr-builddeb`: http://launchpad.net/bzr-builddeb
113
.. _`bzrtools`: http://launchpad.net/bzrtools
119
Overview of packaging with builddeb
120
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122
* First update the oldest supported branch, using ``bzr merge-upstream``.
124
* Run ``bzr builddeb -S -- -sa`` to build a source package, then put
127
(``-S`` says to make a source-only upload, which is
128
required for Launchpad's builders. ``--sa`` says to include the
129
``.orig.tgz`` even if this doesn't seem to be the first upload for an
130
upstream release: this is often needed when rebuilding something that's
131
previously been uploaded to Debian or Ubuntu or into a different PPA.)
133
* Now merge across that change into each supported branch with a
134
simple ``bzr merge``.
136
Locally testing using pbuilder
137
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139
It may be useful to locally test builds inside pbuilder. You may want to
140
use the script from <http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=255165>
141
to wrap it, and to give it sensible defaults for your local machine.
143
Update all packages in proposed before copping the main ppa
144
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
146
If one updates bzr, and there are plugins that are not compatible with the
147
new version of bzr, this can cause pain for users using the ppa. In order to
148
avoid this, we first get all packages up to date in the proposed ppa, and then
149
copy them to the main ppa.
155
For people who have already set up everything they need, building the
156
release packages is as simple as::
158
cd ~/dev/bzr/releases/packaging
159
export VERSION="1.17~rc1-1~bazaar1"
161
export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
162
~/dev/bzr/bzr.dev/tools/packaging/update-packaging-branches.sh
163
* Optionaly merge debian unstable.
164
~/dev/bzr/bzr.dev/tools/packaging/update-changelogs.sh
165
~/dev/bzr/bzr.dev/tools/packaging/update-control.sh 1.16 1.17 1.18
166
~/dev/bzr/bzr.dev/tools/packaging/build-packages.sh
167
dput ppa:bzr/proposed ${PACKAGE}_$VERSION*.changes
169
Rinse and repeat for all the plugins by changing VERSION and PACKAGE.
174
#. You will end up checking out a separate directory for each supported
175
release. Such as ``~/dev/bzr/releases/packaging/hardy``. In each of these
176
branches, you will produce the package for the release.
178
The scripts will also create the branches and produce packages for
179
bzrtools and bzr-svn.
181
#. Decide on the final version number. It should be of this form::
183
bzr-1.17~rc1-1~bazaar1~hardy1
185
**Note:** There are three hyphen-separated parts: the *package name*,
186
the *upstream version*, and the *packaging version*.
188
**Caution:** Upstream betas or release candidates must insert a tilde
189
to make them sort before the final release, like this:
190
``bzr-1.17~rc1-1~bazaar1~hardy1``.
192
Final releases will use a release string of the form:
193
``bzr-1.17-1~bazaar1~hardy1``
195
Set this base of this up as a usable environment variable::
197
export VERSION="1.17~rc1-1~bazaar1"
199
#. Export the distroreleases that you will be packaging for::
201
export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
203
#. Export the program you are packaging::
207
#. Checkout (or update) the packaging branch for each supported release::
209
bzr co lp:~bzr/ubuntu/hardy/bzr/bzr-ppa
211
There is a script available to help::
213
tools/packaging/update-packaging-branches.sh
215
#. Optionaly, merge the Debian unstable branch into each of the packaging
216
branches. You can find the Debian unstable branch here:
217
http://bzr.debian.org/pkg-bazaar/
219
#. The ``bzr-builddeb`` step will download the original tarball if you do
220
not already have it, putting it into a ``tarballs`` directory.
222
#. For Bazaar plugins, change the ``debian/control`` file to express a
223
dependency on the correct version of ``bzr``.
225
For bzrtools this is typically::
227
Build-Depends-Indep: bzr (>= 1.17~), rsync
228
Depends: ${python:Depends}, bzr (>= 1.17~), bzr (<< 1.18~), patch
230
There is a helper script which will update the control file and commit it
231
for all of your ``$UBUNTU_RELEASES``. It is available as::
233
tools/packaging/update-control.sh
235
You must supply the versions as arguments as follows
236
OLD_VERSION CURRENT_VERSION NEXT_VERSION, such as::
238
tools/packaging/update-control.sh 1.16 1.17 1.18
240
#. Make a new ``debian/changelog`` entry for the new release,
241
either by using ``dch`` or just editing the file::
243
dch -v '1.17~rc1-1~bazaar1~hardy1' -D hardy
245
dch will default to the distro you're working in and this isn't checked
246
against the version number (which is just our convention), so make sure
249
Make sure you have the correct email address for yourself (you may need
250
export DEBEMAIL=`bzr whoami` if it isn't already set), version number, and
251
distribution. It should look something like this::
253
bzr (1.17~rc1-1~bazaar1~hardy1) hardy; urgency=low
255
* New upstream release.
257
-- John Sample <sample@example.com> Mon, 31 Mar 2008 12:36:27 +1100
259
If you need to upload the package again to fix a problem, normally you
260
should increment the last number in the version number, following the
261
distro name. Make sure not to omit the initial ``-1``, and make sure
262
that the distro name in the version is consistent with the target name
263
outside the parenthesis.
265
You will also want to commit these changes into the packaging branch.
267
There is a helper script which will build all the packages
268
for all of your ``$UBUNTU_RELEASES``. It is available as::
270
tools/packaging/update-changelogs.sh
272
#. Build the source packages::
274
cd bzr-$DISTRO; bzr builddeb -S
276
This will create a ``.changes`` file. If you didn't configure builddeb
277
to automatically sign them, you can use ::
279
debsign -m$UID *.changes
281
where ``$UID`` is the gpg key you want to use to sign the changes.
283
There is a helper script which will build the package
284
for all of your ``$UBUNTU_RELEASES``. It is available as::
286
tools/packaging/build-packages.sh
288
#. Upload into the PPA for each release::
290
dput dput ppa:bzr/proposed bzr*1.17-1*.changes
292
#. You should soon get an "upload accepted" mail from Launchpad, which
293
means that your package is waiting to be built. You can then track its
294
progress in <https://launchpad.net/~bzr-beta-ppa/+archive> and
295
<https://launchpad.net/~bzr-beta-ppa/+archive/+builds>.
301
bzr-svn uses a packaging branch that contains both the source
302
(including any changes against upstream) and the ``debian/`` directory.
306
#. Get a checkout of ``lp:~bzr/bzr-svn/hardy-ppa/``
308
#. Merge from ``http://bzr.debian.org/pkg-bazaar/bzr-svn/unstable/``
310
This should bring in both upstream and packaging changes for the new
311
release, and it's updated as part of the bzr-svn release process.
313
It's quite possible you will need to resolve some conflicts.
315
#. Run ``dch -v 0.4.15-1~bazaar1-hardy1 -D hardy`` or similar
317
#. Run ``bzr builddeb --source``
319
bzr-builddeb will automatically check out the appropriate tag from the
320
main branch of bzr-svn, build, and package it.
322
#. ``dput bzr-beta-ppa ../bzr-svn_0.4.15-1~bazaar1~hardy1_source.changes``
325
Monitoring the contents of PPAs
326
-------------------------------
328
If you add all the bzr PPAs to your ``sources.list`` then you can see a
329
summary of current package versions with::
331
apt-cache madison bzr
334
Testing the contents of the PPA
335
-------------------------------
337
A somewhat crude but useful way to test the contents of the PPA is to
338
install the relevant packages into an schroot::
340
schroot -c hardy-test -u root -- \
341
apt-get install -o 'APT::Install-Suggests="true"' \
342
-o 'APT::Install-Recommends="true"' \
345
This should make sure everything can be installed; it won't guarantee that
348
Packaging dependencies
349
----------------------
351
Some of our updates to bzr in previous releases require backports of our
352
dependencies. Specific branches holding these backports:
354
* ``lp:~bzr/ubuntu/dapper/configobj/dapper-backport``
358
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/ppa.txt
