~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/ppa.txt

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

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