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
7
<http://doc.bazaar.canonical.com/developers/cycle.html>`_, (go re-read this
8
document to ensure it hasn't been updated since you last read it) but it's
11
If you're doing your first release you can follow this document and read
12
each step explanation. It's also a good practice to read it for any release
13
to ensure you don't miss a step and to update it as the release process
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
16
12
If you're helping the Release Manager (RM) for one reason or another, you
17
13
may notice that he didn't follow that document scrupulously. He may have
18
14
good reasons to do that but he may also have missed some parts.
16
Follow the document yourself and don't hesitate to create the missing
17
milestones for example (we tend to forget these ones a lot).
26
#. PQM access rights (or you won't be able to land any change)
28
25
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
30
27
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
32
#. Alternatively, you can download and install ``lp:hydrazine`` (the main
33
difference is that hydrazine requires the branch to land to be hosted on
39
In this document, we're talking about source releases only, packages and
40
installers are built from this but we won't talk about them here.
42
Every release is part of a series, ``bzr-2.4.1`` is part of series ``2.4``.
44
We do two different kind of releases: the betas releases and the stable
45
releases for a given series.
47
For a given series, releases will be done to deliver new versions of bzr to
48
different kinds of users:
50
#. beta releases: named ``x.ybn`` where ``x.y`` is the series and ``n``
51
starts at 1 and is incremented. These releases are targeted to beta
52
testers who don't want to run from source but are interested in features
55
#. stable releases: name ``x.y.z`` where ``x.y.`` is the series and ``z``
56
starts at 1 and is incremented. These releases are targeted at people
57
that want bugfixes only and no new features.
60
Differences in the release process between beta and stable release will be
61
mentioned when needed.
63
30
When do we relase ?
64
31
===================
66
As of July 2011, we maintain four series (and one that is about to be EOLed).
67
Concurrently releasing them all at the same time makes it harder to shorten
68
the delay between the source availability and the package building longer
69
than necessary (we delay the official announcement until most of our users
70
can install the new release).
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
72
39
In order to continue to do time-based releases, we need to plan the
73
40
releases by series to minimize the collisions. In the end, it's the Release
74
41
Manager call to decide whether he prefers to do all releases at once
75
42
though, so the rules presented here are a conservative approach.
77
We want to respect the following rules:
79
#. as much as possible releases should not disturb development, and
80
ongoing development should not disturb releases,
82
#. the most recent development series should release once a month during
83
the beta period (see `Development cycles <cycle.html>`_ for more
86
#. the most recent stable series should release every other month (based
87
on the amount of bug fixes, this can be shorter or longer depending on
90
#. previous series should release on a regular basis without interfering
91
with the most recent series with a decreasing order of priority (again
92
this should be based on bugs importance and user feedback),
94
#. the death of a series should be planned ahead of time. 6 months should
95
give enough time to our users to migrate to a more recent series. This
96
doesn't mean we will make a release at the end of the series, just that
97
before the end date we *could* possibly put out another release if
98
there was a sufficiently important fix. Beyond that date, we won't
99
even land changes on that branch (unless something causes a miraculous
102
#. there should not be more than 2 releases in the same week (but the
103
Release Manager is free to ignore this (get in touch with packagers
106
#. the series are aligned with Ubuntu releases for convenience since we
107
create a new series every 6 months. This means that we support the
108
stable series for 18 months. Note that we also propose the most recent
109
stable series via the stable PPA but that the SRU processs allow us to
110
reach a wider audience.
112
At the start of a series cycle
113
==============================
115
To start a new series cycle:
117
#. Create a new series ``x.y`` at <https://launchpad.net/bzr/+addseries>.
119
#. Add milestones at <https://launchpad.net/bzr/x.y/+addmilestone> to that
120
series for the beta releases and the stable series mentioning their
121
expected dates. Only the milestone associated to the next release in
122
this series should be left active to avoid clutter when targeting bugs.
124
#. If you made a new series, you will need to create a new pqm-controlled
125
branch for this release series. This branch will be used only from the
126
first non-beta release onwards. It needs to be created by a Canonical
127
sysadmin (ask the core devs for instructions or to do it for you).
129
#. Start a new release-notes file::
131
cd doc/en/release-notes
132
cp series-template.txt bzr-x.y.txt # e.g. bzr-2.3.txt
135
#. Start a new whats-new file::
138
cp template.txt bzr-x.y.txt # e.g. bzr-2.6.txt
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.
142
80
At the start of a release cycle
145
83
To start a new release cycle:
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://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://launchpad.net/bzr/x.y/+addmilestone>
101
and add information about this release. We will not use it yet, but it
102
will be available for targeting or nominating bugs.
147
104
#. Send mail to the list with the key dates, who will be the release
148
105
manager, and the main themes or targeted bugs. Ask people to nominate
149
106
objectives, or point out any high-risk things that are best done early,
150
107
or that interact with other changes. This is called the metronome mail
151
108
and is described in `Development cycles <cycle.html>`_.
153
#. Make a local branch to prepare the release::
155
bzr branch lp:bzr/x.y x.y-dev
157
If you're doing your first beta release, branch from trunk::
159
bzr branch lp:bzr x.y-dev
161
Note that you will generally reuse the same branch for all releases in a
110
#. Make a local branch for preparing this release. (Only for the first
111
release in a series, otherwise you should already have a branch.) ::
113
bzr branch trunk prepare-1.14
164
115
#. Configure pqm-submit for this branch, with a section like this (where
165
``x.y`` is the series for your release). **Or use hydrazine for easier
166
setup** ``~/.bazaar/locations.conf``::
116
x.y is the version to release). **Or use hydrazine for easy use**
117
``~/.bazaar/locations.conf``::
168
[/home/mbp/bzr/x.y-dev]
119
[/home/mbp/bzr/prepare-x.y]
169
120
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
170
121
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
171
122
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
172
public_branch = http://bazaar.example.com/x.y-dev
123
public_branch = http://bazaar.example.com/prepare-x.y
173
124
submit_to = bazaar@lists.canonical.com
174
125
smtp_server = mail.example.com:25
240
196
./tools/check-newsbugs.py doc/en/release-notes/bzr-x.y.txt
242
As of 2011-07-18, all bugs mentioned in the output of the script requires
243
some sort of intervention (either changing the status if it's not 'Fix
244
Released' or setting a different milestone if the bug hasn't been
245
fixed). A few false positives may remain in the older series, don't let
246
this slow you down too much. This script accepts options you may find
247
useful, use ``./tools/check-newsbugs.py`` to display its usage (``-w``
248
will open each bug in your browser for example).
250
#. For beta releases update the translation template::
254
This is especially important for the final beta release which is
255
when translations are frozen and translators are requested to make
258
#. For stable releases update the translations::
260
bzr merge lp:~bzr-core/bzr/bzr-translations-export-x.y
198
(As of 2011-12-03, only a few false positives remain. Don't let this slow
262
201
#. Commit these changes to the release branch, using a command like::
264
bzr commit -m "Release 2.3.1"
203
bzr commit -m "Release 1.14."
266
205
The diff before you commit will be something like::
268
=== modified file 'bzrlib/__init__.py'
269
--- bzrlib/__init__.py 2011-02-09 06:35:00 +0000
270
+++ bzrlib/__init__.py 2011-03-10 10:24:47 +0000
272
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
273
# releaselevel of 'dev' for unreleased under-development code.
275
-version_info = (2, 3, 1, 'dev', 0)
276
+version_info = (2, 3, 1, 'final', 0)
278
# API compatibility version
279
api_minimum_version = (2, 3, 0)
281
=== modified file 'doc/en/release-notes/bzr-2.3.txt'
282
--- doc/en/release-notes/bzr-2.3.txt 2011-03-09 08:30:16 +0000
283
+++ doc/en/release-notes/bzr-2.3.txt 2011-03-10 10:40:47 +0000
288
-:2.3.1: NOT RELEASED YET
290
-External Compatibility Breaks
291
-*****************************
293
-.. These may require users to change the way they use Bazaar.
298
-.. New commands, options, etc that users may wish to try out.
303
-.. Improvements to existing commands, especially improved performance
304
- or memory usage, or better results.
307
+This is a bugfix release. Upgrading is recommended for all users of earlier
313
=== modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
314
--- doc/en/whats-new/whats-new-in-2.3.txt 2011-02-03 16:29:18 +0000
315
+++ doc/en/whats-new/whats-new-in-2.3.txt 2011-03-10 11:10:36 +0000
317
improvements made to the core product, it highlights enhancements within the
318
broader Bazaar world of potential interest to those upgrading.
320
-Bazaar 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
321
-and 2.2, and can read and write repositories generated by all previous
322
+Bazaar 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
323
+versions that weren't included in 2.3.0 and fixes some bugs on its own.
325
+See the :doc:`../release-notes/index` for details.
327
+Bazaar 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
328
+and 2.2. It can read and write repositories generated by all previous
207
=== modified file 'NEWS'
208
--- NEWS 2008-09-17 23:09:18 +0000
209
+++ NEWS 2008-09-23 16:14:54 +0000
217
+This release includes many bug fixes and a few performance and feature
218
+improvements. ``bzr rm`` will now scan for missing files and remove them,
219
+like how ``bzr add`` scans for unknown files and adds them. A bit more
220
+polish has been applied to the stacking code. The b-tree indexing code has
221
+been brought in, with an eye on using it in a future repository format.
222
+There are only minor installer changes since bzr-1.7rc2.
224
bzr 1.7rc2 2008-09-17
225
---------------------
228
=== modified file 'bzrlib/__init__.py'
229
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
230
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
232
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
233
# releaselevel of 'dev' for unreleased under-development code.
235
-version_info = (1, 7, 0, 'candidate', 2)
236
+version_info = (1, 7, 0, 'final', 0)
239
# API compatibility version: bzrlib is currently API compatible with 1.7.
241
Note that the NEWS file formatting has evolved, this example needs to
334
244
#. Tag the new release::
338
#. Push those changes to a bzr branch that is public and accessible on the
339
Internet. PQM will pull from this branch when it attempts to merge your
340
changes. Then submit those changes to PQM for merge into the appropriate
248
#. Push those changes to a bzr repository that is public and accessible on
249
the Internet. PQM will pull from this repository when it attempts to merge
250
your changes. Then submit those changes to PQM for merge into the
251
appropriate release branch::
344
bzr pqm-submit -m "(vila) Release 2.3.1 (Vincent Ladeuil)"
254
bzr pqm-submit -m "(mbp) Release 1.14 (Martin Pool)"
346
256
Or with hydrazine::
399
300
<https://bugs.launchpad.net/launchpad/+bug/586445>
303
Announcing the source freeze
304
----------------------------
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.
402
314
Kick off the next cycle
403
315
-----------------------
405
From that point, there is no possible return, the tarball has been uploaded
406
so you can relax a bit.
408
You're still holding a "social" lock on the launchpad branch though. Until
409
your start the next cycle, nobody should land anything on this branch. If
410
they do, they either targeted the wrong branch or didn't update the news
411
file correctly, so the sooner the branch is opened again, the better.
413
This matters more for ``lp:bzr`` than for ``lp:bzr/x.y``, ``lp:bzr`` should
414
always be open for landing, so you should do `At the start of a release
415
cycle`_ as soon as possible (i.e. update the version number in ``bzr`` and
416
``bzrlib/__init__``, create/update the news files and create/update the
417
milestone for the next relase).
419
You may also need to do `At the start of a series cycle`_ if you're starting
422
The final beta - branching and translations
423
-------------------------------------------
425
A word of caution: the instructions above works well for all releases but
426
there is one special case that requires a bit more care: when you release
427
the *last* beta for a given ``x.y`` series (from trunk aka lp:bzr), you need
428
to setup *two* branches for the next cycle:
430
#. ``lp:bzr`` needs to be opened for the next *series* ``x.(y+1)``
432
#. ``lp:bzr/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
433
series. Since this is first real use of ``lp:bzr/x.y``, this is also the
434
deadline for the PQM branch to be created.
436
Both are important as ``lp:bzr`` should remain open so any change can be
437
landed, ``lp:bzr/x.y`` on the other hand should be ready to receive bug
440
``lp:bzr`` is generally more important as the bug fixes on ``lp:bzr/x.y``
441
won't be released sooner than a month from now whereas people may already
442
been waiting to land on ``lp:bzr``.
446
#. Create or update the ``x.y`` PQM branch based on whatever
447
revision you want to release
449
#. Open ``lp:bzr`` for ``x.(y+1)``
451
#. Release ``x.y.0`` from ``lp:bzr/x.y``
453
#. Open ``lp:bzr/x.y`` for bug fixes
455
You also need to ensure Launchpad is set up to import/export
456
translations for the new branch and inform translators.
460
bzr push lp:~bzr-core/bzr/bzr-translations-export-x.y
462
#. On the translations series synchronization settings page
463
<https://translations.launchpad.net/bzr/x.y/+translations-settings>
464
turn on ``Import template files`` then for exports click ``Choose a
465
target branch`` and point it at the branch you just pushed.
467
#. E-mail translators to announce that the forthcoming stable release
468
of bzr is ready for translations. Send to
469
``translators@lists.launchpad.net`` and
470
``ubuntu-translators@lists.ubuntu.com``.
472
#. The series is now frozen for strings and API, see below for adding
473
that to the announcement.
475
Announcing the source freeze
476
----------------------------
478
#. Post to the ``bazaar@lists.canonical.com`` list, saying that the source
479
has been frozen (gone gold). Be extra clear that this is only a *source*
480
release targeted at packagers and installer builders (see
481
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue for
482
platform maintainers and plugin authors to update their code. This is
483
done before the general public announcement of the release.
485
The freeze announcement generally guess the date of the official public
486
announcement, for the most recent stable series (the one supported by the
487
installers and most of the distributions) it's generally a few days after
488
the freeze. For older series supported only via SRUs for Ubuntu, we don't
489
control the process as tightly so guessing the date is not appropriate.
491
For the final beta release include in your announcement a notice of
492
API and translation freezes nothing that public methods should not
493
be removed or changed and strings should not be added or changed.
495
#. Pause for a few days.
317
#. To let developers work on the next release, do
318
`At the start of a release cycle` now.
320
#. Pause for a few days.
498
323
Publishing the release
574
402
``Links`` box are edited. This should rarely change except for the URLs
575
403
related to the latest stable release.
577
* New announcement: When doing a release, put the summary of the release
578
(you can't embed URLs there, the moderation staff remove them). Users
579
can still access the releases notes via the ``Release Notes`` URL in
580
the ``Links`` box in the upper right area of the page. When doing the
581
first stable release in a series, delete the ``Unstable installers``
582
<https://launchpad.net/bzr/x.y/x.ybn> and ``Unstable source tarball``
583
<http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
584
links. Conversely, when creating the first beta in a development
585
series, create these links again. Check all links when doing other
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.
588
410
* Set direct download: When releasing a new stable release, this should
589
411
point to the corresponding launchpad page:
590
412
<https://launchpad.net/bzr/x.y/x.y.z/>
592
414
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
593
be done for the stable and beta releases.
415
be done for final releases but not for beta releases or Release Candidates.
595
417
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
596
418
done by running ::
598
420
python setup.py register
600
Remember to check the results afterward -- this should be done for
601
stable releases but not for beta releases nor SRUs.
422
Remember to check the results afterwards -- this should be done for
423
final releases but not for beta releases or Release Candidates.
603
425
To be able to register the release you must create an account on
604
426
<http://pypi.python.org/pypi> and have one of the existing owners of
619
442
created the corresponding milestone to ensure the continuity in bug
620
443
targeting or nominating. Depending on the change, you may even have to
621
444
create a new series (if your change the major or minor release number), in
622
that case go to `At the start of a series cycle`_ and follow the
623
instructions from there.
445
that case go to `At the start of a release cycle` and follow the instructions from there.
447
You should also merge (not pull) the release branch into
448
``lp:~bzr/bzr/current``, so that branch contains the current released code
626
451
Releases until the final one
627
452
----------------------------
629
Congratulations - you have made your first release. Have a beer or fruit
630
juice - it's on the house! If it was a beta, you're not finished
631
yet. Another beta or hopefully a stable release is still to come.
454
Congratulations - you have made your first release. Have a beer
455
or fruit juice - it's on the house! If it was a beta, or
456
candidate, you're not finished yet. Another beta or candidate or
457
hopefully a final release is still to come.
633
The process is the same as for the first release. Goto `Doing a particular
634
release`_ and follow the instructions again. Some details change between
635
beta and stable releases, but they should be documented. If the instructions
636
aren't clear enough, please fix them.
459
The process is the same as for the first release. Goto `Doing a
460
particular release`_ and follow the instructions again. Some details change
461
between beta, candidate and final releases, but they should be
462
documented. If the instructions aren't clear enough, please fix them.
639
465
Getting the release into Ubuntu
added
removed
doc/developers/releasing.txt
