~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/ppa.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-10-16 13:18:07 UTC
  • mfrom: (3779.1.1 284343-doc)
  • Revision ID: pqm@pqm.ubuntu.com-20081016131807-r3p1hsepd24feegv
Trivial doc fix

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