4
This document describes the processes for making and announcing a Bazaar
5
release, and managing the release process.
7
We normally have one person acting as the release manager, who
8
organizes development for the release and also actually makes the release
9
tarball and posts announcements. It can be a different person from one
12
See also: `Bazaar Developer Document Catalog <index.html>`_.
20
Our usual process is that one week before release we will make a release
21
branch from the trunk. We do one commit to that branch to change the
22
version number to 'rc1', and advance the trunk version to 'dev' for the
25
We then publish and announce this release candidate according to the
26
process below. We then have a week of general testing of the rc,
27
including some time for plugin authors to update their code for any
30
Normally no changes will be made on the release branch unless serious bugs
31
or regressions are found, and the release manager decides they should be
32
merged in. After one week, the release branch's version number is updated
33
and it's published as the final release. If regressions or serious
34
problems are discovered after the final release we may make an additional
35
point release from that branch.
37
The process or timing can vary if that seems appropriate in a particular
38
case but we try to release on a regular four week cycle.
40
The net effect is that the code gets some extra testing before release,
41
and the trunk is always open for general development.
49
To start a new release cycle:
51
#. Send mail to the list with the key dates, who will be the release
52
manager, and the main themes or targetted bugs. Ask people to nominate
53
objectives, or point out any high-risk things that are best done early,
54
or that interact with other changes.
56
#. Add a new "series" in Launchpad at <https://launchpad.net/bzr/+addseries>. There is one
57
series for every *x.y* release.
63
Every week the release manager should send a mail to the Bazaar list
64
covering these points (as appropriate):
66
* Early communication about changing dependencies or defaults
68
* Reminder re lifecycle and where we're up to right now, in particular the
69
dates for the next release and/or candidate.
71
* Summary of recent successes and pending work.
73
* Reminder re release objectives
75
* Reminder re things needing attention, e.g. bug triage, reviews, testing of certain things, etc.
78
Preparing the tree for release
79
------------------------------
81
.. Was previously at http://bazaar-vcs.org/ReleaseChecklist
83
.. TODO: Still needs more clarity on what's in a RC versus a final
86
This is the procedure for making a new bzr release:
88
#. If the release is the first candidate, make a new branch in PQM.
89
(Contact Robert Collins for this step).
91
Register the branch at https://launchpad.net/products/bzr/+addbranch
93
#. Make a local branch for preparing this release. (Only for the first
94
release in a series, otherwise you should already have a branch.) ::
96
bzr branch trunk prepare-1.6
98
#. Configure pqm-submit for this branch, with a section like this in
99
``~/.bazaar/locations.conf``::
101
[/home/mbp/bzr/prepare-1.4]
102
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
103
submit_branch = http://bazaar-vcs.org/bzr/bzr.1.4
104
submit_to = bazaar@lists.canonical.com
106
#. In the release branch, update ``version_info`` in
107
``./bzrlib/__init__.py``.
108
(This must match ``_script_version`` in the ``bzr`` script, but
109
that is updated at the start of the release cycle, and
110
doesn't need to say if it's an rc or final release.)
112
Run this command and check the output::
116
#. Add the date and release number to ``./NEWS``, and a one-paragraph
117
summary of changes in this release.
119
#. Commit these changes to the release branch, using a command like::
121
bzr commit -m "Release 0.12rc1."
123
The diff before you commit will be something like::
125
=== modified file 'NEWS'
126
--- NEWS 2006-10-23 13:11:17 +0000
127
+++ NEWS 2006-10-23 22:50:50 +0000
130
+bzr 0.12rc1 2006-10-23
135
=== modified file 'bzrlib/__init__.py'
136
--- bzrlib/__init__.py 2006-10-16 01:47:43 +0000
137
+++ bzrlib/__init__.py 2006-10-23 22:49:46 +0000
139
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
140
# releaselevel of 'dev' for unreleased under-development code.
142
-version_info = (0, 12, 0, 'dev', 0)
143
+version_info = (0, 12, 0, 'candidate', 1)
145
if version_info[3] == 'final':
146
version_string = '%d.%d.%d' % version_info[:3]
148
#. Submit those changes to PQM for merge into the appropriate release
152
bzr pqm-submit -m "(mbp) prepare 1.6"
154
#. When PQM succeeds, pull down the master release branch.
157
Making the source tarball
158
-------------------------
160
#. Change into the source directory and run ::
164
#. Now we'll try expanding this tarball and running the test suite
165
to check for packaging problems::
167
make check-dist-tarball
170
Publishing the release
171
----------------------
173
Now you have the releasable product. The next step is making it
174
available to the world.
176
#. In <https://launchpad.net/bzr/> click the "Release series" for this
177
series, to take you to e.g. <https://launchpad.net/bzr/1.1>. Then
178
click "Register a release", and add information about this release.
180
#. Within that release, upload the source tarball and the GPG signature.
182
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
184
#. Update http://doc.bazaar-vcs.org/ to have a directory of documentation
185
for this release. (Controlled by the ``update-bzr-docs`` script on
186
escudero, and also update the ``latest`` symlink in
187
``/srv/bazaar.canonical.com/doc/``.)
189
#. Announce on the `Bazaar home page`__.
191
__ http://bazaar-vcs.org/
194
Announcing the release
195
----------------------
197
Now that the release is publicly available, tell people about it.
199
#. Announce to ``bazaar-announce`` and ``bazaar`` mailing lists.
200
The announce mail will look something like this:
202
| Subject: bzr 0.11 release candidate 1
204
| INTRO HERE. Mention the release number and date, and why the release. (i.e. release candidate for testing, final release of a version, backport/bugfix etc).
207
| http://bazaar-vcs.org/releases/src/bzr-VERSION.tar.gz
209
| http://bazaar-vcs.org/releases/src/bzr-VERSION.tar.gz.sig
211
| DESCRIBE-CHANGES-IN-OVERVIEW-HERE
213
| DESCRIBE-when the next release will be (if there is another - i.e. this is a release candidate)
215
| Many thanks to all the contributors to this release! I've included the
216
| contents of NEWS for VERSION below:
218
To generate the data from NEWS, just copy and paste the relevant news section and clean it up as appropriate. The main clean-up task is to confirm that all major changes are indeed covered. This can be done by running ``bzr log`` back to the point when the branch was opened and cross checking the changes against the NEWS entries.
220
(RC announcements should remind plugin maintainers to update their plugins.)
222
* For point releases (i.e. a release candidate, or an incremental fix
223
to a released version) take everything in the relevant NEWS section. For
224
example, for 0.11rc2 take everything in NEWS from the bzr 0.11rc2 line to the bzr 0.11rc1 line further down.
226
* For major releases (i.e. 0.11, 0.12 etc), take all the combined NEWS sections from within that version: for 0.11 take all of the 0.11 specific section, plus 0.11rc2, plus 0.11rc1 etc.
228
#. Update the IRC channel topic. Use the ``/topic`` command to do this, ensuring the new topic text keeps the project name, web site link, etc.
230
#. Announce on http://freshmeat.net/projects/bzr/
232
This should be done for both release candidates and final releases. If you do not have a Freshmeat account yet, ask one of the existing admins.
234
#. Update http://en.wikipedia.org/wiki/Bzr -- this should be done for final releases but not for Release Candidates.
236
#. Package maintainers should update packages when they see the
239
#. For final releases, also send the announcement mail to
240
info-gnu@gnu.org and python-announce-list@python.org.
242
#. Also send a GNU directory update to bug-directory@gnu.org.
244
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
247
python setup.py register
249
Remember to check the results afterwards.
251
To be able to register the release you must create an account on
252
<http://pypi.python.org/pypi> and have one of the existing owners of
253
the project add you to the group.
256
Merging the released code back to trunk
257
---------------------------------------
259
Merge the release branch back into the trunk. Check that changes in NEWS
260
were merged into the right sections. If it's not already done, advance
261
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
262
back into pqm for bzr.dev.
265
Updating the PPA for a new release
266
----------------------------------
268
We build Ubuntu ``.deb`` packages for Bazaar as an important part of the release
269
process. These packages are hosted in a few `Personal Package Archives (PPA)`__ on
272
__ https://help.launchpad.net/PPAQuickStart
274
As of June 2008, there are actually two PPAs:
276
<https://launchpad.net/~bzr/+archive>
277
Final released versions.
279
<https://launchpad.net/~bzr-beta-ppa/+archive>
280
Releases and release candidates.
282
We build packages for every supported Ubuntu release
283
<https://wiki.ubuntu.com/Releases>. Packages need no longer be updated
284
when the release passes end-of-life because all users should
285
updated by then. (As of May 2009, Edgy Eft is no longer supported.)
287
The ``debian/`` directory containing the packaging information is kept in
288
branches on Launchpad, named like
289
<https://code.launchpad.net/~bzr/bzr/packaging-hardy>.
291
Preconditions for building these packages:
293
* You must have a Launchpad account and be a member of the `~bzr`__ team
295
__ https://edge.launchpad.net/~bzr/+members>
297
* You must have a GPG key registered to your Launchpad account.
299
* Configure ``dput`` to upload to our PPA with this section in your
303
fqdn = ppa.launchpad.net
305
incoming = ~bzr-beta-ppa/ubuntu
307
allow_unsigned_uploads = 0
310
fqdn = ppa.launchpad.net
312
incoming = ~bzr/ubuntu
314
allow_unsigned_uploads = 0
316
You may also want to add these lines to prevent inadvertently attempting
317
to upload into Ubuntu or Debian, which will give a somewhat unclear
321
default_host_main = notspecified
324
fqdn = SPECIFY.A.PPA.NAME
326
* You need a Ubuntu (or probably Debian) machine, and ::
328
sudo apt-get install build-essential devscripts dput quilt patch
330
Here is the process; there are some steps which should be automated in
333
#. You will need a working directory for each supported release, such as
334
``~/bzr/Packaging/hardy``
336
#. Download the official tarball of the release to e.g. ``~/bzr/Releases``
338
#. Copy the original tarball into your per-disto directory, then untar
341
cp -l ~/bzr/Releases/bzr-1.3.tar.gz bzr_1.3.orig.tar.gz
342
tar xfvz bzr_1.3.orig.tar.gz
344
The bzrtools extracted directory does not contain a version number
345
and must be renamed::
347
mv bzrtools bzrtools-1.3.0
349
#. Change into that directory and check out the packaging branch::
353
bzr+ssh://bazaar.launchpad.net/~bzr/bzr/packaging-hardy \
356
#. For Bazaar plugins, change the ``debian/control`` file to express a
357
dependency on the correct version of ``bzr``.
359
For bzrtools this is typically::
361
Build-Depends-Indep: bzr (>= 1.3~), rsync
362
Depends: ${python:Depends}, bzr (>= 1.3~), bzr (<< 1.4~), patch
364
#. Make a new ``debian/changelog`` entry for the new release,
365
either by using ``dch`` or just editing the file::
367
dch -v '1.3-1~bazaar1' -D hardy
369
dch will default to the distro you're working in and this isn't checked
370
against the version number (which is just our conversion), so make sure
373
**Caution:** Release candidates must insert a tilde to make them sort
374
before the final release, like this: ``bzr-1.4~rc2-1~bazaar1``.
376
Make sure you have the correct email address for yourself, version
377
number, and distribution. It should look something like this::
379
bzr (1.3-1~bazaar1) hardy; urgency=low
381
* New upstream release.
383
-- John Sample <sample@example.com> Mon, 31 Mar 2008 12:36:27 +1100
385
If you need to upload the package again to fix a problem, normally you
386
should increment the last number in the version number, following the
387
distro name. Make sure not to omit the initial ``-1``, and make sure
388
that the distro name in the version is consistent with the target name
389
outside the parenthesis.
391
#. Commit these changes into the packaging branch::
393
bzr ci -m '1.3-1~bazaar1: New upstream release.' debian
395
#. Build a source package::
399
This will create a ``.changes`` file in the per-distro directory,
400
and should invoke gpg to sign it with your key.
401
Check that file is reasonable: it should be uploading to the intended
402
distribution, have a .orig file included, and the right version number.
404
#. Upload into the appropriate PPA, either ``bzr-ppa`` or
407
dput bzr-ppa ../bzr__1.3-1\~bazaar1\_source.changes
409
#. Copy the uploaded package over to other Ubuntu releases, taking advantage
410
of Launchpad's Copy Package feature <https://launchpad.net/~bzr/+archive/+copy-packages>
412
**Note:** The packaging dependencies may vary between different distro series.
413
As of bzr 1.5, Dapper uses ``python-support`` and later distributions use
415
If you upload a release-specific version, you should add a ~release1 to
416
the package version, for example:: bzr.1.3-1~bazaar1~dapper1
418
#. You should soon get an "upload accepted" mail from Launchpad, which
419
means that your package is waiting to be built. You can then track its
420
progress in <https://launchpad.net/~bzr/+archive> and
421
<https://launchpad.net/~bzr/+archive/+builds>.
423
If you add all the bzr PPAs to your ``sources.list`` then you can see a
424
summary of current package versions with::
426
apt-cache madison bzr
429
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
