4
4
This document describes the processes for making and announcing a Bazaar
5
release, and managing the release process.
7
We normally have one person acting as the release manager, who
8
organizes development for the release and also actually makes the release
9
tarball and posts announcements. It can be a different person from one
12
See also: `Bazaar Developer Document Catalog <index.html>`_.
5
release, and managing the release process. This is just one phase of the
6
`overall development cycle <http://doc.bazaar-vcs.org/developers/cycle.html>`_,
7
but it's the most complex part.
8
This document gives a checklist you can follow from start to end in one
11
If you're helping the Release Manager (RM) for one reason or another, you
12
may notice that he didn't follow that document scrupulously. He may have
13
good reasons to do that but he may also have missed some parts.
15
Follow the document yourself and don't hesitate to create the missing
16
milestones for example (we tend to forget these ones a lot).
20
Our usual process is that one week before release we will make a release
21
branch from the trunk. We do one commit to that branch to change the
22
version number to 'rc1', and advance the trunk version to 'dev' for the
25
We then publish and announce this release candidate according to the
26
process below. We then have a week of general testing of the rc,
27
including some time for plugin authors to update their code for any
30
Normally no changes will be made on the release branch unless serious bugs
31
or regressions are found, and the release manager decides they should be
32
merged in. After one week, the release branch's version number is updated
33
and it's published as the final release. If regressions or serious
34
problems are discovered after the final release we may make an additional
35
point release from that branch.
37
The process or timing can vary if that seems appropriate in a particular
38
case but we try to release on a regular four week cycle.
40
The net effect is that the code gets some extra testing before release,
41
and the trunk is always open for general development.
24
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
26
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
49
32
To start a new release cycle:
34
#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
35
series for every *x.y* release.
37
#. Go to the series web page at <https://launchpad.net/bzr/x.y>
39
#. Create a new release at
40
<https://launchpad.net/bzr/x.y/+addrelease> and add
41
information about this release. We will not use it yet, but it
42
will be available for targeting or nominating bugs.
44
#. We create a new pqm-controlled branch for this release series, by
45
asking a Canonical sysadmin.
46
This branch means that from the first release beta or candidate onwards,
47
general development continues on the trunk, and only
48
specifically-targeted fixes go into the release branch.
50
#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
51
that series for the beta release, release candidate and the final release,
52
and their expected dates.
54
#. Update the version number in the ``bzr`` script, and the
55
``bzrlib/__init__.py`` file. Make sure there is always a corresponding
56
milestone when you change that version number.
58
#. Add a new section at the top of ``NEWS`` about the new release,
59
including its version number and the headings from
60
``NEWS-template.txt``.
51
62
#. Send mail to the list with the key dates, who will be the release
52
manager, and the main themes or targetted bugs. Ask people to nominate
63
manager, and the main themes or targeted bugs. Ask people to nominate
53
64
objectives, or point out any high-risk things that are best done early,
54
or that interact with other changes.
56
#. Add a new "series" in Launchpad at <https://launchpad.net/bzr/+addseries>. There is one
57
series for every *x.y* release.
63
Every week the release manager should send a mail to the Bazaar list
64
covering these points (as appropriate):
66
* Early communication about changing dependencies or defaults
68
* Reminder re lifecycle and where we're up to right now, in particular the
69
dates for the next release and/or candidate.
71
* Summary of recent successes and pending work.
73
* Reminder re release objectives
75
* Reminder re things needing attention, e.g. bug triage, reviews, testing of certain things, etc.
78
Preparing the tree for release
79
------------------------------
81
.. Was previously at http://bazaar-vcs.org/ReleaseChecklist
83
.. TODO: Still needs more clarity on what's in a RC versus a final
86
This is the procedure for making a new bzr release:
88
#. If the release is the first candidate, make a new branch in PQM.
89
(Contact Robert Collins for this step).
91
Register the branch at https://launchpad.net/products/bzr/+addbranch
93
#. Make a local branch for preparing this release. (Only for the first
65
or that interact with other changes. This is called the metronome mail
66
and is described in `Development cycles <cycle.html>`_.
68
#. Make a local branch for preparing this release. (Only for the first
94
69
release in a series, otherwise you should already have a branch.) ::
96
bzr branch trunk prepare-1.6
71
bzr branch trunk prepare-1.14
98
#. Configure pqm-submit for this branch, with a section like this in
73
#. Configure pqm-submit for this branch, with a section like this (where
74
x.y is the version to release).
99
75
``~/.bazaar/locations.conf``::
101
[/home/mbp/bzr/prepare-1.4]
77
[/home/mbp/bzr/prepare-x.y]
102
78
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
103
submit_branch = http://bazaar-vcs.org/bzr/bzr.1.4
79
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
80
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
81
public_branch = http://bazaar.example.com/prepare-x.y
104
82
submit_to = bazaar@lists.canonical.com
106
#. In the release branch, update ``version_info`` in
107
``./bzrlib/__init__.py``.
108
(This must match ``_script_version`` in the ``bzr`` script, but
109
that is updated at the start of the release cycle, and
110
doesn't need to say if it's an rc or final release.)
112
Run this command and check the output::
116
#. Add the date and release number to ``./NEWS``, and a one-paragraph
117
summary of changes in this release.
83
smtp_server = mail.example.com:25
85
Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
86
for more details on PQM
88
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
89
Make sure the corresponding milestone exists.
90
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
91
the output of ``bzr --version``.
93
For beta releases use::
95
version_info = (2, 1, 0, 'beta', 1)
98
For release candidates use::
100
version_info = (2, 0, 1, 'candidate', 1)
103
Starting the release phase
104
--------------------------
106
#. Create a new milestone at <https://launchpad.net/bzr/x.y/+addmilestone>
107
for the beta release or release candidate if you haven't already.
109
#. Add the date and release number to ``./NEWS``
111
Depending on whether you're doing a beta or a bugfix release, you'll
112
have to create a NEWS section for your release in the right
113
place. Most of the time, the new section is at the top of the file
114
(look what have been done for the various 2.0x and 2.1.0bx releases).
115
The rule is to keep the sections sorted by date. You'll need to be
116
cautious when merging back to trunk to respect that.
118
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
119
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
121
./tools/check-newsbugs.py NEWS
123
(But note there can be some false positives, and this script may be
124
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
125
this slow you down too much.)
127
#. Summarize into one or two paragraphs what's new in this release.
119
129
#. Commit these changes to the release branch, using a command like::
121
bzr commit -m "Release 0.12rc1."
131
bzr commit -m "Release 1.14."
123
133
The diff before you commit will be something like::
125
=== modified file 'NEWS'
126
--- NEWS 2006-10-23 13:11:17 +0000
127
+++ NEWS 2006-10-23 22:50:50 +0000
130
+bzr 0.12rc1 2006-10-23
135
=== modified file 'bzrlib/__init__.py'
136
--- bzrlib/__init__.py 2006-10-16 01:47:43 +0000
137
+++ bzrlib/__init__.py 2006-10-23 22:49:46 +0000
139
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
140
# releaselevel of 'dev' for unreleased under-development code.
142
-version_info = (0, 12, 0, 'dev', 0)
143
+version_info = (0, 12, 0, 'candidate', 1)
145
if version_info[3] == 'final':
146
version_string = '%d.%d.%d' % version_info[:3]
148
#. Submit those changes to PQM for merge into the appropriate release
135
=== modified file 'NEWS'
136
--- NEWS 2008-09-17 23:09:18 +0000
137
+++ NEWS 2008-09-23 16:14:54 +0000
145
+This release includes many bug fixes and a few performance and feature
146
+improvements. ``bzr rm`` will now scan for missing files and remove them,
147
+like how ``bzr add`` scans for unknown files and adds them. A bit more
148
+polish has been applied to the stacking code. The b-tree indexing code has
149
+been brought in, with an eye on using it in a future repository format.
150
+There are only minor installer changes since bzr-1.7rc2.
152
bzr 1.7rc2 2008-09-17
153
---------------------
156
=== modified file 'bzrlib/__init__.py'
157
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
158
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
160
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
161
# releaselevel of 'dev' for unreleased under-development code.
163
-version_info = (1, 7, 0, 'candidate', 2)
164
+version_info = (1, 7, 0, 'final', 0)
167
# API compatibility version: bzrlib is currently API compatible with 1.7.
169
#. Tag the new release::
173
#. Push those changes to a bzr reposistory that is public and accessible on
174
the Internet. PQM will pull from this repository when it attempts to merge
175
your changes. Then submit those changes to PQM for merge into the
176
appropriate release branch::
152
bzr pqm-submit -m "(mbp) prepare 1.6"
179
bzr pqm-submit -m "(mbp) prepare 1.14"
154
181
#. When PQM succeeds, pull down the master release branch.
158
185
-------------------------
160
187
#. Change into the source directory and run ::
164
191
#. Now we'll try expanding this tarball and running the test suite
165
192
to check for packaging problems::
167
194
make check-dist-tarball
196
You may encounter failures while running the test suite caused
197
by your locally installed plugins. Use your own judgment to
198
decide if you can release with these failures. When in doubt,
199
disable the faulty plugins one by one until you get no more
203
Publishing the source tarball
204
-----------------------------
206
#. Go to the relevant milestone page in Launchpad.
208
#. Within that release, upload the source tarball and the GPG
209
signature. Or, if you prefer, use the
210
``tools/packaging/lp-upload-release`` script to do this.
213
Announcing the source freeze
214
----------------------------
216
#. Post to the ``bazaar`` list, saying that the source has been frozen.
217
This is the cue for platform maintainers and plugin authors to update
218
their code. This is done before the general public announcement of the
170
222
Publishing the release
171
223
----------------------
173
Now you have the releasable product. The next step is making it
225
There is normally a delay of a few days after the source freeze to allow
226
for binaries to be built on various platforms. Once they have been built,
227
we have a releasable product. The next step is to make it generally
174
228
available to the world.
176
#. In <https://launchpad.net/bzr/> click the "Release series" for this
177
series, to take you to e.g. <https://launchpad.net/bzr/1.1>. Then
178
click "Register a release", and add information about this release.
180
#. Within that release, upload the source tarball and the GPG signature.
182
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
184
#. Update http://doc.bazaar-vcs.org/ to have a directory of documentation
185
for this release. (Controlled by the ``update-bzr-docs`` script on
186
escudero, and also update the ``latest`` symlink in
187
``/srv/bazaar.canonical.com/doc/``.)
189
#. Announce on the `Bazaar home page`__.
191
__ http://bazaar-vcs.org/
232
#. Within that release, upload the source tarball and zipfile and the GPG
233
signature. Or, if you prefer, use the
234
``tools/packaging/lp-upload-release`` script to do this.
236
#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and
239
#. Announce on the `Bazaar website <http://bazaar-vcs.org/>`_.
240
This page is edited via the lp:bzr-website branch. (Changes
241
pushed to this branch are refreshed by a cron job on escudero.)
243
#. Announce on the `Bazaar wiki <http://bazaar-vcs.org/Welcome>`_.
245
#. Check that the documentation for this release is available in
246
<http://doc.bazaar-vcs.org>. It should be automatically build when the
247
branch is created, by a cron script ``update-bzr-docs`` on
248
``escudero``. As of today (2009-08-27) ``igc`` manually updates the
249
pretty version of it.
194
252
Announcing the release
197
255
Now that the release is publicly available, tell people about it.
199
#. Announce to ``bazaar-announce`` and ``bazaar`` mailing lists.
200
The announce mail will look something like this:
202
| Subject: bzr 0.11 release candidate 1
204
| INTRO HERE. Mention the release number and date, and why the release. (i.e. release candidate for testing, final release of a version, backport/bugfix etc).
207
| http://bazaar-vcs.org/releases/src/bzr-VERSION.tar.gz
209
| http://bazaar-vcs.org/releases/src/bzr-VERSION.tar.gz.sig
211
| DESCRIBE-CHANGES-IN-OVERVIEW-HERE
213
| DESCRIBE-when the next release will be (if there is another - i.e. this is a release candidate)
215
| Many thanks to all the contributors to this release! I've included the
216
| contents of NEWS for VERSION below:
218
To generate the data from NEWS, just copy and paste the relevant news section and clean it up as appropriate. The main clean-up task is to confirm that all major changes are indeed covered. This can be done by running ``bzr log`` back to the point when the branch was opened and cross checking the changes against the NEWS entries.
220
(RC announcements should remind plugin maintainers to update their plugins.)
222
* For point releases (i.e. a release candidate, or an incremental fix
223
to a released version) take everything in the relevant NEWS section. For
224
example, for 0.11rc2 take everything in NEWS from the bzr 0.11rc2 line to the bzr 0.11rc1 line further down.
226
* For major releases (i.e. 0.11, 0.12 etc), take all the combined NEWS sections from within that version: for 0.11 take all of the 0.11 specific section, plus 0.11rc2, plus 0.11rc1 etc.
228
#. Update the IRC channel topic. Use the ``/topic`` command to do this, ensuring the new topic text keeps the project name, web site link, etc.
257
#. Make an announcement mail.
259
For release candidates or beta releases, this is sent to the ``bazaar``
260
list only to inform plugin authors and package or installer managers.
262
Once the installers are available, the mail can be sent to the
263
``bazaar-announce`` list too.
265
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
266
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
268
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
269
so that people who reply to the announcement don't spam other lists.
271
The announce mail will look something like this::
273
Subject: bzr x.yy released!
275
<<Summary paragraph from news>>
277
The Bazaar team is happy to announce availability of a new
278
release of the bzr adaptive version control system.
279
Bazaar is part of the GNU system <http://gnu.org/>.
281
Thanks to everyone who contributed patches, suggestions, and
284
Bazaar is now available for download from
285
http://bazaar-vcs.org/Download as a source tarball; packages
286
for various systems will be available soon.
288
<<NEWS section from this release back to the last major release>>
290
Feel free to tweak this to your taste.
292
#. Make an announcement through <https://launchpad.net/bzr/+announce>
294
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
295
ensuring the new topic text keeps the project name, web site link, etc.
230
297
#. Announce on http://freshmeat.net/projects/bzr/
232
This should be done for both release candidates and final releases. If you do not have a Freshmeat account yet, ask one of the existing admins.
234
#. Update http://en.wikipedia.org/wiki/Bzr -- this should be done for final releases but not for Release Candidates.
236
#. Package maintainers should update packages when they see the
239
#. For final releases, also send the announcement mail to
240
info-gnu@gnu.org and python-announce-list@python.org.
242
#. Also send a GNU directory update to bug-directory@gnu.org.
299
This should be done for beta releases, release candidates and final
300
releases. If you do not have a Freshmeat account yet, ask one of the
303
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
304
be done for final releases but not for beta releases or Release Candidates.
244
306
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
245
307
done by running ::
added
removed
doc/developers/releasing.txt
