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)
75
* You must have a Launchpad account and be a member of the teams
76
that own these PPAs (``~bzr``, ``~bzr-beta-ppa``).
78
* You must have a GPG key registered to your Launchpad account.
80
On reasonably recent versions of Ubuntu you no longer need special dput
81
configuration, because you can just say ::
83
dput ppa:bzr/proposed <source.changes
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::
91
default_host_main = notspecified
93
* Configure ``bzr-builddeb`` to sign the package, which is required for
94
Launchpad to build it. Put this in ``~/.bazaar/builddeb.conf`` ::
97
builder = dpkg-buildpackage -rfakeroot
98
source-builder= dpkg-buildpackage -rfakeroot -S -sa
100
* You need a Ubuntu (or probably Debian) machine, and ::
102
sudo apt-get install build-essential devscripts dput quilt patch libcrypt-ssleay-perl debhelper cdbs python-docutils
104
Please update this document if you encounter unmet dependencies or find a
105
shorter way to express them.
107
* You will also want to have the `bzr-builddeb`_ plugin installed, which
108
depends on `bzrtools`_.
110
.. _`bzr-builddeb`: http://launchpad.net/bzr-builddeb
111
.. _`bzrtools`: http://launchpad.net/bzrtools
117
Overview of packaging with builddeb
118
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120
* First update the oldest supported branch, using ``bzr merge-upstream``.
122
* Run ``bzr builddeb -S -- -sa`` to build a source package, then put
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.)
131
* Now merge across that change into each supported branch with a
132
simple ``bzr merge``.
134
Locally testing using pbuilder
135
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
141
Update all packages in proposed before copping the main ppa
142
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
153
For people who have already set up everything they need, building the
154
release packages is as simple as::
156
cd ~/dev/bzr/releases/packaging
157
export VERSION="1.17~rc1-1~bazaar1"
159
export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
160
~/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
167
Rinse and repeat for all the plugins by changing VERSION and PACKAGE.
172
#. You will end up checking out a separate directory for each supported
173
release. Such as ``~/dev/bzr/releases/packaging/hardy``. In each of these
174
branches, you will produce the package for the release.
176
The scripts will also create the branches and produce packages for
177
bzrtools and bzr-svn.
179
#. Decide on the final version number. It should be of this form::
181
bzr-1.17~rc1-1~bazaar1~hardy1
183
**Note:** There are three hyphen-separated parts: the *package name*,
184
the *upstream version*, and the *packaging version*.
186
**Caution:** Upstream betas or release candidates must insert a tilde
187
to make them sort before the final release, like this:
188
``bzr-1.17~rc1-1~bazaar1~hardy1``.
190
Final releases will use a release string of the form:
191
``bzr-1.17-1~bazaar1~hardy1``
193
Set this base of this up as a usable environment variable::
195
export VERSION="1.17~rc1-1~bazaar1"
197
#. Export the distroreleases that you will be packaging for::
199
export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
201
#. Export the program you are packaging::
205
#. Checkout (or update) the packaging branch for each supported release::
207
bzr co lp:~bzr/ubuntu/hardy/bzr/bzr-ppa
209
There is a script available to help::
211
tools/packaging/update-packaging-branches.sh
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/
217
#. The ``bzr-builddeb`` step will download the original tarball if you do
218
not already have it, putting it into a ``tarballs`` directory.
220
#. For Bazaar plugins, change the ``debian/control`` file to express a
221
dependency on the correct version of ``bzr``.
223
For bzrtools this is typically::
225
Build-Depends-Indep: bzr (>= 1.17~), rsync
226
Depends: ${python:Depends}, bzr (>= 1.17~), bzr (<< 1.18~), patch
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::
231
tools/packaging/update-control.sh
233
You must supply the versions as arguments as follows
234
OLD_VERSION CURRENT_VERSION NEXT_VERSION, such as::
236
tools/packaging/update-control.sh 1.16 1.17 1.18
238
#. Make a new ``debian/changelog`` entry for the new release,
239
either by using ``dch`` or just editing the file::
241
dch -v '1.17~rc1-1~bazaar1~hardy1' -D hardy
243
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
247
Make sure you have the correct email address for yourself (you may need
248
export DEBEMAIL=`bzr whoami` if it isn't already set), version number, and
249
distribution. It should look something like this::
251
bzr (1.17~rc1-1~bazaar1~hardy1) hardy; urgency=low
253
* New upstream release.
255
-- John Sample <sample@example.com> Mon, 31 Mar 2008 12:36:27 +1100
257
If you need to upload the package again to fix a problem, normally you
258
should increment the last number in the version number, following the
259
distro name. Make sure not to omit the initial ``-1``, and make sure
260
that the distro name in the version is consistent with the target name
261
outside the parenthesis.
263
You will also want to commit these changes into the packaging branch.
265
There is a helper script which will build all the packages
266
for all of your ``$UBUNTU_RELEASES``. It is available as::
268
tools/packaging/update-changelogs.sh
270
#. Build the source packages::
272
cd bzr-$DISTRO; bzr builddeb -S
274
This will create a ``.changes`` file. If you didn't configure builddeb
275
to automatically sign them, you can use ::
277
debsign -m$UID *.changes
279
where ``$UID`` is the gpg key you want to use to sign the changes.
281
There is a helper script which will build the package
282
for all of your ``$UBUNTU_RELEASES``. It is available as::
284
tools/packaging/build-packages.sh
286
#. Upload into the PPA for each release::
288
dput dput ppa:bzr/proposed bzr*1.17-1*.changes
290
#. You should soon get an "upload accepted" mail from Launchpad, which
291
means that your package is waiting to be built. You can then track its
292
progress in <https://launchpad.net/~bzr-beta-ppa/+archive> and
293
<https://launchpad.net/~bzr-beta-ppa/+archive/+builds>.
299
bzr-svn uses a packaging branch that contains both the source
300
(including any changes against upstream) and the ``debian/`` directory.
304
#. Get a checkout of ``lp:~bzr/bzr-svn/hardy-ppa/``
306
#. Merge from ``http://bzr.debian.org/pkg-bazaar/bzr-svn/unstable/``
308
This should bring in both upstream and packaging changes for the new
309
release, and it's updated as part of the bzr-svn release process.
311
It's quite possible you will need to resolve some conflicts.
313
#. Run ``dch -v 0.4.15-1~bazaar1-hardy1 -D hardy`` or similar
315
#. Run ``bzr builddeb --source``
317
bzr-builddeb will automatically check out the appropriate tag from the
318
main branch of bzr-svn, build, and package it.
320
#. ``dput bzr-beta-ppa ../bzr-svn_0.4.15-1~bazaar1~hardy1_source.changes``
323
Monitoring the contents of PPAs
324
-------------------------------
326
If you add all the bzr PPAs to your ``sources.list`` then you can see a
327
summary of current package versions with::
329
apt-cache madison bzr
332
Testing the contents of the PPA
333
-------------------------------
335
A somewhat crude but useful way to test the contents of the PPA is to
336
install the relevant packages into an schroot::
338
schroot -c hardy-test -u root -- \
339
apt-get install -o 'APT::Install-Suggests="true"' \
340
-o 'APT::Install-Recommends="true"' \
343
This should make sure everything can be installed; it won't guarantee that
346
Packaging dependencies
347
----------------------
349
Some of our updates to bzr in previous releases require backports of our
350
dependencies. Specific branches holding these backports:
352
* ``lp:~bzr/ubuntu/dapper/configobj/dapper-backport``
356
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/ppa.txt
