~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/ppa.txt

Latest bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Managing the Bazaar PPA
2
 
=======================
3
 
 
4
 
See also: `Bazaar Developer Document Catalog <index.html>`_.
5
 
 
6
 
 
7
 
Background
8
 
----------
9
 
 
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
 
 
14
 
  __ https://help.launchpad.net/PPAQuickStart
15
 
 
16
 
As of June 2008, there are three PPAs:
17
 
 
18
 
<https://launchpad.net/~bzr/+archive>
19
 
    Final released versions.
20
 
 
21
 
<https://launchpad.net/~bzr-beta-ppa/+archive>
22
 
    Releases and release candidates.
23
 
 
24
 
<https://launchpad.net/~bzr-nightly-ppa/+archive>
25
 
    Automatic nightly builds from trunk.
26
 
 
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``.
34
 
If you upload a release-specific version, you should add a suffix to the
35
 
package version, e.g. ``bzr.1.3-1~bazaar1~dapper1``.
36
 
 
37
 
Every package is first uploaded into the beta ppa.  For final release
38
 
versions it is also copied to the main PPA.
39
 
 
40
 
The packaging information is kept in branches of bzr on Launchpad, named
41
 
like
42
 
<https://code.launchpad.net/~bzr/bzr/packaging-hardy>.
43
 
or
44
 
<lp:~bzr/bzr/packaging-hardy>.  These branches are intended to be used
45
 
with the ``bzr-builddeb`` plugin.
46
 
 
47
 
Preconditions
48
 
-------------
49
 
 
50
 
* You must have a Launchpad account and be a member of the teams
51
 
  that own these PPAs (``~bzr``, ``~bzr-beta-ppa``).
52
 
 
53
 
* You must have a GPG key registered to your Launchpad account.
54
 
 
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::
75
 
 
76
 
    [DEFAULT]
77
 
    default_host_main = notspecified
78
 
 
79
 
* Configure ``bzr-builddeb`` to sign the package, which is required for
80
 
  Launchpad to build it.  Put this in ``~/.bazaar/builddeb.conf`` ::
81
 
 
82
 
      [BUILDDEB]
83
 
      builder = dpkg-buildpackage -rfakeroot
84
 
      source-builder= dpkg-buildpackage -rfakeroot -S -sa
85
 
 
86
 
* You need a Ubuntu (or probably Debian) machine, and ::
87
 
 
88
 
    sudo apt-get install build-essential devscripts dput quilt patch libcrypt-ssleay-perl debhelper cdbs python-docutils
89
 
 
90
 
  Please update this document if you encounter unmet dependencies or find a
91
 
  shorter way to express them.
92
 
 
93
 
* You will also want to have the `bzr-builddeb`_ plugin installed, which
94
 
  depends on `bzrtools`_.
95
 
 
96
 
.. _`bzr-builddeb`: http://launchpad.net/bzr-builddeb
97
 
.. _`bzrtools`: http://launchpad.net/bzrtools
98
 
 
99
 
 
100
 
Packaging Bazaar
101
 
----------------
102
 
 
103
 
Short form
104
 
~~~~~~~~~~
105
 
 
106
 
For people who have already set up everything they need, building the
107
 
release packages is as simple as::
108
 
 
109
 
  cd ~/dev/bzr/releases/packaging
110
 
  export VERSION="1.17~rc1-1~bazaar1"
111
 
  export PACKAGE="bzr"
112
 
  export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
113
 
  ~/dev/bzr/bzr.dev/tools/packaging/update-packaging-branches.sh
114
 
  ~/dev/bzr/bzr.dev/tools/packaging/update-changelogs.sh
115
 
  ~/dev/bzr/bzr.dev/tools/packaging/update-control.sh 1.16 1.17 1.18
116
 
  ~/dev/bzr/bzr.dev/tools/packaging/build-packages.sh
117
 
  dput bzr-beta-ppa ${PACKAGE}_$VERSION*.changes
118
 
 
119
 
Rinse and repeat for all the plugins by changing VERSION and PACKAGE.
120
 
 
121
 
Long Form
122
 
~~~~~~~~~
123
 
 
124
 
#. You will end up checking out a separate directory for each supported
125
 
   release. Such as ``~/dev/bzr/releases/packaging/hardy``. In each of these
126
 
   branches, you will produce the package for the release.
127
 
 
128
 
   The scripts will also create the branches and produce packages for
129
 
   bzrtools and bzr-svn.
130
 
 
131
 
#. Decide on the final version number.  It should be of this form::
132
 
 
133
 
     bzr-1.17~rc1-1~bazaar1~hardy1
134
 
 
135
 
   **Note:** There are three hyphen-separated parts: the *package name*,
136
 
   the *upstream version*, and the *packaging version*.
137
 
 
138
 
   **Caution:** Upstream betas or release candidates must insert a tilde
139
 
   to make them sort before the final release, like this:
140
 
   ``bzr-1.17~rc1-1~bazaar1~hardy1``.
141
 
 
142
 
   Final releases will use a release string of the form:
143
 
   ``bzr-1.17-1~bazaar1~hardy1``
144
 
 
145
 
   Set this base of this up as a usable environment variable::
146
 
 
147
 
      export VERSION="1.17~rc1-1~bazaar1"
148
 
 
149
 
#. Export the distroreleases that you will be packaging for::
150
 
 
151
 
      export UBUNTU_RELEASES="dapper hardy intrepid jaunty karmic"
152
 
 
153
 
#. Export the program you are packaging::
154
 
 
155
 
      export PACKAGE="bzr"
156
 
 
157
 
#. Checkout (or update) the packaging branch for each supported release::
158
 
 
159
 
      bzr co lp:~bzr/bzr/packaging-hardy
160
 
 
161
 
   There is a script available to help::
162
 
 
163
 
      tools/packaging/update-packaging-branches.sh
164
 
 
165
 
#. The ``bzr-builddeb`` step will download the original tarball if you do
166
 
   not already have it, putting it into a ``tarballs`` directory.
167
 
 
168
 
#. For Bazaar plugins, change the ``debian/control`` file to express a
169
 
   dependency on the correct version of ``bzr``.
170
 
 
171
 
   For bzrtools this is typically::
172
 
 
173
 
      Build-Depends-Indep: bzr (>= 1.17~), rsync
174
 
      Depends: ${python:Depends}, bzr (>= 1.17~), bzr (<< 1.18~), patch
175
 
 
176
 
   There is a helper script which will update the control file and commit it
177
 
   for all of your ``$UBUNTU_RELEASES``. It is available as::
178
 
 
179
 
    tools/packaging/update-control.sh
180
 
 
181
 
   You must supply the versions as arguments as follows
182
 
   OLD_VERSION CURRENT_VERSION NEXT_VERSION, such as::
183
 
 
184
 
    tools/packaging/update-control.sh 1.16 1.17 1.18
185
 
 
186
 
#. Make a new ``debian/changelog`` entry for the new release,
187
 
   either by using ``dch`` or just editing the file::
188
 
 
189
 
      dch -v '1.17~rc1-1~bazaar1~hardy1' -D hardy
190
 
 
191
 
   dch will default to the distro you're working in and this isn't checked
192
 
   against the version number (which is just our convention), so make sure
193
 
   to specify it.
194
 
 
195
 
   Make sure you have the correct email address for yourself (you may need
196
 
   export DEBEMAIL=`bzr whoami` if it isn't already set), version number, and
197
 
   distribution.  It should look something like this::
198
 
 
199
 
       bzr (1.17~rc1-1~bazaar1~hardy1) hardy; urgency=low
200
 
 
201
 
        * New upstream release.
202
 
 
203
 
       -- John Sample <sample@example.com>  Mon, 31 Mar 2008 12:36:27 +1100
204
 
 
205
 
   If you need to upload the package again to fix a problem, normally you
206
 
   should increment the last number in the version number, following the
207
 
   distro name.  Make sure not to omit the initial ``-1``, and make sure
208
 
   that the distro name in the version is consistent with the target name
209
 
   outside the parenthesis.
210
 
 
211
 
   You will also want to commit these changes into the packaging branch.
212
 
 
213
 
   There is a helper script which will build all the packages
214
 
   for all of your ``$UBUNTU_RELEASES``. It is available as::
215
 
 
216
 
      tools/packaging/update-changelogs.sh
217
 
 
218
 
#. Build the source packages::
219
 
 
220
 
      cd packaging-$DISTRO; bzr builddeb -S
221
 
 
222
 
   This will create a ``.changes`` file.  If you didn't configure builddeb
223
 
   to automatically sign them, you can use ::
224
 
 
225
 
      debsign -m$UID *.changes
226
 
 
227
 
   where ``$UID`` is the gpg key you want to use to sign the changes.
228
 
 
229
 
   There is a helper script which will build the package
230
 
   for all of your ``$UBUNTU_RELEASES``. It is available as::
231
 
 
232
 
      tools/packaging/build-packages.sh
233
 
 
234
 
#. Upload into the beta PPA for each release::
235
 
 
236
 
     dput bzr-beta-ppa bzr*1.17-1*.changes
237
 
 
238
 
#. For final release versions, also copy it into the ``~bzr`` PPA::
239
 
 
240
 
     dput bzr-ppa ../bzr_1.17-1\~bazaar1\~hardy1\_source.changes
241
 
 
242
 
   Alternatively, you can use Launchpad's "copy" feature to copy the
243
 
   packages between repositories.
244
 
 
245
 
#. You should soon get an "upload accepted" mail from Launchpad, which
246
 
   means that your package is waiting to be built.  You can then track its
247
 
   progress in <https://launchpad.net/~bzr-beta-ppa/+archive> and
248
 
   <https://launchpad.net/~bzr-beta-ppa/+archive/+builds>.
249
 
 
250
 
 
251
 
Packaging bzr-svn
252
 
~~~~~~~~~~~~~~~~~
253
 
 
254
 
bzr-svn uses a packaging branch that contains both the source
255
 
(including any changes against upstream) and the ``debian/`` directory.
256
 
 
257
 
To build bzr-svn:
258
 
 
259
 
#. Get a checkout of ``lp:~bzr/bzr-svn/hardy-ppa/``
260
 
 
261
 
#. Merge from ``http://bzr.debian.org/pkg-bazaar/bzr-svn/unstable/``
262
 
 
263
 
   This should bring in both upstream and packaging changes for the new
264
 
   release, and it's updated as part of the bzr-svn release process.
265
 
 
266
 
   It's quite possible you will need to resolve some conflicts.
267
 
 
268
 
#. Run ``dch -v 0.4.15-1~bazaar1-hardy1 -D hardy`` or similar
269
 
 
270
 
#. Run ``bzr builddeb --source``
271
 
 
272
 
   bzr-builddeb will automatically check out the appropriate tag from the
273
 
   main branch of bzr-svn, build, and package it.
274
 
 
275
 
#. ``dput bzr-beta-ppa ../bzr-svn_0.4.15-1~bazaar1~hardy1_source.changes``
276
 
 
277
 
 
278
 
Monitoring the contents of PPAs
279
 
-------------------------------
280
 
 
281
 
If you add all the bzr PPAs to your ``sources.list`` then you can see a
282
 
summary of current package versions with::
283
 
 
284
 
  apt-cache madison bzr
285
 
 
286
 
 
287
 
..
288
 
   vim: filetype=rst textwidth=74 ai shiftwidth=4