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
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
12
16
If you're helping the Release Manager (RM) for one reason or another, you
13
17
may notice that he didn't follow that document scrupulously. He may have
14
18
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)
25
28
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
27
30
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.
30
63
When do we relase ?
31
64
===================
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
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).
39
72
In order to continue to do time-based releases, we need to plan the
40
73
releases by series to minimize the collisions. In the end, it's the Release
41
74
Manager call to decide whether he prefers to do all releases at once
42
75
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.
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
80
142
At the start of a release cycle
83
145
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.
104
147
#. Send mail to the list with the key dates, who will be the release
105
148
manager, and the main themes or targeted bugs. Ask people to nominate
106
149
objectives, or point out any high-risk things that are best done early,
107
150
or that interact with other changes. This is called the metronome mail
108
151
and is described in `Development cycles <cycle.html>`_.
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
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
115
164
#. Configure pqm-submit for this branch, with a section like this (where
116
x.y is the version to release). **Or use hydrazine for easy use**
117
``~/.bazaar/locations.conf``::
165
``x.y`` is the series for your release). **Or use hydrazine for easier
166
setup** ``~/.bazaar/locations.conf``::
119
[/home/mbp/bzr/prepare-x.y]
168
[/home/mbp/bzr/x.y-dev]
120
169
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
121
170
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
122
171
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
123
public_branch = http://bazaar.example.com/prepare-x.y
172
public_branch = http://bazaar.example.com/x.y-dev
124
173
submit_to = bazaar@lists.canonical.com
125
174
smtp_server = mail.example.com:25
172
232
version_info = (2, 1, 0, 'beta', 1)
174
For release candidates use::
176
version_info = (2, 0, 1, 'candidate', SERIAL)
178
234
For stable releases use::
180
236
version_info = (2, 1, 2, 'final', 0)
182
238
#. Update the ``./doc/en/release-notes/`` section for this release.
240
Check that all news entries related to this release have been added in
241
the right section. For example, if you're releasing 2.5b2, the following
242
command should display a a single chuk diff for the 2.5b2 release::
244
bzr diff -rbzr-2.5b1.. doc/en/release-notes/bzr-2.5.txt
184
246
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.
247
header (the diff above will help you summarizing). If there isn't one,
248
follow the instructions above for using the ``release-template.txt`` file
249
and remind people that they should document their changes there ;)
188
251
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.
253
#. Add or check the summary of the release into the "What's New" document.
192
255
#. To check that all bugs mentioned in the release notes are actually
193
256
marked as closed in Launchpad, you can run
331
418
<https://bugs.launchpad.net/launchpad/+bug/586445>
334
Announcing the source freeze
335
----------------------------
337
#. Post to the ``bazaar`` list, saying that the source has been frozen
338
(gone gold). Be extra clear that this is only a *source* release
339
targeted at packagers and installer builders (see
340
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue
341
for platform maintainers and plugin authors to update their code. This
342
is done before the general public announcement of the release.
345
421
Kick off the next cycle
346
422
-----------------------
348
#. To let developers work on the next release, do
349
`At the start of a release cycle` now.
351
#. Pause for a few days.
424
From that point, there is no possible return, the tarball has been uploaded
425
so you can relax a bit.
427
You're still holding a "social" lock on the launchpad branch though. Until
428
your start the next cycle, nobody should land anything on this branch. If
429
they do, they either targeted the wrong branch or didn't update the news
430
file correctly, so the sooner the branch is opened again, the better.
432
This matters more for ``lp:bzr`` than for ``lp:bzr/x.y``, ``lp:bzr`` should
433
always be open for landing, so you should do `At the start of a release
434
cycle`_ as soon as possible (i.e. update the version number in ``bzr`` and
435
``bzrlib/__init__``, create/update the news files and create/update the
436
milestone for the next relase).
438
You may also need to do `At the start of a series cycle`_ if you're starting
441
The final beta - branching and translations
442
-------------------------------------------
444
A word of caution: the instructions above works well for all releases but
445
there is one special case that requires a bit more care: when you release
446
the *last* beta for a given ``x.y`` series (from trunk aka lp:bzr), you need
447
to setup *two* branches for the next cycle:
449
#. ``lp:bzr`` needs to be opened for the next *series* ``x.(y+1)``
451
#. ``lp:bzr/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
452
series. Since this is first real use of ``lp:bzr/x.y``, this is also the
453
deadline for the PQM branch to be created.
455
Both are important as ``lp:bzr`` should remain open so any change can be
456
landed, ``lp:bzr/x.y`` on the other hand should be ready to receive bug
459
``lp:bzr`` is generally more important as the bug fixes on ``lp:bzr/x.y``
460
won't be released sooner than a month from now whereas people may already
461
been waiting to land on ``lp:bzr``.
465
#. Create or update the ``x.y`` PQM branch based on whatever
466
revision you want to release
468
#. Open ``lp:bzr`` for ``x.(y+1)``
470
#. Release ``x.y.0`` from ``lp:bzr/x.y``
472
#. Open ``lp:bzr/x.y`` for bug fixes
474
You also need to ensure Launchpad is set up to import/export
475
translations for the new branch and inform translators.
479
bzr push lp:~bzr-core/bzr/bzr-translations-export-x.y
481
#. On the translations series synchronization settings page
482
<https://translations.launchpad.net/bzr/x.y/+translations-settings>
483
turn on ``Import template files`` then for exports click ``Choose a
484
target branch`` and point it at the branch you just pushed.
486
#. E-mail translators to announce that the forthcoming stable release
487
of bzr is ready for translations. Send to
488
``translators@lists.launchpad.net`` and
489
``ubuntu-translators@lists.ubuntu.com``.
491
#. The series is now frozen for strings and API, see below for adding
492
that to the announcement.
494
Announcing the source freeze
495
----------------------------
497
#. Post to the ``bazaar@lists.canonical.com`` list, saying that the source
498
has been frozen (gone gold). Be extra clear that this is only a *source*
499
release targeted at packagers and installer builders (see
500
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue for
501
platform maintainers and plugin authors to update their code. This is
502
done before the general public announcement of the release.
504
The freeze announcement generally guess the date of the official public
505
announcement, for the most recent stable series (the one supported by the
506
installers and most of the distributions) it's generally a few days after
507
the freeze. For older series supported only via SRUs for Ubuntu, we don't
508
control the process as tightly so guessing the date is not appropriate.
510
For the final beta release include in your announcement a notice of
511
API and translation freezes nothing that public methods should not
512
be removed or changed and strings should not be added or changed.
514
#. Pause for a few days.
354
517
Publishing the release
432
593
``Links`` box are edited. This should rarely change except for the URLs
433
594
related to the latest stable release.
435
* New announcement: When doing a release (beta, candidates, final), put the
436
summary of the release (you can't embed URLs there, the moderation staff
437
remove them). Users can still access the releases notes via the ``Release
438
Notes`` URL in the ``Links`` box in the upper right area of the
439
page. When doing the first stable release in a series, delete the
440
``Unstable installers`` <https://launchpad.net/bzr/x.y/x.ybn> and
441
``Unstable source tarball``
596
* New announcement: When doing a release, put the summary of the release
597
(you can't embed URLs there, the moderation staff remove them). Users
598
can still access the releases notes via the ``Release Notes`` URL in
599
the ``Links`` box in the upper right area of the page. When doing the
600
first stable release in a series, delete the ``Unstable installers``
601
<https://launchpad.net/bzr/x.y/x.ybn> and ``Unstable source tarball``
442
602
<http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
443
links. Conversely, when creating the first beta in a development series,
444
create these links again. Check all links when doing other kinds of
603
links. Conversely, when creating the first beta in a development
604
series, create these links again. Check all links when doing other
447
607
* Set direct download: When releasing a new stable release, this should
448
608
point to the corresponding launchpad page:
449
609
<https://launchpad.net/bzr/x.y/x.y.z/>
451
611
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
452
be done for final releases but not for beta releases or Release Candidates.
612
be done for the stable and beta releases.
454
614
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
455
615
done by running ::
457
617
python setup.py register
459
Remember to check the results afterwards -- this should be done for
460
final releases but not for beta releases or Release Candidates.
619
Remember to check the results afterward -- this should be done for
620
stable releases but not for beta releases nor SRUs.
462
622
To be able to register the release you must create an account on
463
623
<http://pypi.python.org/pypi> and have one of the existing owners of
479
638
created the corresponding milestone to ensure the continuity in bug
480
639
targeting or nominating. Depending on the change, you may even have to
481
640
create a new series (if your change the major or minor release number), in
482
that case go to `At the start of a release cycle` and follow the instructions from there.
641
that case go to `At the start of a series cycle`_ and follow the
642
instructions from there.
484
You should also merge (not pull) the release branch into
485
``lp:~bzr/bzr/current``, so that branch contains the current released code
488
645
Releases until the final one
489
646
----------------------------
491
Congratulations - you have made your first release. Have a beer
492
or fruit juice - it's on the house! If it was a beta, or
493
candidate, you're not finished yet. Another beta or candidate or
494
hopefully a final release is still to come.
648
Congratulations - you have made your first release. Have a beer or fruit
649
juice - it's on the house! If it was a beta, you're not finished
650
yet. Another beta or hopefully a stable release is still to come.
496
The process is the same as for the first release. Goto `Doing a
497
particular release`_ and follow the instructions again. Some details change
498
between beta, candidate and final releases, but they should be
499
documented. If the instructions aren't clear enough, please fix them.
652
The process is the same as for the first release. Goto `Doing a particular
653
release`_ and follow the instructions again. Some details change between
654
beta and stable releases, but they should be documented. If the instructions
655
aren't clear enough, please fix them.
502
658
Getting the release into Ubuntu
added
removed
doc/developers/releasing.txt
