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).
27
34
#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
28
35
series for every *x.y* release.
30
#. Go to the series web page at <https://launchpad.net/bzr/2.0>
37
#. Go to the series web page at <https://launchpad.net/bzr/x.y>
32
39
#. Create a new release at
33
<https://launchpad.net/bzr/2.0/+addrelease> and add
40
<https://launchpad.net/bzr/x.y/+addrelease> and add
34
41
information about this release. We will not use it yet, but it
35
42
will be available for targeting or nominating bugs.
37
44
#. We create a new pqm-controlled branch for this release series, by
38
asking a Canonical sysadmin.
45
asking a Canonical sysadmin.
39
46
This branch means that from the first release beta or candidate onwards,
40
47
general development continues on the trunk, and only
41
48
specifically-targeted fixes go into the release branch.
43
#. Add milestones at <https://edge.launchpad.net/bzr/2.0/+addmilestone> to
50
#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
44
51
that series for the beta release, release candidate and the final release,
45
52
and their expected dates.
47
54
#. Update the version number in the ``bzr`` script, and the
48
``bzrlib/__init__.py`` file.
55
``bzrlib/__init__.py`` file. Make sure there is always a corresponding
56
milestone when you change that version number.
50
58
#. Send mail to the list with the key dates, who will be the release
51
59
manager, and the main themes or targeted bugs. Ask people to nominate
52
60
objectives, or point out any high-risk things that are best done early,
53
61
or that interact with other changes. This is called the metronome mail
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
62
and is described in `Development cycles <cycle.html>`_.
64
#. Make a local branch for preparing this release. (Only for the first
71
65
release in a series, otherwise you should already have a branch.) ::
73
67
bzr branch trunk prepare-1.14
75
#. Configure pqm-submit for this branch, with a section like this in
69
#. Configure pqm-submit for this branch, with a section like this (where
70
x.y is the version to release).
76
71
``~/.bazaar/locations.conf``::
78
[/home/mbp/bzr/prepare-1.14]
73
[/home/mbp/bzr/prepare-x.y]
79
74
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
80
submit_branch = lp:bzr/2.0
81
public_branch = http://bazaar.example.com/prepare-2.0
75
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
76
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
77
public_branch = http://bazaar.example.com/prepare-x.y
82
78
submit_to = bazaar@lists.canonical.com
83
79
smtp_server = mail.example.com:25
99
96
version_info = (2, 0, 1, 'candidate', 1)
99
Starting the release phase
100
--------------------------
102
#. Create a new milestone at <https://launchpad.net/bzr/x.y/+addmilestone>
103
for the beta release or release candidate if you haven't already.
102
105
#. Add the date and release number to ``./NEWS``
107
Depending on whether you're doing a beta or a bugfix release, you'll
108
have to create a NEWS section for your release in the right
109
place. Most of the time, the new section is at the top of the file
110
(look what have been done for the various 2.0x and 2.1.0bx releases).
111
The rule is to keep the sections sorted by date. You'll need to be
112
cautious when merging back to trunk to respect that.
104
114
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
105
115
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
138
148
bzr 1.7rc2 2008-09-17
139
149
---------------------
142
152
=== modified file 'bzrlib/__init__.py'
143
153
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
144
154
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
145
155
@@ -41,7 +41,7 @@
146
156
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
147
157
# releaselevel of 'dev' for unreleased under-development code.
149
159
-version_info = (1, 7, 0, 'candidate', 2)
150
160
+version_info = (1, 7, 0, 'final', 0)
153
163
# API compatibility version: bzrlib is currently API compatible with 1.7.
155
165
#. Tag the new release::
199
Publishing the source tarball
200
-----------------------------
202
#. Go to the relevant milestone page in Launchpad.
204
#. Within that release, upload the source tarball and the GPG
205
signature. Or, if you prefer, use the
206
``tools/packaging/lp-upload-release`` script to do this.
209
Announcing the source freeze
210
----------------------------
212
#. Post to the ``bazaar`` list, saying that the source has been frozen.
213
This is the cue for platform maintainers and plugin authors to update
214
their code. This is done before the general public announcement of the
192
218
Publishing the release
193
219
----------------------
195
Now you have the beta or releasable product. The next step is making it
221
There is normally a delay of a few days after the source freeze to allow
222
for binaries to be built on various platforms. Once they have been built,
223
we have a releasable product. The next step is to make it generally
196
224
available to the world.
198
226
go to the release
231
259
``bazaar-announce`` list too.
233
261
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
234
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
262
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
236
264
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
237
265
so that people who reply to the announcement don't spam other lists.
239
267
The announce mail will look something like this::
241
269
Subject: bzr x.yy released!
243
271
<<Summary paragraph from news>>
245
The Bazaar team is happy to announce availability of a new
273
The Bazaar team is happy to announce availability of a new
246
274
release of the bzr adaptive version control system.
247
275
Bazaar is part of the GNU system <http://gnu.org/>.
249
277
Thanks to everyone who contributed patches, suggestions, and
252
Bazaar is now available for download from
253
http://bazaar-vcs.org/Download as a source tarball; packages
280
Bazaar is now available for download from
281
http://bazaar-vcs.org/Download as a source tarball; packages
254
282
for various systems will be available soon.
256
284
<<NEWS section from this release back to the last major release>>
258
286
Feel free to tweak this to your taste.
291
319
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
292
320
back into pqm for bzr.dev.
322
As soon as you change the version number in trunk, make sure you have
323
created the corresponding milestone to ensure the continuity in bug
324
targeting or nominating. Depending on the change, you may even have to
325
create a new series (if your change the major or minor release number), in
326
that case go to `Starting a cycle` and follow the instructions from there.
294
328
You should also merge (not pull) the release branch into
295
329
``lp:~bzr/bzr/current``, so that branch contains the current released code
332
Releases until the final one
333
----------------------------
335
Congratulations - you have made your first release. Have a beer
336
or fruit juice - it's on the house! If it was a beta, or
337
candidate, you're not finished yet. Another beta or candidate or
338
hopefully a final release is still to come.
340
The process is the same as for the first release. Goto `Starting the
341
release phase`_ and follow the instructions again. Some details change
342
between beta, candidate and final releases, but they should be
343
documented. If the instructions aren't clear enough, please fix them.
added
removed
doc/developers/releasing.txt
