4
4
This document describes the processes for making and announcing a Bazaar
5
release, and managing the release process. This is just one phase of the
6
`overall development cycle <http://doc.bazaar-vcs.org/developers/cycle.html>`_,
7
but it's the most complex part.
8
This document gives a checklist you can follow from start to end in one
5
release, and managing the release process. This is just one phase of
6
the `overall development cycle
7
<http://doc.bazaar.canonical.com/developers/cycle.html>`_, (go re-read
8
this document to ensure it hasn't been updated) but it's the most
9
complex part. This document gives a checklist you can follow from start
11
12
If you're helping the Release Manager (RM) for one reason or another, you
12
13
may notice that he didn't follow that document scrupulously. He may have
24
25
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
26
27
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
33
As of October 2010, we mantain four series. Concurrently releasing them
34
all at the same time makes it harder to shorten the delay between the
35
source availability and the package building longer than necessary (we
36
delay the official announcement until most of our users can install the new
39
In order to continue to do time-based releases, we need to plan the
40
releases by series to minimize the collisions. In the end, it's the Release
41
Manager call to decide whether he prefers to do all releases at once
42
though, so the rules presented here are a conservative approach.
44
We want to respect the following rules::
46
#. as much as possible releases should not disturb development, and
47
ongoing development should not disturb releases,
49
#. the most recent development series should release once a month during
50
the beta period (see `Development cycles <cycle.html>`_ for more
53
#. the most recent stable series should release every other month (based
54
on the amount of bug fixes, this can be shorter or longer depending on
57
#. previous series should relesase on a regular basis without interfering
58
with the most recent series with a decreasing order of priority (again
59
this should be based on bugs importance and user feedback),
61
#. the death of a series should be planned ahead of time. 6 months should
62
give enough time to our users to migrate to a more recent series. This
63
doesn't mean we will make a release at the end of the series, just that
64
before the end date we _could_ possibly put out another release if
65
there was a sufficiently important fix. Beyond that date, we won't
66
even land changes on that branch (unless something causes a miraculous
69
#. there should not be more than 2 releases in the same week (but the
70
Release Manager is free to ignore this (get in touch with packagers
73
#. the series are aligned with Ubuntu releases for convenience since we
74
create a new series every 6 months. This means that we support the
75
stable series for 18 months. Note that we also propose the most recent
76
stable series via the ppa, so whether we keep supporting LTS directly
77
or via the ppa is still an open question.
80
At the start of a release cycle
81
===============================
32
83
To start a new release cycle:
34
#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
35
series for every *x.y* release.
37
#. Go to the series web page at <https://launchpad.net/bzr/x.y>
39
#. Create a new release at
40
<https://launchpad.net/bzr/x.y/+addrelease> and add
41
information about this release. We will not use it yet, but it
85
#. If this is the first release for a given *x.y* then create a new
86
series at <https://launchpad.net/bzr/+addseries>. There is one series
87
for every *x.y* release.
89
#. If you made a new series, create a new pqm-controlled branch for this
90
release series, by asking a Canonical sysadmin. This branch means that
91
from the first release beta or candidate onwards, general development
92
continues on the trunk, and only specifically-targeted fixes go into
95
#. If you made a new series, add milestones at
96
<https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for
97
the beta release, release candidate and the final release, and their
100
#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>
101
and add information about this release. We will not use it yet, but it
42
102
will be available for targeting or nominating bugs.
44
#. We create a new pqm-controlled branch for this release series, by
45
asking a Canonical sysadmin.
46
This branch means that from the first release beta or candidate onwards,
47
general development continues on the trunk, and only
48
specifically-targeted fixes go into the release branch.
50
#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
51
that series for the beta release, release candidate and the final release,
52
and their expected dates.
54
#. Update the version number in the ``bzr`` script, and the
55
``bzrlib/__init__.py`` file. Make sure there is always a corresponding
56
milestone when you change that version number.
58
#. Add a new section at the top of ``NEWS`` about the new release,
59
including its version number and the headings from
60
``NEWS-template.txt``.
62
104
#. Send mail to the list with the key dates, who will be the release
63
105
manager, and the main themes or targeted bugs. Ask people to nominate
64
106
objectives, or point out any high-risk things that are best done early,
82
124
submit_to = bazaar@lists.canonical.com
83
125
smtp_server = mail.example.com:25
85
Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
127
Please see <http://doc.bazaar.canonical.com/developers/HACKING.html#an-overview-of-pqm>
86
128
for more details on PQM
130
#. Update the version number in the ``bzr`` script, and the
131
``bzrlib/__init__.py`` file::
133
version_info = (x, y, z, 'dev', 0)
135
#. Add a new section at the top of ``NEWS`` about the new release,
136
including its version number and the headings from
137
``NEWS-template.txt``.
139
#. Update the "What's New" documents in ``doc/en/whats-new``.
141
#. Commit this and send it to PQM.
144
Doing a particular release
145
==========================
147
Update the source code
148
----------------------
150
#. Check that there is a milestone for the release you're doing. If there
151
is no milestone it indicates a process problem - make the milestone but
152
also mail the list to raise this issue in our process. Milestones are
153
found at <https://launchpad.net/bzr/+milestone/x.y.z>.
88
155
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
89
156
Make sure the corresponding milestone exists.
90
157
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
93
160
For beta releases use::
162
version_info = (2, 1, 0, 'beta', SERIAL)
95
166
version_info = (2, 1, 0, 'beta', 1)
98
168
For release candidates use::
100
version_info = (2, 0, 1, 'candidate', 1)
103
Starting the release phase
104
--------------------------
106
#. Create a new milestone at <https://launchpad.net/bzr/x.y/+addmilestone>
107
for the beta release or release candidate if you haven't already.
109
#. Add the date and release number to ``./NEWS``
111
Depending on whether you're doing a beta or a bugfix release, you'll
112
have to create a NEWS section for your release in the right
113
place. Most of the time, the new section is at the top of the file
114
(look what have been done for the various 2.0x and 2.1.0bx releases).
115
The rule is to keep the sections sorted by date. You'll need to be
116
cautious when merging back to trunk to respect that.
170
version_info = (2, 0, 1, 'candidate', SERIAL)
172
For stable releases use::
174
version_info = (2, 1, 2, 'final', 0)
176
#. Update the ``./NEWS`` section for this release.
178
Fill out the date and a description of the release under the existing
179
header. If there isn't one, follow the above for using the NEWS
182
See *2.1.1* or similar for an example of what this looks like.
184
#. Add a summary of the release into the "What's New" document.
118
186
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
119
187
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
121
189
./tools/check-newsbugs.py NEWS
123
(But note there can be some false positives, and this script may be
191
(But note there will be many false positives, and this script may be
124
192
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
125
193
this slow you down too much.)
127
#. Summarize into one or two paragraphs what's new in this release.
129
195
#. Commit these changes to the release branch, using a command like::
131
197
bzr commit -m "Release 1.14."
199
273
disable the faulty plugins one by one until you get no more
276
Remember that PQM has just tested everything too, this step is
277
particularly testing that the pyrex extensions, which are updated
278
by your local pyrex version when you run make dist, are in good
203
282
Publishing the source tarball
204
283
-----------------------------
206
285
#. Go to the relevant milestone page in Launchpad.
208
#. Within that release, upload the source tarball and the GPG
209
signature. Or, if you prefer, use the
210
``tools/packaging/lp-upload-release`` script to do this.
287
#. Create a release of the milestone, and upload the source tarball and
288
the GPG signature. Or, if you prefer, use the
289
``tools/packaging/lp-upload-release`` script to do this. Note that
290
this changes what the download widget on the Launchpad bzr home
291
page shows, so don't stop the release process yet, or platform binary
292
installers won't be made and the download list will stay very small!
293
<https://bugs.launchpad.net/launchpad/+bug/586445>
213
296
Announcing the source freeze
214
297
----------------------------
216
#. Post to the ``bazaar`` list, saying that the source has been frozen.
217
This is the cue for platform maintainers and plugin authors to update
218
their code. This is done before the general public announcement of the
299
#. Post to the ``bazaar`` list, saying that the source has been frozen
300
(gone gold). Be extra clear that this is only a *source* release
301
targeted at packagers and installer builders (see
302
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue
303
for platform maintainers and plugin authors to update their code. This
304
is done before the general public announcement of the release.
307
Kick off the next cycle
308
-----------------------
310
#. To let developers work on the next release, do
311
`At the start of a release cycle` now.
313
#. Pause for a few days.
222
316
Publishing the release
227
321
we have a releasable product. The next step is to make it generally
228
322
available to the world.
232
#. Within that release, upload the source tarball and zipfile and the GPG
233
signature. Or, if you prefer, use the
234
``tools/packaging/lp-upload-release`` script to do this.
236
#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and
239
#. Announce on the `Bazaar website <http://bazaar-vcs.org/>`_.
324
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
326
#. Announce on the `Bazaar website <http://bazaar.canonical.com/>`_.
240
327
This page is edited via the lp:bzr-website branch. (Changes
241
328
pushed to this branch are refreshed by a cron job on escudero.)
243
#. Announce on the `Bazaar wiki <http://bazaar-vcs.org/Welcome>`_.
245
330
#. Check that the documentation for this release is available in
246
<http://doc.bazaar-vcs.org>. It should be automatically build when the
331
<http://doc.bazaar.canonical.com>. It should be automatically build when the
247
332
branch is created, by a cron script ``update-bzr-docs`` on
248
333
``escudero``. As of today (2009-08-27) ``igc`` manually updates the
249
334
pretty version of it.
271
356
The announce mail will look something like this::
273
Subject: bzr x.yy released!
275
<<Summary paragraph from news>>
358
Subject: bzr x.y.z released!
277
360
The Bazaar team is happy to announce availability of a new
278
361
release of the bzr adaptive version control system.
279
362
Bazaar is part of the GNU system <http://gnu.org/>.
364
<<Summary paragraph from news>>
281
366
Thanks to everyone who contributed patches, suggestions, and
284
369
Bazaar is now available for download from
285
http://bazaar-vcs.org/Download as a source tarball; packages
370
https://launchpad.net/bzr/2.x/2.x/ as a source tarball; packages
286
371
for various systems will be available soon.
288
373
<<NEWS section from this release back to the last major release>>
341
430
candidate, you're not finished yet. Another beta or candidate or
342
431
hopefully a final release is still to come.
344
The process is the same as for the first release. Goto `Starting the
345
release phase`_ and follow the instructions again. Some details change
433
The process is the same as for the first release. Goto `Doing a
434
particular release`_ and follow the instructions again. Some details change
346
435
between beta, candidate and final releases, but they should be
347
436
documented. If the instructions aren't clear enough, please fix them.
439
Getting the release into Ubuntu
440
-------------------------------
442
(Feel free to propose or add new sections here about what we should do to
443
get bzr into other places.)
445
For the currently-under-development release of Ubuntu, no special action
446
is needed: the release should be picked by Debian and synced from there into
449
Releases off stable bzr branches should go in to the ``-updates`` of the
450
Ubuntu release that originally contained that branch. (Ubuntu Lucid had
451
bzr 2.2.0, so should get every 2.2.x update.) This means going through
452
the `SRU (Stable Release Updates)
453
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.
455
As of September 2010, bzr has applied to the technical board to be added
456
to the `MicroReleaseExceptions
457
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
458
category so that whole bugfix releases can more easily be approved.
460
**After making a bzr stable-release release, nominate the most serious bug
461
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
463
This requires a couple of tricks (please reconsider and tweak as things
464
evolves from one release to the other):
466
* create a distro task with the ``Also affects distribution`` button and
467
select ``bzr (Ubuntu)``.
469
* change the *URL* to point to ``ubuntu/+source/bzr`` instead of ``bzr``
470
(this is needed if you create the distro task but not if it exists
471
already). You should now be able to click the ``Nominate for release``
472
button and select the right Ubuntu release. As of September 2010, this
475
* ``maverick`` for the 2.2 series,
476
* ``lucid`` for the 2.1 series,
477
* ``karmic`` for the 2.0 series.
479
* Subscribe the ``~ubuntu-sru`` team to the bug.
481
* Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
482
(we are targeting running the test suite during the build which, as of
483
September 2010, fails for known reasons that are currently addressed).
484
Search for bugs tagged with ``sru`` for examples and don't forget to tag
485
the bug you selected.
added
removed
doc/developers/releasing.txt
