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).
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.
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
#. Make a beta release or release candidate. The milestone for this
63
candidate will already exist (see Starting a cycle above).
65
Preparing the tree for release
66
------------------------------
68
#. Make a local branch for preparing this release. (Only for the first
69
69
release in a series, otherwise you should already have a branch.) ::
71
71
bzr branch trunk prepare-1.14
77
77
[/home/mbp/bzr/prepare-x.y]
78
78
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
79
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
80
public_branch = http://bazaar.example.com/prepare-x.y
82
81
submit_to = bazaar@lists.canonical.com
83
82
smtp_server = mail.example.com:25
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``::
127
112
#. Summarize into one or two paragraphs what's new in this release.
129
114
#. Commit these changes to the release branch, using a command like::
131
bzr commit -m "Release 1.14."
116
bzr commit -m "Release 1.14."
133
118
The diff before you commit will be something like::
135
120
=== modified file 'NEWS'
136
121
--- NEWS 2008-09-17 23:09:18 +0000
137
122
+++ NEWS 2008-09-23 16:14:54 +0000
142
127
+bzr 1.7 2008-09-23
143
128
+------------------
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::
174
159
the Internet. PQM will pull from this repository when it attempts to merge
175
160
your changes. Then submit those changes to PQM for merge into the
176
161
appropriate release branch::
179
164
bzr pqm-submit -m "(mbp) prepare 1.14"
185
170
-------------------------
187
172
#. Change into the source directory and run ::
191
176
#. Now we'll try expanding this tarball and running the test suite
192
177
to check for packaging problems::
194
179
make check-dist-tarball
196
181
You may encounter failures while running the test suite caused
263
248
``bazaar-announce`` list too.
265
250
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
266
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
251
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
268
253
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
269
254
so that people who reply to the announcement don't spam other lists.
271
256
The announce mail will look something like this::
273
258
Subject: bzr x.yy released!
275
260
<<Summary paragraph from news>>
277
The Bazaar team is happy to announce availability of a new
262
The Bazaar team is happy to announce availability of a new
278
263
release of the bzr adaptive version control system.
279
264
Bazaar is part of the GNU system <http://gnu.org/>.
281
266
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
269
Bazaar is now available for download from
270
http://bazaar-vcs.org/Download as a source tarball; packages
286
271
for various systems will be available soon.
288
273
<<NEWS section from this release back to the last major release>>
290
275
Feel free to tweak this to your taste.
295
280
ensuring the new topic text keeps the project name, web site link, etc.
297
282
#. Announce on http://freshmeat.net/projects/bzr/
299
284
This should be done for beta releases, release candidates and final
300
285
releases. If you do not have a Freshmeat account yet, ask one of the
323
308
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
324
309
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
311
You should also merge (not pull) the release branch into
333
312
``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
