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
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.
29
80
At the start of a release cycle
30
81
===============================
42
93
the release branch.
44
95
#. If you made a new series, add milestones at
45
<https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for
96
<https://launchpad.net/bzr/x.y/+addmilestone> to that series for
46
97
the beta release, release candidate and the final release, and their
49
#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>
100
#. Create a new milestone <https://launchpad.net/bzr/x.y/+addmilestone>
50
101
and add information about this release. We will not use it yet, but it
51
102
will be available for targeting or nominating bugs.
73
124
submit_to = bazaar@lists.canonical.com
74
125
smtp_server = mail.example.com:25
76
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>
77
128
for more details on PQM
79
130
#. Update the version number in the ``bzr`` script, and the
82
133
version_info = (x, y, z, 'dev', 0)
84
#. Add a new section at the top of ``NEWS`` about the new release,
85
including its version number and the headings from
86
``NEWS-template.txt``.
135
#. If you made a new series, then start a new release-notes file::
137
cd doc/en/release-notes
138
cp series-template.txt bzr-x.y.txt # e.g. bzr-2.3.txt
141
#. Add a new section at the top of the current release notes (in
142
``doc/en/release-notes``) about the new release, including its version
143
number and the headings from ``release-template.txt``.
145
#. Update the "What's New" documents in ``doc/en/whats-new``.
88
147
#. Commit this and send it to PQM.
104
163
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
105
164
the output of ``bzr --version``.
107
For beta releases use::
166
For betahttps://code.edge.launchpad.net/~knittl/bzr/fix-inventory-r0/+merge/354985 releases use::
109
168
version_info = (2, 1, 0, 'beta', SERIAL)
121
180
version_info = (2, 1, 2, 'final', 0)
123
#. Check the release number in ``./NEWS``
182
#. Update the ``./doc/en/release-notes/`` section for this release.
125
184
Fill out the date and a description of the release under the existing
126
header. If there isn't one, follow the above for using the NEWS
185
header. If there isn't one, follow the instructions above for using the
186
``release-template.txt`` file.
129
188
See *2.1.1* or similar for an example of what this looks like.
131
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
132
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
134
./tools/check-newsbugs.py NEWS
136
(But note there will be many false positives, and this script may be
137
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
138
this slow you down too much.)
190
#. Add a summary of the release into the "What's New" document.
192
#. To check that all bugs mentioned in the release notes are actually
193
marked as closed in Launchpad, you can run
194
``tools/check-newsbugs.py``::
196
./tools/check-newsbugs.py doc/en/release-notes/bzr-x.y.txt
198
(As of 2011-12-03, only a few false positives remain. Don't let this slow
140
201
#. Commit these changes to the release branch, using a command like::
207
271
#. Now we'll try expanding this tarball and running the test suite
208
272
to check for packaging problems::
210
make check-dist-tarball
274
make check-dist-tarball | subunit2pyunit
212
You may encounter failures while running the test suite caused
213
by your locally installed plugins. Use your own judgment to
214
decide if you can release with these failures. When in doubt,
215
disable the faulty plugins one by one until you get no more
276
You may encounter failures while running the test suite caused by your
277
locally installed plugins. Use your own judgment to decide if you can
278
release with these failures. When in doubt, disable the faulty plugins
279
one by one until you get no more failures. Alternatively, you can use
280
``BZR_DISABLE_PLUGINS`` or ``BZR_PLUGIN_PATH=-site`` to disable one or
218
283
Remember that PQM has just tested everything too, this step is
219
284
particularly testing that the pyrex extensions, which are updated
232
297
this changes what the download widget on the Launchpad bzr home
233
298
page shows, so don't stop the release process yet, or platform binary
234
299
installers won't be made and the download list will stay very small!
235
<https://bugs.edge.launchpad.net/launchpad/+bug/586445>
300
<https://bugs.launchpad.net/launchpad/+bug/586445>
238
303
Announcing the source freeze
239
304
----------------------------
241
#. Post to the ``bazaar`` list, saying that the source has been frozen.
242
This is the cue for platform maintainers and plugin authors to update
243
their code. This is done before the general public announcement of the
306
#. Post to the ``bazaar`` list, saying that the source has been frozen
307
(gone gold). Be extra clear that this is only a *source* release
308
targeted at packagers and installer builders (see
309
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue
310
for platform maintainers and plugin authors to update their code. This
311
is done before the general public announcement of the release.
247
314
Kick off the next cycle
264
331
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
266
#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and
269
#. Announce on the `Bazaar website <http://bazaar-vcs.org/>`_.
333
#. Announce on the `Bazaar website <http://bazaar.canonical.com/>`_.
270
334
This page is edited via the lp:bzr-website branch. (Changes
271
335
pushed to this branch are refreshed by a cron job on escudero.)
273
#. Announce on the `Bazaar wiki <http://bazaar-vcs.org/Welcome>`_.
275
337
#. Check that the documentation for this release is available in
276
<http://doc.bazaar-vcs.org>. It should be automatically build when the
338
<http://doc.bazaar.canonical.com>. It should be automatically build when the
277
339
branch is created, by a cron script ``update-bzr-docs`` on
278
340
``escudero``. As of today (2009-08-27) ``igc`` manually updates the
279
341
pretty version of it.
303
365
Subject: bzr x.y.z released!
305
<<Summary paragraph from news>>
307
367
The Bazaar team is happy to announce availability of a new
308
368
release of the bzr adaptive version control system.
309
369
Bazaar is part of the GNU system <http://gnu.org/>.
371
<<Summary paragraph from news>>
311
373
Thanks to everyone who contributed patches, suggestions, and
314
376
Bazaar is now available for download from
315
http://bazaar-vcs.org/Download as a source tarball; packages
377
https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
316
378
for various systems will be available soon.
318
<<NEWS section from this release back to the last major release>>
380
<<release notes from this release back to the last major release>>
320
382
Feel free to tweak this to your taste.
330
392
releases. If you do not have a Freshmeat account yet, ask one of the
395
The purpose here is to point users to the latest stable release while still
396
publishing announcements for development releases.
398
There are several kinds of modifications that could be done there via the
399
``Administration`` box in the lower right area of the page:
401
* Edit the project: This is where most of the URLs proposed in the
402
``Links`` box are edited. This should rarely change except for the URLs
403
related to the latest stable release.
405
* New announcement: When doing a release (beta, candidates, final), put the
406
summary of the release (you can't embed URLs there, the moderation staff
407
remove them). Users can still access the releases notes via the ``Release
408
Notes`` URL in the ``Links`` box in the upper right area of the page.
410
* Set direct download: When releasing a new stable release, this should
411
point to the corresponding launchpad page:
412
<https://launchpad.net/bzr/x.y/x.y.z/>
333
414
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
334
415
be done for final releases but not for beta releases or Release Candidates.
339
420
python setup.py register
341
Remember to check the results afterwards.
422
Remember to check the results afterwards -- this should be done for
423
final releases but not for beta releases or Release Candidates.
343
425
To be able to register the release you must create an account on
344
426
<http://pypi.python.org/pypi> and have one of the existing owners of
348
430
Merging the released code back to trunk
349
431
---------------------------------------
351
The rule is to keep ``NEWS`` sections sorted by date. You'll need to
352
review the merge and make sure that that is respected.
433
Merge the release branch back into the trunk. The
434
``doc/en/release-notes`` changes should be merged into the right place
435
because each release series has its own release-notes file, but
354
Merge the release branch back into the trunk. Check that changes in NEWS
355
were merged into the right sections. If it's not already done, advance
356
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
357
back into pqm for bzr.dev.
438
If it's not already done, advance the version number in ``bzr`` and
439
``bzrlib/__init__.py``. Submit this back into pqm for bzr.dev.
359
441
As soon as you change the version number in trunk, make sure you have
360
442
created the corresponding milestone to ensure the continuity in bug
380
462
documented. If the instructions aren't clear enough, please fix them.
465
Getting the release into Ubuntu
466
-------------------------------
468
(Feel free to propose or add new sections here about what we should do to
469
get bzr into other places.)
471
For the currently-under-development release of Ubuntu, no special action
472
is needed: the release should be picked by Debian and synced from there into
475
Releases off stable bzr branches should go in to the ``-updates`` of the
476
Ubuntu release that originally contained that branch. (Ubuntu Lucid had
477
bzr 2.2.0, so should get every 2.2.x update.) This means going through
478
the `SRU (Stable Release Updates)
479
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.
481
As of September 2010, bzr has applied to the technical board to be added
482
to the `MicroReleaseExceptions
483
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
484
category so that whole bugfix releases can more easily be approved.
486
**After making a bzr stable-release release, nominate the most serious bug
487
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
489
This requires a couple of tricks (please reconsider and tweak as things
490
evolves from one release to the other):
492
* create a distro task with the ``Also affects distribution`` button and
493
select ``bzr (Ubuntu)``.
495
* change the *URL* to point to ``ubuntu/+source/bzr`` instead of ``bzr``
496
(this is needed if you create the distro task but not if it exists
497
already). You should now be able to click the ``Nominate for release``
498
button and select the right Ubuntu release. As of September 2010, this
501
* ``maverick`` for the 2.2 series,
502
* ``lucid`` for the 2.1 series,
503
* ``karmic`` for the 2.0 series.
505
* Subscribe the ``~ubuntu-sru`` team to the bug.
507
* Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
508
(we are targeting running the test suite during the build which, as of
509
September 2010, fails for known reasons that are currently addressed).
510
Search for bugs tagged with ``sru`` for examples and don't forget to tag
511
the bug you selected.
added
removed
doc/developers/releasing.txt
