4
4
This document describes the processes for making and announcing a Bazaar
5
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.
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
10
16
If you're helping the Release Manager (RM) for one reason or another, you
11
17
may notice that he didn't follow that document scrupulously. He may have
12
18
good reasons to do that but he may also have missed some parts.
14
Follow the document yourself and don't hesitate to create the missing
15
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)
23
28
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
25
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.
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).
72
In order to continue to do time-based releases, we need to plan the
73
releases by series to minimize the collisions. In the end, it's the Release
74
Manager call to decide whether he prefers to do all releases at once
75
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
28
142
At the start of a release cycle
29
143
===============================
31
145
To start a new release cycle:
33
#. If this is the first release for a given *x.y* then create a new
34
series at <https://launchpad.net/bzr/+addseries>. There is one series
35
for every *x.y* release.
37
#. If you made a new series, create a new pqm-controlled branch for this
38
release series, by asking a Canonical sysadmin. This branch means that
39
from the first release beta or candidate onwards, general development
40
continues on the trunk, and only specifically-targeted fixes go into
43
#. If you made a new series, add milestones at
44
<https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for
45
the beta release, release candidate and the final release, and their
48
#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>
49
and add information about this release. We will not use it yet, but it
50
will be available for targeting or nominating bugs.
52
147
#. Send mail to the list with the key dates, who will be the release
53
148
manager, and the main themes or targeted bugs. Ask people to nominate
54
149
objectives, or point out any high-risk things that are best done early,
55
150
or that interact with other changes. This is called the metronome mail
56
151
and is described in `Development cycles <cycle.html>`_.
58
#. Make a local branch for preparing this release. (Only for the first
59
release in a series, otherwise you should already have a branch.) ::
61
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
63
164
#. Configure pqm-submit for this branch, with a section like this (where
64
x.y is the version to release). **Or use hydrazine for easy use**
65
``~/.bazaar/locations.conf``::
165
``x.y`` is the series for your release). **Or use hydrazine for easier
166
setup** ``~/.bazaar/locations.conf``::
67
[/home/mbp/bzr/prepare-x.y]
168
[/home/mbp/bzr/x.y-dev]
68
169
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
69
170
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
70
171
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
71
public_branch = http://bazaar.example.com/prepare-x.y
172
public_branch = http://bazaar.example.com/x.y-dev
72
173
submit_to = bazaar@lists.canonical.com
73
174
smtp_server = mail.example.com:25
114
232
version_info = (2, 1, 0, 'beta', 1)
116
For release candidates use::
118
version_info = (2, 0, 1, 'candidate', SERIAL)
120
234
For stable releases use::
122
236
version_info = (2, 1, 2, 'final', 0)
124
#. Update the ``./NEWS`` section for this release.
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
126
246
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
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 ;)
130
251
See *2.1.1* or similar for an example of what this looks like.
132
#. 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.)
253
#. Add or check the summary of the release into the "What's New" document.
255
#. To check that all bugs mentioned in the release notes are actually
256
marked as closed in Launchpad, you can run
257
``tools/check-newsbugs.py``::
259
./tools/check-newsbugs.py doc/en/release-notes/bzr-x.y.txt
261
As of 2011-07-18, all bugs mentioned in the output of the script requires
262
some sort of intervention (either changing the status if it's not 'Fix
263
Released' or setting a different milestone if the bug hasn't been
264
fixed). A few false positives may remain in the older series, don't let
265
this slow you down too much. This script accepts options you may find
266
useful, use ``./tools/check-newsbugs.py`` to display its usage (``-w``
267
will open each bug in your browser for example).
269
#. For beta releases update the translation template::
271
BZR_PLUGIN_PATH=-site make po/bzr.pot
273
This is especially important for the final beta release which is
274
when translations are frozen and translators are requested to make
277
#. For stable releases update the translations::
279
bzr merge lp:~bzr-core/bzr/bzr-translations-export-x.y
143
281
#. Commit these changes to the release branch, using a command like::
145
bzr commit -m "Release 1.14."
283
bzr commit -m "Release 2.3.1"
147
285
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.
287
=== modified file 'bzrlib/__init__.py'
288
--- bzrlib/__init__.py 2011-02-09 06:35:00 +0000
289
+++ bzrlib/__init__.py 2011-03-10 10:24:47 +0000
291
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
292
# releaselevel of 'dev' for unreleased under-development code.
294
-version_info = (2, 3, 1, 'dev', 0)
295
+version_info = (2, 3, 1, 'final', 0)
297
# API compatibility version
298
api_minimum_version = (2, 3, 0)
300
=== modified file 'doc/en/release-notes/bzr-2.3.txt'
301
--- doc/en/release-notes/bzr-2.3.txt 2011-03-09 08:30:16 +0000
302
+++ doc/en/release-notes/bzr-2.3.txt 2011-03-10 10:40:47 +0000
307
-:2.3.1: NOT RELEASED YET
309
-External Compatibility Breaks
310
-*****************************
312
-.. These may require users to change the way they use Bazaar.
317
-.. New commands, options, etc that users may wish to try out.
322
-.. Improvements to existing commands, especially improved performance
323
- or memory usage, or better results.
326
+This is a bugfix release. Upgrading is recommended for all users of earlier
332
=== modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
333
--- doc/en/whats-new/whats-new-in-2.3.txt 2011-02-03 16:29:18 +0000
334
+++ doc/en/whats-new/whats-new-in-2.3.txt 2011-03-10 11:10:36 +0000
336
improvements made to the core product, it highlights enhancements within the
337
broader Bazaar world of potential interest to those upgrading.
339
-Bazaar 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
340
-and 2.2, and can read and write repositories generated by all previous
341
+Bazaar 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
342
+versions that weren't included in 2.3.0 and fixes some bugs on its own.
344
+See the :doc:`../release-notes/index` for details.
346
+Bazaar 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
347
+and 2.2. It can read and write repositories generated by all previous
183
353
#. Tag the new release::
187
#. Push those changes to a bzr repository that is public and accessible on
188
the Internet. PQM will pull from this repository when it attempts to merge
189
your changes. Then submit those changes to PQM for merge into the
190
appropriate release branch::
357
#. Push those changes to a bzr branch that is public and accessible on the
358
Internet. PQM will pull from this branch when it attempts to merge your
359
changes. Then submit those changes to PQM for merge into the appropriate
193
bzr pqm-submit -m "(mbp) prepare 1.14"
363
bzr pqm-submit -m "(vila) Release 2.3.1 (Vincent Ladeuil)"
365
Note that ``bzr push`` should mention updating one tag (which you just
366
created). If it doesn't, double-check that you created (and pushed) this
195
369
Or with hydrazine::
235
419
this changes what the download widget on the Launchpad bzr home
236
420
page shows, so don't stop the release process yet, or platform binary
237
421
installers won't be made and the download list will stay very small!
238
<https://bugs.edge.launchpad.net/launchpad/+bug/586445>
241
Announcing the source freeze
242
----------------------------
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
422
<https://bugs.launchpad.net/launchpad/+bug/586445>
250
425
Kick off the next cycle
251
426
-----------------------
253
#. To let developers work on the next release, do
254
`At the start of a release cycle` now.
256
#. Pause for a few days.
428
From that point, there is no possible return, the tarball has been uploaded
429
so you can relax a bit.
431
You're still holding a "social" lock on the launchpad branch though. Until
432
your start the next cycle, nobody should land anything on this branch. If
433
they do, they either targeted the wrong branch or didn't update the news
434
file correctly, so the sooner the branch is opened again, the better.
436
This matters more for ``lp:bzr`` than for ``lp:bzr/x.y``, ``lp:bzr`` should
437
always be open for landing, so you should do `At the start of a release
438
cycle`_ as soon as possible (i.e. update the version number in ``bzr`` and
439
``bzrlib/__init__``, create/update the news files and create/update the
440
milestone for the next relase).
442
You may also need to do `At the start of a series cycle`_ if you're starting
445
The final beta - branching and translations
446
-------------------------------------------
448
A word of caution: the instructions above works well for all releases but
449
there is one special case that requires a bit more care: when you release
450
the *last* beta for a given ``x.y`` series (from trunk aka lp:bzr), you need
451
to setup *two* branches for the next cycle:
453
#. ``lp:bzr`` needs to be opened for the next *series* ``x.(y+1)``
455
#. ``lp:bzr/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
456
series. Since this is first real use of ``lp:bzr/x.y``, this is also the
457
deadline for the PQM branch to be created.
459
Both are important as ``lp:bzr`` should remain open so any change can be
460
landed, ``lp:bzr/x.y`` on the other hand should be ready to receive bug
463
``lp:bzr`` is generally more important as the bug fixes on ``lp:bzr/x.y``
464
won't be released sooner than a month from now whereas people may already
465
been waiting to land on ``lp:bzr``.
469
#. Create or update the ``x.y`` PQM branch based on whatever
470
revision you want to release
472
#. Open ``lp:bzr`` for ``x.(y+1)``
474
#. Release ``x.y.0`` from ``lp:bzr/x.y``
476
#. Open ``lp:bzr/x.y`` for bug fixes
478
You also need to ensure Launchpad is set up to import/export
479
translations for the new branch and inform translators.
483
bzr push lp:~bzr-core/bzr/bzr-translations-export-x.y
485
#. On the translations series synchronization settings page
486
<https://translations.launchpad.net/bzr/x.y/+translations-settings>
487
turn on ``Import template files`` then for exports click ``Choose a
488
target branch`` and point it at the branch you just pushed.
490
#. E-mail translators to announce that the forthcoming stable release
491
of bzr is ready for translations. Send to
492
``translators@lists.launchpad.net`` and
493
``ubuntu-translators@lists.ubuntu.com``.
495
#. The series is now frozen for strings and API, see below for adding
496
that to the announcement.
498
Announcing the source freeze
499
----------------------------
501
#. Post to the ``bazaar@lists.canonical.com`` and
502
``bzr-packagers@list.launchpad.net`` lists, saying that the source has
503
been frozen. Be extra clear that this is only a *source* release targeted
504
at packagers and installer builders (see
505
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue for
506
platform maintainers and plugin authors to update their code. This is
507
done before the general public announcement of the release.
509
The freeze announcement generally guess the date of the official public
510
announcement, for the most recent stable series (the one supported by the
511
installers and most of the distributions) it's generally a few days after
512
the freeze. For older series supported only via SRUs for Ubuntu, we don't
513
control the process as tightly so guessing the date is not appropriate.
515
For the final beta release include in your announcement a notice of
516
API and translation freezes nothing that public methods should not
517
be removed or changed and strings should not be added or changed.
519
#. Pause for a few days.
259
522
Publishing the release
301
561
Subject: bzr x.y.z released!
303
<<Summary paragraph from news>>
305
563
The Bazaar team is happy to announce availability of a new
306
564
release of the bzr adaptive version control system.
307
Bazaar is part of the GNU system <http://gnu.org/>.
566
Bazaar <http://bazaar.canonical.com/> is a Canonical project and part
567
of the GNU project <http://gnu.org/> to produce a free operating
570
<<Summary paragraph from news>>
309
572
Thanks to everyone who contributed patches, suggestions, and
312
575
Bazaar is now available for download from
313
https://launchpad.net/bzr/2.x/2.x/ as a source tarball; packages
576
https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
314
577
for various systems will be available soon.
316
<<NEWS section from this release back to the last major release>>
579
<<release notes from this release back to the last major release>>
318
581
Feel free to tweak this to your taste.
320
583
#. Make an announcement through <https://launchpad.net/bzr/+announce>
322
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
323
ensuring the new topic text keeps the project name, web site link, etc.
325
#. Announce on http://freshmeat.net/projects/bzr/
327
This should be done for beta releases, release candidates and final
328
releases. If you do not have a Freshmeat account yet, ask one of the
585
#. Announce on http://freecode.com/projects/bazaar-vcs
587
This should be done for beta releases and stable releases. If you do not
588
have a Freecode account yet, ask one of the existing admins.
590
The purpose here is to point users to the latest stable release
591
(i.e. SRUs are excluded) while still publishing announcements for beta
594
There are several kinds of modifications that could be done there via the
595
``Administration`` box in the lower right area of the page:
597
* Edit the project: This is where most of the URLs proposed in the
598
``Links`` box are edited. This should rarely change except for the URLs
599
related to the latest stable release.
601
* New announcement: When doing a release, put the summary of the release
602
(you can't embed URLs there, the moderation staff remove them). Users
603
can still access the releases notes via the ``Release Notes`` URL in
604
the ``Links`` box in the upper right area of the page. When doing the
605
first stable release in a series, delete the ``Unstable installers``
606
<https://launchpad.net/bzr/x.y/x.ybn> and ``Unstable source tarball``
607
<http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
608
links. Conversely, when creating the first beta in a development
609
series, create these links again. Check all links when doing other
612
* Set direct download: When releasing a new stable release, this should
613
point to the corresponding launchpad page:
614
<https://launchpad.net/bzr/x.y/x.y.z/>
331
616
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
332
be done for final releases but not for beta releases or Release Candidates.
617
be done for the stable and beta releases.
334
619
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
335
620
done by running ::
337
622
python setup.py register
339
Remember to check the results afterwards.
624
Remember to check the results afterward -- this should be done for
625
stable releases but not for beta releases nor SRUs.
341
627
To be able to register the release you must create an account on
342
628
<http://pypi.python.org/pypi> and have one of the existing owners of
346
632
Merging the released code back to trunk
347
633
---------------------------------------
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.
635
Merge the release branch back into the trunk. The ``doc/en/release-notes``
636
changes should be merged into the right place because each release series
637
has its own release-notes file, but double-check.
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.
639
If it's not already done, advance the version number in ``bzr`` and
640
``bzrlib/__init__.py``. Submit this back into pqm for bzr.dev.
357
642
As soon as you change the version number in trunk, make sure you have
358
643
created the corresponding milestone to ensure the continuity in bug
359
644
targeting or nominating. Depending on the change, you may even have to
360
645
create a new series (if your change the major or minor release number), in
361
that case go to `At the start of a release cycle` and follow the instructions from there.
646
that case go to `At the start of a series cycle`_ and follow the
647
instructions from there.
363
You should also merge (not pull) the release branch into
364
``lp:~bzr/bzr/current``, so that branch contains the current released code
367
650
Releases until the final one
368
651
----------------------------
370
Congratulations - you have made your first release. Have a beer
371
or fruit juice - it's on the house! If it was a beta, or
372
candidate, you're not finished yet. Another beta or candidate or
373
hopefully a final release is still to come.
653
Congratulations - you have made your first release. Have a beer or fruit
654
juice - it's on the house! If it was a beta, you're not finished
655
yet. Another beta or hopefully a stable release is still to come.
375
The process is the same as for the first release. Goto `Doing a
376
particular release`_ and follow the instructions again. Some details change
377
between beta, candidate and final releases, but they should be
378
documented. If the instructions aren't clear enough, please fix them.
657
The process is the same as for the first release. Goto `Doing a particular
658
release`_ and follow the instructions again. Some details change between
659
beta and stable releases, but they should be documented. If the instructions
660
aren't clear enough, please fix them.
381
663
Getting the release into Ubuntu
added
removed
doc/developers/releasing.txt
