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
5
release, and managing the release process. This is just one phase of the
6
6
`overall development cycle <http://doc.bazaar-vcs.org/developers/cycle.html>`_,
7
7
but it's the most complex part.
8
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).
34
27
#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
35
28
series for every *x.y* release.
37
#. Go to the series web page at <https://launchpad.net/bzr/x.y>
30
#. Go to the series web page at <https://launchpad.net/bzr/2.0>
39
32
#. Create a new release at
40
<https://launchpad.net/bzr/x.y/+addrelease> and add
33
<https://launchpad.net/bzr/2.0/+addrelease> and add
41
34
information about this release. We will not use it yet, but it
42
35
will be available for targeting or nominating bugs.
44
37
#. We create a new pqm-controlled branch for this release series, by
45
asking a Canonical sysadmin.
38
asking a Canonical sysadmin.
46
39
This branch means that from the first release beta or candidate onwards,
47
40
general development continues on the trunk, and only
48
41
specifically-targeted fixes go into the release branch.
50
#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
43
#. Add milestones at <https://edge.launchpad.net/bzr/2.0/+addmilestone> to
51
44
that series for the beta release, release candidate and the final release,
52
45
and their expected dates.
54
47
#. 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``.
48
``bzrlib/__init__.py`` file.
62
50
#. Send mail to the list with the key dates, who will be the release
63
51
manager, and the main themes or targeted bugs. Ask people to nominate
64
52
objectives, or point out any high-risk things that are best done early,
65
53
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
54
and as RM you're supposed to send other metronome mails at your rythm.
57
Starting the release phase
58
--------------------------
60
When it's time to make the first beta release or release candidate:
62
#. Create a new milestone at <https://launchpad.net/bzr/2.0/+addmilestone>
63
for the beta release or release candidate.
65
#. Make a beta release or release candidate.
67
Preparing the tree for release
68
------------------------------
70
#. Make a local branch for preparing this release. (Only for the first
69
71
release in a series, otherwise you should already have a branch.) ::
71
73
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).
75
#. Configure pqm-submit for this branch, with a section like this in
75
76
``~/.bazaar/locations.conf``::
77
[/home/mbp/bzr/prepare-x.y]
78
[/home/mbp/bzr/prepare-1.14]
78
79
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
80
submit_branch = lp:bzr/2.0
81
public_branch = http://bazaar.example.com/prepare-2.0
82
82
submit_to = bazaar@lists.canonical.com
83
83
smtp_server = mail.example.com:25
100
99
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
102
#. 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
104
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
119
105
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
152
138
bzr 1.7rc2 2008-09-17
153
139
---------------------
156
142
=== modified file 'bzrlib/__init__.py'
157
143
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
158
144
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
159
145
@@ -41,7 +41,7 @@
160
146
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
161
147
# releaselevel of 'dev' for unreleased under-development code.
163
149
-version_info = (1, 7, 0, 'candidate', 2)
164
150
+version_info = (1, 7, 0, 'final', 0)
167
153
# API compatibility version: bzrlib is currently API compatible with 1.7.
169
155
#. 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
192
Publishing the release
223
193
----------------------
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
195
Now you have the beta or releasable product. The next step is making it
228
196
available to the world.
230
198
go to the release
263
231
``bazaar-announce`` list too.
265
233
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
266
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
234
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
268
236
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
269
237
so that people who reply to the announcement don't spam other lists.
271
239
The announce mail will look something like this::
273
241
Subject: bzr x.yy released!
275
243
<<Summary paragraph from news>>
277
The Bazaar team is happy to announce availability of a new
245
The Bazaar team is happy to announce availability of a new
278
246
release of the bzr adaptive version control system.
279
247
Bazaar is part of the GNU system <http://gnu.org/>.
281
249
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
252
Bazaar is now available for download from
253
http://bazaar-vcs.org/Download as a source tarball; packages
286
254
for various systems will be available soon.
288
256
<<NEWS section from this release back to the last major release>>
290
258
Feel free to tweak this to your taste.
323
291
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
324
292
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
294
You should also merge (not pull) the release branch into
333
295
``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
