~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/ppa.txt

merge merge tweaks from aaron, which includes latest .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
 
  ln ~/dev/bzr/releases/bzr-1.6.tar.gz ./bzr_1.6.orig.tar.gz
111
 
  export UBUNTU_RELEASES="dapper feisty gutsy hardy intrepid"
112
 
  ~/dev/bzr/bzr.dev/tools/packaging/update-packaging-branches.sh
113
 
  ~/dev/bzr/bzr.dev/tools/packaging/update-changelogs.sh 1.6~beta3-1~bazaar1
114
 
  ~/dev/bzr/bzr.dev/tools/packaging/build-packages
115
 
  dput bzr-beta-ppa bzr_1.6~beta3-1~bazaar1*.changes
116
 
 
117
 
Long Form
118
 
~~~~~~~~~
119
 
 
120
 
#. You will end up checking out a separate directory for each supported
121
 
   release. Such as ``~/dev/bzr/releases/packaging/hardy``. In each of these
122
 
   branches, you will produce the package for the release.
123
 
 
124
 
#. Decide on the final version number.  It should be of this form::
125
 
 
126
 
     bzr-1.6~beta3-1~bazaar1~hardy1
127
 
 
128
 
   **Note:** There are three hyphen-separated parts: the *package name*,
129
 
   the *upstream version*, and the *packaging version*.
130
 
 
131
 
   **Caution:** Upstream betas or release candidates must insert a tilde
132
 
   to make them sort before the final release, like this:
133
 
   ``bzr-1.6~beta3-1~bazaar1~hardy1``.
134
 
 
135
 
   Final releases will use a release string of the form:
136
 
   ``bzr-1.6-1~bazaar1~hardy1``
137
 
 
138
 
#. Export the distroreleases that you will be packaging for::
139
 
 
140
 
      export UBUNTU_RELEASES="dapper feisty gutsy hardy intrepid jaunty"
141
 
 
142
 
#. Checkout (or update) the packaging branch for each supported release::
143
 
 
144
 
      bzr co lp:~bzr/bzr/packaging-hardy
145
 
 
146
 
   There is a script available to help::
147
 
 
148
 
      tools/packaging/update-packaging-branches.sh
149
 
 
150
 
#. The ``bzr-builddeb`` step will download the original tarball if you do
151
 
   not already have it, putting it into a ``tarballs`` directory.
152
 
 
153
 
#. For Bazaar plugins, change the ``debian/control`` file to express a
154
 
   dependency on the correct version of ``bzr``.
155
 
 
156
 
   For bzrtools this is typically::
157
 
 
158
 
      Build-Depends-Indep: bzr (>= 1.6~), rsync
159
 
      Depends: ${python:Depends}, bzr (>= 1.6~), bzr (<< 1.7~), patch
160
 
 
161
 
#. Make a new ``debian/changelog`` entry for the new release,
162
 
   either by using ``dch`` or just editing the file::
163
 
 
164
 
      dch -v '1.6~beta3-1~bazaar1~hardy1' -D hardy
165
 
 
166
 
   dch will default to the distro you're working in and this isn't checked
167
 
   against the version number (which is just our convention), so make sure 
168
 
   to specify it.
169
 
 
170
 
   Make sure you have the correct email address for yourself (you may need
171
 
   export DEBEMAIL=`bzr whoami` if it isn't already set), version number, and
172
 
   distribution.  It should look something like this::
173
 
 
174
 
       bzr (1.6~beta3-1~bazaar1~hardy1) hardy; urgency=low
175
 
     
176
 
        * New upstream release.
177
 
     
178
 
       -- John Sample <sample@example.com>  Mon, 31 Mar 2008 12:36:27 +1100
179
 
 
180
 
   If you need to upload the package again to fix a problem, normally you
181
 
   should increment the last number in the version number, following the
182
 
   distro name.  Make sure not to omit the initial ``-1``, and make sure
183
 
   that the distro name in the version is consistent with the target name
184
 
   outside the parenthesis.
185
 
 
186
 
   You will also want to commit these changes into the packaging branch.
187
 
 
188
 
   There is a helper script which will update the changelog and commit it
189
 
   for all of your ``$UBUNTU_RELEASES``. It is available as::
190
 
 
191
 
      tools/packaging/update-changelogs.sh
192
 
 
193
 
   You must supply the release string, such as::
194
 
 
195
 
      tools/packaging/update-changelogs.sh 1.6~beta3-1~bazaar1
196
 
 
197
 
   It will automatically append the distro numbering on the end.
198
 
 
199
 
#. Build the source packages::
200
 
 
201
 
      cd packaging-$DISTRO; bzr builddeb -S
202
 
 
203
 
   This will create a ``.changes`` file.  If you didn't configure builddeb
204
 
   to automatically sign them, you can use ::
205
 
 
206
 
      debsign -m$UID *.changes
207
 
 
208
 
   where ``$UID`` is the gpg key you want to use to sign the changes.
209
 
 
210
 
#. Upload into the beta PPA for each release::
211
 
 
212
 
     dput bzr-beta-ppa bzr_1.6-1*.changes
213
 
 
214
 
#. For final release versions, also copy it into the ``~bzr`` PPA::
215
 
 
216
 
     dput bzr-ppa ../bzr_1.6-1\~bazaar1\~hardy1\_source.changes
217
 
 
218
 
   Alternatively, you can use Launchpad's "copy" feature to copy the
219
 
   packages between repositories.
220
 
 
221
 
#. You should soon get an "upload accepted" mail from Launchpad, which
222
 
   means that your package is waiting to be built.  You can then track its
223
 
   progress in <https://launchpad.net/~bzr-beta-ppa/+archive> and
224
 
   <https://launchpad.net/~bzr-beta-ppa/+archive/+builds>.
225
 
 
226
 
 
227
 
Packaging bzr-svn
228
 
~~~~~~~~~~~~~~~~~
229
 
 
230
 
bzr-svn uses a packaging branch that contains both the source 
231
 
(including any changes against upstream) and the ``debian/`` directory.
232
 
 
233
 
To build bzr-svn:
234
 
 
235
 
#. Get a checkout of ``lp:~bzr/bzr-svn/hardy-ppa/``
236
 
 
237
 
#. Merge from ``http://bzr.debian.org/pkg-bazaar/bzr-svn/experimental/``
238
 
  
239
 
   This should bring in both upstream and packaging changes for the new
240
 
   release, and it's updated as part of the bzr-svn release process.
241
 
 
242
 
#. Run ``dch -v 0.4.15-1~bazaar1-hardy1 -D hardy`` or similar
243
 
 
244
 
#. Run ``bzr builddeb --source``
245
 
 
246
 
   bzr-builddeb will automatically check out the appropriate tag from the
247
 
   main branch of bzr-svn, build, and package it.
248
 
 
249
 
#. ``dput bzr-beta-ppa ../bzr-svn_0.4.15-1~bazaar1~hardy1_source.changes``
250
 
 
251
 
 
252
 
Monitoring the contents of PPAs
253
 
-------------------------------
254
 
 
255
 
If you add all the bzr PPAs to your ``sources.list`` then you can see a
256
 
summary of current package versions with::
257
 
 
258
 
  apt-cache madison bzr
259
 
 
260
 
 
261
 
..
262
 
   vim: filetype=rst textwidth=74 ai shiftwidth=4