~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/ppa.txt

  • Committer: Ian Clatworthy
  • Date: 2009-01-19 02:24:15 UTC
  • mto: This revision was merged to the branch mainline in revision 3944.
  • Revision ID: ian.clatworthy@canonical.com-20090119022415-mo0mcfeiexfktgwt
apply jam's log --short fix (Ian Clatworthy)

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