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
:doc:`overall development cycle <cycle>`, 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.
47
``bzrlib/__init__.py`` file.
58
49
#. Send mail to the list with the key dates, who will be the release
59
50
manager, and the main themes or targeted bugs. Ask people to nominate
60
51
objectives, or point out any high-risk things that are best done early,
61
52
or that interact with other changes. This is called the metronome mail
62
and is described in `Development cycles <cycle.html>`_.
64
#. 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
65
70
release in a series, otherwise you should already have a branch.) ::
67
72
bzr branch trunk prepare-1.14
69
#. Configure pqm-submit for this branch, with a section like this (where
70
x.y is the version to release).
74
#. Configure pqm-submit for this branch, with a section like this in
71
75
``~/.bazaar/locations.conf``::
73
[/home/mbp/bzr/prepare-x.y]
77
[/home/mbp/bzr/prepare-1.14]
74
78
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
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
79
submit_branch = lp:bzr/2.0
80
public_branch = http://bazaar.example.com/prepare-2.0
78
81
submit_to = bazaar@lists.canonical.com
79
82
smtp_server = mail.example.com:25
96
98
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.
105
101
#. 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.
114
103
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
115
104
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
148
137
bzr 1.7rc2 2008-09-17
149
138
---------------------
152
141
=== modified file 'bzrlib/__init__.py'
153
142
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
154
143
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
155
144
@@ -41,7 +41,7 @@
156
145
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
157
146
# releaselevel of 'dev' for unreleased under-development code.
159
148
-version_info = (1, 7, 0, 'candidate', 2)
160
149
+version_info = (1, 7, 0, 'final', 0)
163
152
# API compatibility version: bzrlib is currently API compatible with 1.7.
165
154
#. 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
218
191
Publishing the release
219
192
----------------------
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
194
Now you have the beta or releasable product. The next step is making it
224
195
available to the world.
226
197
go to the release
229
200
signature. Or, if you prefer, use the
230
201
``tools/packaging/lp-upload-release`` script to do this.
232
#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and
235
#. Announce on the `Bazaar website <http://bazaar-vcs.org/>`_.
236
This page is edited via the lp:bzr-website branch. (Changes
237
pushed to this branch are refreshed by a cron job on escudero.)
239
#. 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/>`_.
241
207
#. Check that the documentation for this release is available in
242
208
<http://doc.bazaar-vcs.org>. It should be automatically build when the
259
225
``bazaar-announce`` list too.
261
227
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
262
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
228
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
264
230
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
265
231
so that people who reply to the announcement don't spam other lists.
267
233
The announce mail will look something like this::
269
235
Subject: bzr x.yy released!
271
237
<<Summary paragraph from news>>
273
The Bazaar team is happy to announce availability of a new
239
The Bazaar team is happy to announce availability of a new
274
240
release of the bzr adaptive version control system.
275
241
Bazaar is part of the GNU system <http://gnu.org/>.
277
243
Thanks to everyone who contributed patches, suggestions, and
280
Bazaar is now available for download from
281
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
282
248
for various systems will be available soon.
284
250
<<NEWS section from this release back to the last major release>>
286
252
Feel free to tweak this to your taste.
319
285
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
320
286
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.
328
288
You should also merge (not pull) the release branch into
329
289
``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
