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 <http://doc.bazaar-vcs.org/developers/cycle.html>`_,
7
but it's the most complex part.
5
release, and managing the release process. This is just one phase of the
6
`overall development cycle <cycle.html>`_, but it's the most complex part.
8
7
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).
34
26
#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
35
27
series for every *x.y* release.
37
#. Go to the series web page at <https://launchpad.net/bzr/x.y>
29
#. Go to the series web page at <https://launchpad.net/bzr/2.0>
39
31
#. Create a new release at
40
<https://launchpad.net/bzr/x.y/+addrelease> and add
32
<https://launchpad.net/bzr/2.0/+addrelease> and add
41
33
information about this release. We will not use it yet, but it
42
34
will be available for targeting or nominating bugs.
44
36
#. We create a new pqm-controlled branch for this release series, by
45
asking a Canonical sysadmin.
37
asking a Canonical sysadmin.
46
38
This branch means that from the first release beta or candidate onwards,
47
39
general development continues on the trunk, and only
48
40
specifically-targeted fixes go into the release branch.
50
#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
42
#. Add milestones at <https://edge.launchpad.net/bzr/2.0/+addmilestone> to
51
43
that series for the beta release, release candidate and the final release,
52
44
and their expected dates.
54
46
#. 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``.
47
``bzrlib/__init__.py`` file.
62
49
#. Send mail to the list with the key dates, who will be the release
63
50
manager, and the main themes or targeted bugs. Ask people to nominate
64
51
objectives, or point out any high-risk things that are best done early,
65
52
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
53
and as RM you're supposed to send other metronome mails at your rythm.
56
Starting the release phase
57
--------------------------
59
When it's time to make the first beta release or release candidate:
61
#. Create a new milestone at <https://launchpad.net/bzr/2.0/+addmilestone>
62
for the beta release or release candidate.
64
#. Make a beta release or release candidate.
66
Preparing the tree for release
67
------------------------------
69
#. Make a local branch for preparing this release. (Only for the first
69
70
release in a series, otherwise you should already have a branch.) ::
71
72
bzr branch trunk prepare-1.14
73
#. Configure pqm-submit for this branch, with a section like this (where
74
x.y is the version to release).
74
#. Configure pqm-submit for this branch, with a section like this in
75
75
``~/.bazaar/locations.conf``::
77
[/home/mbp/bzr/prepare-x.y]
77
[/home/mbp/bzr/prepare-1.14]
78
78
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
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
79
submit_branch = lp:bzr/2.0
80
public_branch = http://bazaar.example.com/prepare-2.0
82
81
submit_to = bazaar@lists.canonical.com
83
82
smtp_server = mail.example.com:25
85
Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
84
Please see <http://doc.bazaar-vcs.org/latest/developers/HACKING.html#an-overview-of-pqm>
86
85
for more details on PQM
88
87
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
89
Make sure the corresponding milestone exists.
90
88
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
91
89
the output of ``bzr --version``.
100
98
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
101
#. 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
103
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
119
104
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
152
137
bzr 1.7rc2 2008-09-17
153
138
---------------------
156
141
=== modified file 'bzrlib/__init__.py'
157
142
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
158
143
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
159
144
@@ -41,7 +41,7 @@
160
145
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
161
146
# releaselevel of 'dev' for unreleased under-development code.
163
148
-version_info = (1, 7, 0, 'candidate', 2)
164
149
+version_info = (1, 7, 0, 'final', 0)
167
152
# API compatibility version: bzrlib is currently API compatible with 1.7.
169
154
#. Tag the new release::
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
222
191
Publishing the release
223
192
----------------------
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
194
Now you have the beta or releasable product. The next step is making it
228
195
available to the world.
230
197
go to the release
233
200
signature. Or, if you prefer, use the
234
201
``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>`_.
203
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
205
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
245
207
#. Check that the documentation for this release is available in
246
208
<http://doc.bazaar-vcs.org>. It should be automatically build when the
263
225
``bazaar-announce`` list too.
265
227
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
266
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
228
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
268
230
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
269
231
so that people who reply to the announcement don't spam other lists.
271
233
The announce mail will look something like this::
273
235
Subject: bzr x.yy released!
275
237
<<Summary paragraph from news>>
277
The Bazaar team is happy to announce availability of a new
239
The Bazaar team is happy to announce availability of a new
278
240
release of the bzr adaptive version control system.
279
241
Bazaar is part of the GNU system <http://gnu.org/>.
281
243
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
246
Bazaar is now available for download from
247
http://bazaar-vcs.org/Download as a source tarball; packages
286
248
for various systems will be available soon.
288
250
<<NEWS section from this release back to the last major release>>
290
252
Feel free to tweak this to your taste.
323
285
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
324
286
back into pqm for bzr.dev.
326
As soon as you change the version number in trunk, make sure you have
327
created the corresponding milestone to ensure the continuity in bug
328
targeting or nominating. Depending on the change, you may even have to
329
create a new series (if your change the major or minor release number), in
330
that case go to `Starting a cycle` and follow the instructions from there.
332
288
You should also merge (not pull) the release branch into
333
289
``lp:~bzr/bzr/current``, so that branch contains the current released code
336
Releases until the final one
337
----------------------------
339
Congratulations - you have made your first release. Have a beer
340
or fruit juice - it's on the house! If it was a beta, or
341
candidate, you're not finished yet. Another beta or candidate or
342
hopefully a final release is still to come.
344
The process is the same as for the first release. Goto `Starting the
345
release phase`_ and follow the instructions again. Some details change
346
between beta, candidate and final releases, but they should be
347
documented. If the instructions aren't clear enough, please fix them.
added
removed
doc/developers/releasing.txt
