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 release
11
process. These packages are hosted in a few `Personal Package Archives (PPA)`__ on
14
__ https://help.launchpad.net/PPAQuickStart
16
As of June 2010, there are three PPAs:
18
<https://launchpad.net/~bzr/+archive>
19
Final released versions and updates.
21
<https://launchpad.net/~bzr/+archive/proposed>
22
Proposed uploads to move into ~bzr, awaiting testing.
24
<https://launchpad.net/~bzr-beta-ppa/+archive>
27
<https://launchpad.net/~bzr-nightly-ppa/+archive>
28
Automatic nightly builds from trunk.
30
We build a distinct package for each distrorelease.
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``.
34
Dapper uses the ``python-support`` framework and later distributions use
35
``python-central``. This has little effect on everyday packaging but does
36
mean that some of the control files are quite different.
38
Every package is first uploaded into the beta ppa. For final release
39
versions it is also copied to the main PPA.
41
The packaging information is kept in branches of bzr on Launchpad, named
43
<https://code.launchpad.net/~bzr/ubuntu/hardy/bzr/bzr-ppa>.
45
<lp:~bzr/ubuntu/hardy/bzr/bzr-ppa>. These branches are intended to be used
46
with the ``bzr-builddeb`` plugin.
48
**You should almost always upload to the beta ppa first** and then either
49
upload again or copy the packages into the release ppa. That reduces the
50
risk of breaking the main archive from which people get bzr updates.
56
We build packages for every supported Ubuntu release
57
<https://wiki.ubuntu.com/Releases>. Packages need no longer be updated
58
when the release passes end-of-life because all users should
59
have upgraded by then.
61
As of August 2010, the following releases are supported:
66
* Jaunty (support ends October 2010)
68
* Dapper LTS (supported but no longer updated for new releases)
74
* You must have a Launchpad account and be a member of the teams
75
that own these PPAs (``~bzr``, ``~bzr-beta-ppa``).
77
* You must have a GPG key registered to your Launchpad account.
79
On reasonably recent versions of Ubuntu you no longer need special dput
80
configuration, because you can just say ::
82
dput ppa:bzr/proposed <source.changes
85
However, you may still want to add these lines to ``~/.dput.cf`` prevent
86
inadvertently attempting to upload into Ubuntu or Debian, which will
87
give a somewhat unclear error::
90
default_host_main = notspecified
92
* Configure ``bzr-builddeb`` to sign the package, which is required for
93
Launchpad to build it. Put this in ``~/.bazaar/builddeb.conf`` ::
96
builder = dpkg-buildpackage -rfakeroot
97
source-builder= dpkg-buildpackage -rfakeroot -S -sa
99
* You need a Ubuntu (or probably Debian) machine, and ::
101
sudo apt-get install build-essential devscripts dput quilt patch libcrypt-ssleay-perl debhelper cdbs python-docutils
103
Please update this document if you encounter unmet dependencies or find a
104
shorter way to express them.
106
* You will also want to have the `bzr-builddeb`_ plugin installed, which
107
depends on `bzrtools`_.
109
.. _`bzr-builddeb`: http://launchpad.net/bzr-builddeb
110
.. _`bzrtools`: http://launchpad.net/bzrtools
116
Overview of packaging with builddeb
117
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
119
* First update the oldest supported branch, using ``bzr merge-upstream``.
121
* Run ``bzr builddeb -S -- -sa`` to build a source package, then put
124
(``-S`` says to make a source-only upload, which is
125
required for Launchpad's builders. ``--sa`` says to include the
126
``.orig.tgz`` even if this doesn't seem to be the first upload for an
127
upstream release: this is often needed when rebuilding something that's
128
previously been uploaded to Debian or Ubuntu or into a different PPA.)
130
* Now merge across that change into each supported branch with a
131
simple ``bzr merge``.
133
Locally testing builds
134
~~~~~~~~~~~~~~~~~~~~~~
136
It may be useful to locally test builds inside pbuilder. You may want to
137
use the script from <http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=255165>
140
Update all packages in proposed before copping the main ppa
141
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143
If one updates bzr, and there are plugins that are not compatible with the
144
new version of bzr, this can cause pain for users using the ppa. In order to
145
avoid this, we first get all packages up to date in the proposed ppa, and then
146
copy them to the main ppa.
152
For people who have already set up everything they need, building the
153
release packages is as simple as::
155
cd ~/dev/bzr/releases/packaging
156
export VERSION="1.17~rc1-1~bazaar1"
158
export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
159
~/dev/bzr/bzr.dev/tools/packaging/update-packaging-branches.sh
160
* Optionaly merge debian unstable.
161
~/dev/bzr/bzr.dev/tools/packaging/update-changelogs.sh
162
~/dev/bzr/bzr.dev/tools/packaging/update-control.sh 1.16 1.17 1.18
163
~/dev/bzr/bzr.dev/tools/packaging/build-packages.sh
164
dput ppa:bzr/proposed ${PACKAGE}_$VERSION*.changes
166
Rinse and repeat for all the plugins by changing VERSION and PACKAGE.
171
#. You will end up checking out a separate directory for each supported
172
release. Such as ``~/dev/bzr/releases/packaging/hardy``. In each of these
173
branches, you will produce the package for the release.
175
The scripts will also create the branches and produce packages for
176
bzrtools and bzr-svn.
178
#. Decide on the final version number. It should be of this form::
180
bzr-1.17~rc1-1~bazaar1~hardy1
182
**Note:** There are three hyphen-separated parts: the *package name*,
183
the *upstream version*, and the *packaging version*.
185
**Caution:** Upstream betas or release candidates must insert a tilde
186
to make them sort before the final release, like this:
187
``bzr-1.17~rc1-1~bazaar1~hardy1``.
189
Final releases will use a release string of the form:
190
``bzr-1.17-1~bazaar1~hardy1``
192
Set this base of this up as a usable environment variable::
194
export VERSION="1.17~rc1-1~bazaar1"
196
#. Export the distroreleases that you will be packaging for::
198
export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
200
#. Export the program you are packaging::
204
#. Checkout (or update) the packaging branch for each supported release::
206
bzr co lp:~bzr/ubuntu/hardy/bzr/bzr-ppa
208
There is a script available to help::
210
tools/packaging/update-packaging-branches.sh
212
#. Optionaly, merge the Debian unstable branch into each of the packaging
213
branches. You can find the Debian unstable branch here:
214
http://bzr.debian.org/pkg-bazaar/
216
#. The ``bzr-builddeb`` step will download the original tarball if you do
217
not already have it, putting it into a ``tarballs`` directory.
219
#. For Bazaar plugins, change the ``debian/control`` file to express a
220
dependency on the correct version of ``bzr``.
222
For bzrtools this is typically::
224
Build-Depends-Indep: bzr (>= 1.17~), rsync
225
Depends: ${python:Depends}, bzr (>= 1.17~), bzr (<< 1.18~), patch
227
There is a helper script which will update the control file and commit it
228
for all of your ``$UBUNTU_RELEASES``. It is available as::
230
tools/packaging/update-control.sh
232
You must supply the versions as arguments as follows
233
OLD_VERSION CURRENT_VERSION NEXT_VERSION, such as::
235
tools/packaging/update-control.sh 1.16 1.17 1.18
237
#. Make a new ``debian/changelog`` entry for the new release,
238
either by using ``dch`` or just editing the file::
240
dch -v '1.17~rc1-1~bazaar1~hardy1' -D hardy
242
dch will default to the distro you're working in and this isn't checked
243
against the version number (which is just our convention), so make sure
246
Make sure you have the correct email address for yourself (you may need
247
export DEBEMAIL=`bzr whoami` if it isn't already set), version number, and
248
distribution. It should look something like this::
250
bzr (1.17~rc1-1~bazaar1~hardy1) hardy; urgency=low
252
* New upstream release.
254
-- John Sample <sample@example.com> Mon, 31 Mar 2008 12:36:27 +1100
256
If you need to upload the package again to fix a problem, normally you
257
should increment the last number in the version number, following the
258
distro name. Make sure not to omit the initial ``-1``, and make sure
259
that the distro name in the version is consistent with the target name
260
outside the parenthesis.
262
You will also want to commit these changes into the packaging branch.
264
There is a helper script which will build all the packages
265
for all of your ``$UBUNTU_RELEASES``. It is available as::
267
tools/packaging/update-changelogs.sh
269
#. Build the source packages::
271
cd bzr-$DISTRO; bzr builddeb -S
273
This will create a ``.changes`` file. If you didn't configure builddeb
274
to automatically sign them, you can use ::
276
debsign -m$UID *.changes
278
where ``$UID`` is the gpg key you want to use to sign the changes.
280
There is a helper script which will build the package
281
for all of your ``$UBUNTU_RELEASES``. It is available as::
283
tools/packaging/build-packages.sh
285
#. Upload into the PPA for each release::
287
dput dput ppa:bzr/proposed bzr*1.17-1*.changes
289
#. You should soon get an "upload accepted" mail from Launchpad, which
290
means that your package is waiting to be built. You can then track its
291
progress in <https://launchpad.net/~bzr-beta-ppa/+archive> and
292
<https://launchpad.net/~bzr-beta-ppa/+archive/+builds>.
298
bzr-svn uses a packaging branch that contains both the source
299
(including any changes against upstream) and the ``debian/`` directory.
303
#. Get a checkout of ``lp:~bzr/bzr-svn/hardy-ppa/``
305
#. Merge from ``http://bzr.debian.org/pkg-bazaar/bzr-svn/unstable/``
307
This should bring in both upstream and packaging changes for the new
308
release, and it's updated as part of the bzr-svn release process.
310
It's quite possible you will need to resolve some conflicts.
312
#. Run ``dch -v 0.4.15-1~bazaar1-hardy1 -D hardy`` or similar
314
#. Run ``bzr builddeb --source``
316
bzr-builddeb will automatically check out the appropriate tag from the
317
main branch of bzr-svn, build, and package it.
319
#. ``dput bzr-beta-ppa ../bzr-svn_0.4.15-1~bazaar1~hardy1_source.changes``
322
Monitoring the contents of PPAs
323
-------------------------------
325
If you add all the bzr PPAs to your ``sources.list`` then you can see a
326
summary of current package versions with::
328
apt-cache madison bzr
332
Packaging dependencies
333
----------------------
335
Some of our updates to bzr in previous releases require backports of our
336
dependencies. Specific branches holding these backports:
338
* ``lp:~bzr/ubuntu/dapper/configobj/dapper-backport``
342
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/ppa.txt
