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 0 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
141
#. Update ``doc/en/index.txt`` to point to the new whats-new file.
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.
143
80
At the start of a release cycle
144
81
===============================
146
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.
148
104
#. Send mail to the list with the key dates, who will be the release
149
105
manager, and the main themes or targeted bugs. Ask people to nominate
150
106
objectives, or point out any high-risk things that are best done early,
151
107
or that interact with other changes. This is called the metronome mail
152
108
and is described in `Development cycles <cycle.html>`_.
154
#. Make a local branch to prepare the release::
156
bzr branch lp:bzr/x.y x.y-dev
158
If you're doing your first beta release, branch from trunk::
160
bzr branch lp:bzr x.y-dev
162
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
165
115
#. Configure pqm-submit for this branch, with a section like this (where
166
``x.y`` is the series for your release). **Or use hydrazine for easier
167
setup** ``~/.bazaar/locations.conf``::
116
x.y is the version to release). **Or use hydrazine for easy use**
117
``~/.bazaar/locations.conf``::
169
[/home/mbp/bzr/x.y-dev]
119
[/home/mbp/bzr/prepare-x.y]
170
120
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
171
121
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
172
122
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
173
public_branch = http://bazaar.example.com/x.y-dev
123
public_branch = http://bazaar.example.com/prepare-x.y
174
124
submit_to = bazaar@lists.canonical.com
175
125
smtp_server = mail.example.com:25
207
158
also mail the list to raise this issue in our process. Milestones are
208
159
found at <https://launchpad.net/bzr/+milestone/x.y.z>.
210
#. Merge into your branch all previous stable series fixes that haven't been
211
merged yet. For example, if you're releasing 2.6.x, make sure the fixes
212
on 2.5, 2.4, 2.3, etc have already been merged up::
216
and commit that merge in its own commit. This should happen only if the
217
devs landing changes in previous releases forgot to merge them up. Since
218
this can slow down the freeze, feel free to gently remind them about
219
their duties ;) If you feel unsafe resolving the conflicts or it's too
220
time consuming, contact the related devs and skip this merge.
222
161
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
223
162
Make sure the corresponding milestone exists.
224
163
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
225
the output of ``./bzr --version``.
164
the output of ``bzr --version``.
227
166
For beta releases use::
229
version_info = (2, 6, 0, 'beta', SERIAL)
233
version_info = (2, 6, 0, 'beta', 1)
168
version_info = (2, 1, 0, 'beta', SERIAL)
172
version_info = (2, 1, 0, 'beta', 1)
174
For release candidates use::
176
version_info = (2, 0, 1, 'candidate', SERIAL)
235
178
For stable releases use::
237
version_info = (2, 6, 0, 'final', 0)
180
version_info = (2, 1, 2, 'final', 0)
239
182
#. Update the ``./doc/en/release-notes/`` section for this release.
241
Check that all news entries related to this release have been added in
242
the right section. For example, if you're releasing 2.6b2, the following
243
command should display a a single chuk diff for the 2.6b2 release::
245
bzr diff -rbzr-2.6b2.. doc/en/release-notes/bzr-2.6.txt
247
184
Fill out the date and a description of the release under the existing
248
header (the diff above will help you summarizing). If there isn't one,
249
follow the instructions above for using the ``release-template.txt`` file
250
and remind people that they should document their changes there ;)
252
See *2.6b1* or similar for an example of what this looks like.
254
#. Add or check the summary of the release into the "What's New" document.
256
If this is the first release in a new series make sure to update the
257
introduction mentioning:
259
* the date of this first release,
260
* until when the series is expected to be supported.
262
Looking at ``bzr annotate`` for previous series should give you the right
263
hints. The ``doc/en/_templates/index.html`` file should also be updated.
185
header. If there isn't one, follow the instructions above for using the
186
``release-template.txt`` file.
188
See *2.1.1* or similar for an example of what this looks like.
190
#. Add a summary of the release into the "What's New" document.
265
192
#. To check that all bugs mentioned in the release notes are actually
266
193
marked as closed in Launchpad, you can run
432
329
<https://bugs.launchpad.net/launchpad/+bug/586445>
332
Announcing the source freeze
333
----------------------------
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.
435
343
Kick off the next cycle
436
344
-----------------------
438
From that point, there is no possible return, the tarball has been uploaded
439
so you can relax a bit.
441
You're still holding a "social" lock on the launchpad branch though. Until
442
your start the next cycle, nobody should land anything on this branch. If
443
they do, they either targeted the wrong branch or didn't update the news
444
file correctly, so the sooner the branch is opened again, the better.
446
This matters more for ``lp:bzr`` than for ``lp:bzr/x.y``, ``lp:bzr`` should
447
always be open for landing, so you should do `At the start of a release
448
cycle`_ as soon as possible (i.e. update the version number in ``bzr`` and
449
``bzrlib/__init__``, create/update the news files and create/update the
450
milestone for the next relase).
452
You may also need to do `At the start of a series cycle`_ if you're starting
455
The final beta - branching and translations
456
-------------------------------------------
458
A word of caution: the instructions above works well for all releases but
459
there is one special case that requires a bit more care: when you release
460
the *last* beta for a given ``x.y`` series (from trunk aka lp:bzr), you need
461
to setup *two* branches for the next cycle:
463
#. ``lp:bzr`` needs to be opened for the next *series* ``x.(y+1)``.
465
#. ``lp:bzr/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
466
series. Since this is first real use of ``lp:bzr/x.y``, this is also the
467
deadline for the PQM branch to be created.
469
Both are important as ``lp:bzr`` should remain open so any change can be
470
landed, ``lp:bzr/x.y`` on the other hand should be ready to receive bug
473
``lp:bzr`` is generally more important as the bug fixes on ``lp:bzr/x.y``
474
won't be released sooner than a month from now whereas people may already
475
been waiting to land on ``lp:bzr``.
479
#. Open ``lp:bzr`` for ``x.(y+1)``
481
#. Create or update the ``x.y`` PQM branch based on whatever revision you
482
want to release. Since it takes time to create the PQM branch for the new
483
series you should plan to get it created a few days before you need it
484
and seed it with the revision from trunk you want to base your release of
485
(ask a LOSA for pulling this revision from trunk and pushing it to the
486
series branch (``lp:bzr/x.y``) when you're ready).
488
#. Release ``x.y.0`` from ``lp:bzr/x.y``
490
#. Open ``lp:bzr/x.y`` for bug fixes
492
You also need to ensure Launchpad is set up to import/export translations
493
for the new branch and inform translators.
495
#. Push the last beta release to a new branch::
497
bzr push lp:~bzr-core/bzr/bzr-translations-export-x.y
499
#. On the translations series synchronization settings page
500
<https://translations.launchpad.net/bzr/x.y/+translations-settings>
501
turn on ``Import template files`` then for exports click ``Choose a
502
target branch`` and point it at the branch you just pushed.
504
#. E-mail translators to announce that the forthcoming stable release of bzr
505
is ready for translations. Send to
506
``launchpad-translators@lists.launchpad.net`` and
507
``ubuntu-translators@lists.ubuntu.com``.
509
#. The series is now frozen for strings and API, see below for adding
510
that to the announcement.
512
Announcing the source freeze
513
----------------------------
515
#. Post to the ``bazaar@lists.canonical.com`` and
516
``bzr-packagers@list.launchpad.net`` lists, saying that the source has
517
been frozen. Be extra clear that this is only a *source* release targeted
518
at packagers and installer builders (see
519
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue for
520
platform maintainers and plugin authors to update their code. This is
521
done before the general public announcement of the release.
523
The freeze announcement generally guess the date of the official public
524
announcement, for the most recent stable series (the one supported by the
525
installers and most of the distributions) it's generally a few days after
526
the freeze. For older series supported only via SRUs for Ubuntu, we don't
527
control the process as tightly so guessing the date is not appropriate.
529
For the final beta release include in your announcement a notice of
530
API and translation freezes noting that public methods should not
531
be removed or changed and strings should not be added or changed.
533
#. Pause for a few days.
346
#. To let developers work on the next release, do
347
`At the start of a release cycle` now.
349
#. Pause for a few days.
536
352
Publishing the release
537
353
----------------------
539
355
There is normally a delay of a few days after the source freeze to allow
540
for binaries to be built for various platforms. Once they have been built,
356
for binaries to be built on various platforms. Once they have been built,
541
357
we have a releasable product. The next step is to make it generally
542
358
available to the world.
544
360
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
546
#. Announce on the `Bazaar website <http://bazaar.canonical.com/>`_. This
547
page is edited in ``build.py`` in the lp:bzr-website branch. (Changes
362
#. Announce on the `Bazaar website <http://bazaar.canonical.com/>`_.
363
This page is edited via the lp:bzr-website branch. (Changes
548
364
pushed to this branch are refreshed by a cron job on escudero.)
550
366
#. Check that the documentation for this release is available in
551
<http://doc.bazaar.canonical.com>. It should be automatically build when
552
the branch is created, by a cron script ``update-bzr-docs`` on
553
``escudero``. When the first release is created in a new series, a branch
554
needs to be created on zhongshan::
556
ssh zhongshan.canonical.com
558
cd /srv/doc.bazaar.canonical.com/
559
bzr branch http://bazaar.launchpad.net/~bzr-pqm/bzr/2.6 bzr/bzr.2.6
561
And the ``bzr/bin/update-bzr-docs`` script needs to refer to it.
563
The ``lp:bzr-alldocs`` branch also needs to be updated when a new series
564
is introduced, see the ``README`` file there for more instructions
565
(looking at the branch history is also a good way to understand what
566
needs to be done and to document any policy changes).
367
<http://doc.bazaar.canonical.com>. It should be automatically build when the
368
branch is created, by a cron script ``update-bzr-docs`` on
568
372
Announcing the release
569
373
----------------------
626
430
``Links`` box are edited. This should rarely change except for the URLs
627
431
related to the latest stable release.
629
* New announcement: When doing a release, put the summary of the release
630
(you can't embed URLs there, the moderation staff remove them). Users
631
can still access the releases notes via the ``Release Notes`` URL in
632
the ``Links`` box in the upper right area of the page. When doing the
633
first stable release in a series, delete the ``Unstable installers``
634
<https://launchpad.net/bzr/x.y/x.ybn> and ``Unstable source tarball``
433
* New announcement: When doing a release (beta, candidates, final), put the
434
summary of the release (you can't embed URLs there, the moderation staff
435
remove them). Users can still access the releases notes via the ``Release
436
Notes`` URL in the ``Links`` box in the upper right area of the
437
page. When doing the first stable release in a series, delete the
438
``Unstable installers`` <https://launchpad.net/bzr/x.y/x.ybn> and
439
``Unstable source tarball``
635
440
<http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
636
links. Conversely, when creating the first beta in a development
637
series, create these links again. Check all links when doing other
441
links. Conversely, when creating the first beta in a development series,
442
create these links again. Check all links when doing other kinds of
445
* Set direct download: When releasing a new stable release, this should
446
point to the corresponding launchpad page:
447
<https://launchpad.net/bzr/x.y/x.y.z/>
640
449
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
641
be done for the stable and beta releases.
450
be done for final releases but not for beta releases or Release Candidates.
643
452
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
644
453
done by running ::
646
455
python setup.py register
648
Remember to check the results afterward -- this should be done for
649
stable releases but not for beta releases nor SRUs.
457
Remember to check the results afterwards -- this should be done for
458
final releases but not for beta releases or Release Candidates.
651
460
To be able to register the release you must create an account on
652
461
<http://pypi.python.org/pypi> and have one of the existing owners of
added
removed
doc/developers/releasing.txt
