25
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.
28
80
At the start of a release cycle
29
81
===============================
122
180
version_info = (2, 1, 2, 'final', 0)
124
#. Update the ``./NEWS`` section for this release.
182
#. Update the ``./doc/en/release-notes/`` section for this release.
126
184
Fill out the date and a description of the release under the existing
127
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.
130
188
See *2.1.1* or similar for an example of what this looks like.
132
190
#. Add a summary of the release into the "What's New" document.
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.)
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-03-10, only a few false positives remain. Don't let this slow
143
201
#. Commit these changes to the release branch, using a command like::
145
bzr commit -m "Release 1.14."
203
bzr commit -m "Release 2.3.1"
147
205
The diff before you commit will be something like::
149
=== modified file 'NEWS'
150
--- NEWS 2008-09-17 23:09:18 +0000
151
+++ NEWS 2008-09-23 16:14:54 +0000
159
+This release includes many bug fixes and a few performance and feature
160
+improvements. ``bzr rm`` will now scan for missing files and remove them,
161
+like how ``bzr add`` scans for unknown files and adds them. A bit more
162
+polish has been applied to the stacking code. The b-tree indexing code has
163
+been brought in, with an eye on using it in a future repository format.
164
+There are only minor installer changes since bzr-1.7rc2.
166
bzr 1.7rc2 2008-09-17
167
---------------------
170
=== modified file 'bzrlib/__init__.py'
171
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
172
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
174
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
175
# releaselevel of 'dev' for unreleased under-development code.
177
-version_info = (1, 7, 0, 'candidate', 2)
178
+version_info = (1, 7, 0, 'final', 0)
181
# API compatibility version: bzrlib is currently API compatible with 1.7.
207
=== modified file 'bzrlib/__init__.py'
208
--- bzrlib/__init__.py 2011-02-09 06:35:00 +0000
209
+++ bzrlib/__init__.py 2011-03-10 10:24:47 +0000
211
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
212
# releaselevel of 'dev' for unreleased under-development code.
214
-version_info = (2, 3, 1, 'dev', 0)
215
+version_info = (2, 3, 1, 'final', 0)
217
# API compatibility version
218
api_minimum_version = (2, 3, 0)
220
=== modified file 'doc/en/release-notes/bzr-2.3.txt'
221
--- doc/en/release-notes/bzr-2.3.txt 2011-03-09 08:30:16 +0000
222
+++ doc/en/release-notes/bzr-2.3.txt 2011-03-10 10:40:47 +0000
227
-:2.3.1: NOT RELEASED YET
229
-External Compatibility Breaks
230
-*****************************
232
-.. These may require users to change the way they use Bazaar.
237
-.. New commands, options, etc that users may wish to try out.
242
-.. Improvements to existing commands, especially improved performance
243
- or memory usage, or better results.
246
+This is a bugfix release. Upgrading is recommended for all users of earlier
252
=== modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
253
--- doc/en/whats-new/whats-new-in-2.3.txt 2011-02-03 16:29:18 +0000
254
+++ doc/en/whats-new/whats-new-in-2.3.txt 2011-03-10 11:10:36 +0000
256
improvements made to the core product, it highlights enhancements within the
257
broader Bazaar world of potential interest to those upgrading.
259
-Bazaar 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
260
-and 2.2, and can read and write repositories generated by all previous
261
+Bazaar 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
262
+versions that weren't included in 2.3.0 and fixes some bugs on its own.
264
+See the :doc:`../release-notes/index` for details.
266
+Bazaar 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
267
+and 2.2. It can read and write repositories generated by all previous
183
273
#. Tag the new release::
187
277
#. Push those changes to a bzr repository that is public and accessible on
188
278
the Internet. PQM will pull from this repository when it attempts to merge
210
300
#. Now we'll try expanding this tarball and running the test suite
211
301
to check for packaging problems::
213
make check-dist-tarball
303
make check-dist-tarball | subunit2pyunit
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
305
You may encounter failures while running the test suite caused by your
306
locally installed plugins. Use your own judgment to decide if you can
307
release with these failures. When in doubt, disable the faulty plugins
308
one by one until you get no more failures. Alternatively, you can use
309
``BZR_DISABLE_PLUGINS`` or ``BZR_PLUGIN_PATH=-site`` to disable one or
221
312
Remember that PQM has just tested everything too, this step is
222
313
particularly testing that the pyrex extensions, which are updated
235
326
this changes what the download widget on the Launchpad bzr home
236
327
page shows, so don't stop the release process yet, or platform binary
237
328
installers won't be made and the download list will stay very small!
238
<https://bugs.edge.launchpad.net/launchpad/+bug/586445>
329
<https://bugs.launchpad.net/launchpad/+bug/586445>
241
332
Announcing the source freeze
242
333
----------------------------
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
335
#. Post to the ``bazaar`` list, saying that the source has been frozen
336
(gone gold). Be extra clear that this is only a *source* release
337
targeted at packagers and installer builders (see
338
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue
339
for platform maintainers and plugin authors to update their code. This
340
is done before the general public announcement of the release.
250
343
Kick off the next cycle
328
421
releases. If you do not have a Freshmeat account yet, ask one of the
424
The purpose here is to point users to the latest stable release while still
425
publishing announcements for development releases.
427
There are several kinds of modifications that could be done there via the
428
``Administration`` box in the lower right area of the page:
430
* Edit the project: This is where most of the URLs proposed in the
431
``Links`` box are edited. This should rarely change except for the URLs
432
related to the latest stable release.
434
* New announcement: When doing a release (beta, candidates, final), put the
435
summary of the release (you can't embed URLs there, the moderation staff
436
remove them). Users can still access the releases notes via the ``Release
437
Notes`` URL in the ``Links`` box in the upper right area of the
438
page. When doing the first stable release in a series, delete the
439
``Unstable installers`` <https://launchpad.net/bzr/x.y/x.ybn> and
440
``Unstable source tarball``
441
<http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
442
links. Conversely, when creating the first beta in a development series,
443
create these links again. Check all links when doing other kinds of
446
* Set direct download: When releasing a new stable release, this should
447
point to the corresponding launchpad page:
448
<https://launchpad.net/bzr/x.y/x.y.z/>
331
450
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
332
451
be done for final releases but not for beta releases or Release Candidates.
346
466
Merging the released code back to trunk
347
467
---------------------------------------
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.
469
Merge the release branch back into the trunk. The
470
``doc/en/release-notes`` changes should be merged into the right place
471
because each release series has its own release-notes file, but
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.
474
If it's not already done, advance the version number in ``bzr`` and
475
``bzrlib/__init__.py``. Submit this back into pqm for bzr.dev.
357
477
As soon as you change the version number in trunk, make sure you have
358
478
created the corresponding milestone to ensure the continuity in bug
378
498
documented. If the instructions aren't clear enough, please fix them.
501
Getting the release into Ubuntu
502
-------------------------------
504
(Feel free to propose or add new sections here about what we should do to
505
get bzr into other places.)
507
For the currently-under-development release of Ubuntu, no special action
508
is needed: the release should be picked by Debian and synced from there into
511
Releases off stable bzr branches should go in to the ``-updates`` of the
512
Ubuntu release that originally contained that branch. (Ubuntu Lucid had
513
bzr 2.2.0, so should get every 2.2.x update.) This means going through
514
the `SRU (Stable Release Updates)
515
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.
517
As of September 2010, bzr has applied to the technical board to be added
518
to the `MicroReleaseExceptions
519
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
520
category so that whole bugfix releases can more easily be approved.
522
**After making a bzr stable-release release, nominate the most serious bug
523
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
525
This requires a couple of tricks (please reconsider and tweak as things
526
evolves from one release to the other):
528
* create a distro task with the ``Also affects distribution`` button and
529
select ``bzr (Ubuntu)``.
531
* change the *URL* to point to ``ubuntu/+source/bzr`` instead of ``bzr``
532
(this is needed if you create the distro task but not if it exists
533
already). You should now be able to click the ``Nominate for release``
534
button and select the right Ubuntu release. As of September 2010, this
537
* ``maverick`` for the 2.2 series,
538
* ``lucid`` for the 2.1 series,
539
* ``karmic`` for the 2.0 series.
541
* Subscribe the ``~ubuntu-sru`` team to the bug.
543
* Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
544
(we are targeting running the test suite during the build which, as of
545
September 2010, fails for known reasons that are currently addressed).
546
Search for bugs tagged with ``sru`` for examples and don't forget to tag
547
the bug you selected.
added
removed
doc/developers/releasing.txt
