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
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
5
release, and managing the release process. This is just one phase of the
6
`overall development cycle <http://doc.bazaar.canonical.com/developers/cycle.html>`_,
7
but it's the most complex part. This document gives a checklist you can
8
follow from start to end in one go.
12
10
If you're helping the Release Manager (RM) for one reason or another, you
13
11
may notice that he didn't follow that document scrupulously. He may have
27
25
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
28
At the start of a release cycle
81
29
===============================
93
41
the release branch.
95
43
#. If you made a new series, add milestones at
96
<https://launchpad.net/bzr/x.y/+addmilestone> to that series for
44
<https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for
97
45
the beta release, release candidate and the final release, and their
100
#. Create a new milestone <https://launchpad.net/bzr/x.y/+addmilestone>
48
#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>
101
49
and add information about this release. We will not use it yet, but it
102
50
will be available for targeting or nominating bugs.
133
81
version_info = (x, y, z, 'dev', 0)
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``.
83
#. Add a new section at the top of ``NEWS`` about the new release,
84
including its version number and the headings from
85
``NEWS-template.txt``.
145
87
#. Update the "What's New" documents in ``doc/en/whats-new``.
163
105
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
164
106
the output of ``bzr --version``.
166
For betahttps://code.edge.launchpad.net/~knittl/bzr/fix-inventory-r0/+merge/354985 releases use::
108
For beta releases use::
168
110
version_info = (2, 1, 0, 'beta', SERIAL)
180
122
version_info = (2, 1, 2, 'final', 0)
182
#. Update the ``./doc/en/release-notes/`` section for this release.
124
#. Update the ``./NEWS`` section for this release.
184
126
Fill out the date and a description of the release under the existing
185
header. If there isn't one, follow the instructions above for using the
186
``release-template.txt`` file.
127
header. If there isn't one, follow the above for using the NEWS
188
130
See *2.1.1* or similar for an example of what this looks like.
190
132
#. 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
134
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
135
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
137
./tools/check-newsbugs.py NEWS
139
(But note there will be many false positives, and this script may be
140
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
141
this slow you down too much.)
201
143
#. Commit these changes to the release branch, using a command like::
271
210
#. Now we'll try expanding this tarball and running the test suite
272
211
to check for packaging problems::
274
make check-dist-tarball | subunit2pyunit
213
make check-dist-tarball
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
215
You may encounter failures while running the test suite caused
216
by your locally installed plugins. Use your own judgment to
217
decide if you can release with these failures. When in doubt,
218
disable the faulty plugins one by one until you get no more
283
221
Remember that PQM has just tested everything too, this step is
284
222
particularly testing that the pyrex extensions, which are updated
297
235
this changes what the download widget on the Launchpad bzr home
298
236
page shows, so don't stop the release process yet, or platform binary
299
237
installers won't be made and the download list will stay very small!
300
<https://bugs.launchpad.net/launchpad/+bug/586445>
238
<https://bugs.edge.launchpad.net/launchpad/+bug/586445>
303
241
Announcing the source freeze
304
242
----------------------------
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.
244
#. Post to the ``bazaar`` list, saying that the source has been frozen.
245
This is the cue for platform maintainers and plugin authors to update
246
their code. This is done before the general public announcement of the
314
250
Kick off the next cycle
365
301
Subject: bzr x.y.z released!
303
<<Summary paragraph from news>>
367
305
The Bazaar team is happy to announce availability of a new
368
306
release of the bzr adaptive version control system.
369
307
Bazaar is part of the GNU system <http://gnu.org/>.
371
<<Summary paragraph from news>>
373
309
Thanks to everyone who contributed patches, suggestions, and
376
312
Bazaar is now available for download from
377
https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
313
https://launchpad.net/bzr/2.x/2.x/ as a source tarball; packages
378
314
for various systems will be available soon.
380
<<release notes from this release back to the last major release>>
316
<<NEWS section from this release back to the last major release>>
382
318
Feel free to tweak this to your taste.
392
328
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/>
414
331
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
415
332
be done for final releases but not for beta releases or Release Candidates.
420
337
python setup.py register
422
Remember to check the results afterwards -- this should be done for
423
final releases but not for beta releases or Release Candidates.
339
Remember to check the results afterwards.
425
341
To be able to register the release you must create an account on
426
342
<http://pypi.python.org/pypi> and have one of the existing owners of
430
346
Merging the released code back to trunk
431
347
---------------------------------------
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
349
The rule is to keep ``NEWS`` sections sorted by date. You'll need to
350
review the merge and make sure that that is respected.
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.
352
Merge the release branch back into the trunk. Check that changes in NEWS
353
were merged into the right sections. If it's not already done, advance
354
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
355
back into pqm for bzr.dev.
441
357
As soon as you change the version number in trunk, make sure you have
442
358
created the corresponding milestone to ensure the continuity in bug
added
removed
doc/developers/releasing.txt
