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).
24
17
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
26
19
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
29
At the start of a release cycle
30
===============================
32
25
To start a new release cycle:
34
#. If this is the first release for a given *x.y* then create a new
35
series at <https://launchpad.net/bzr/+addseries>. There is one series
36
for every *x.y* release.
38
#. If you made a new series, create a new pqm-controlled branch for this
39
release series, by asking a Canonical sysadmin. This branch means that
40
from the first release beta or candidate onwards, general development
41
continues on the trunk, and only specifically-targeted fixes go into
44
#. If you made a new series, add milestones at
45
<https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for
46
the beta release, release candidate and the final release, and their
49
#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>
50
and add information about this release. We will not use it yet, but it
27
#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
28
series for every *x.y* release.
30
#. Go to the series web page at <https://launchpad.net/bzr/2.0>
32
#. Create a new release at
33
<https://launchpad.net/bzr/2.0/+addrelease> and add
34
information about this release. We will not use it yet, but it
51
35
will be available for targeting or nominating bugs.
37
#. We create a new pqm-controlled branch for this release series, by
38
asking a Canonical sysadmin.
39
This branch means that from the first release beta or candidate onwards,
40
general development continues on the trunk, and only
41
specifically-targeted fixes go into the release branch.
43
#. Add milestones at <https://edge.launchpad.net/bzr/2.0/+addmilestone> to
44
that series for the beta release, release candidate and the final release,
45
and their expected dates.
47
#. Update the version number in the ``bzr`` script, and the
48
``bzrlib/__init__.py`` file.
53
50
#. Send mail to the list with the key dates, who will be the release
54
51
manager, and the main themes or targeted bugs. Ask people to nominate
55
52
objectives, or point out any high-risk things that are best done early,
56
53
or that interact with other changes. This is called the metronome mail
57
and is described in `Development cycles <cycle.html>`_.
59
#. 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
60
71
release in a series, otherwise you should already have a branch.) ::
62
73
bzr branch trunk prepare-1.14
64
#. Configure pqm-submit for this branch, with a section like this (where
65
x.y is the version to release). **Or use hydrazine for easy use**
75
#. Configure pqm-submit for this branch, with a section like this in
66
76
``~/.bazaar/locations.conf``::
68
[/home/mbp/bzr/prepare-x.y]
78
[/home/mbp/bzr/prepare-1.14]
69
79
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
70
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
71
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
72
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
73
82
submit_to = bazaar@lists.canonical.com
74
83
smtp_server = mail.example.com:25
76
85
Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
77
86
for more details on PQM
79
#. Update the version number in the ``bzr`` script, and the
80
``bzrlib/__init__.py`` file::
82
version_info = (x, y, z, 'dev', 0)
84
#. Add a new section at the top of ``NEWS`` about the new release,
85
including its version number and the headings from
86
``NEWS-template.txt``.
88
#. Commit this and send it to PQM.
91
Doing a particular release
92
==========================
94
Update the source code
95
----------------------
97
#. Check that there is a milestone for the release you're doing. If there
98
is no milestone it indicates a process problem - make the milestone but
99
also mail the list to raise this issue in our process. Milestones are
100
found at <https://launchpad.net/bzr/+milestone/x.y.z>.
102
88
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
103
Make sure the corresponding milestone exists.
104
89
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
105
90
the output of ``bzr --version``.
107
92
For beta releases use::
109
version_info = (2, 1, 0, 'beta', SERIAL)
113
94
version_info = (2, 1, 0, 'beta', 1)
115
97
For release candidates use::
117
version_info = (2, 0, 1, 'candidate', SERIAL)
119
For stable releases use::
121
version_info = (2, 1, 2, 'final', 0)
123
#. Check the release number in ``./NEWS``
125
Fill out the date and a description of the release under the existing
126
header. If there isn't one, follow the above for using the NEWS
129
See *2.1.1* or similar for an example of what this looks like.
99
version_info = (2, 0, 1, 'candidate', 1)
102
#. Add the date and release number to ``./NEWS``
131
104
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
132
105
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
134
107
./tools/check-newsbugs.py NEWS
136
(But note there will be many false positives, and this script may be
109
(But note there can be some false positives, and this script may be
137
110
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
138
111
this slow you down too much.)
113
#. Summarize into one or two paragraphs what's new in this release.
140
115
#. Commit these changes to the release branch, using a command like::
142
bzr commit -m "Release 1.14."
117
bzr commit -m "Release 1.14."
144
119
The diff before you commit will be something like::
146
121
=== modified file 'NEWS'
147
122
--- NEWS 2008-09-17 23:09:18 +0000
148
123
+++ NEWS 2008-09-23 16:14:54 +0000
153
128
+bzr 1.7 2008-09-23
154
129
+------------------
215
188
disable the faulty plugins one by one until you get no more
218
Remember that PQM has just tested everything too, this step is
219
particularly testing that the pyrex extensions, which are updated
220
by your local pyrex version when you run make dist, are in good
224
Publishing the source tarball
225
-----------------------------
227
#. Go to the relevant milestone page in Launchpad.
229
#. Create a release of the milestone, and upload the source tarball and
230
the GPG signature. Or, if you prefer, use the
231
``tools/packaging/lp-upload-release`` script to do this. Note that
232
this changes what the download widget on the Launchpad bzr home
233
page shows, so don't stop the release process yet, or platform binary
234
installers won't be made and the download list will stay very small!
235
<https://bugs.edge.launchpad.net/launchpad/+bug/586445>
238
Announcing the source freeze
239
----------------------------
241
#. Post to the ``bazaar`` list, saying that the source has been frozen.
242
This is the cue for platform maintainers and plugin authors to update
243
their code. This is done before the general public announcement of the
247
Kick off the next cycle
248
-----------------------
250
#. To let developers work on the next release, do
251
`At the start of a release cycle` now.
253
#. Pause for a few days.
256
192
Publishing the release
257
193
----------------------
259
There is normally a delay of a few days after the source freeze to allow
260
for binaries to be built on various platforms. Once they have been built,
261
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
262
196
available to the world.
264
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
200
#. Within that release, upload the source tarball and zipfile and the GPG
201
signature. Or, if you prefer, use the
202
``tools/packaging/lp-upload-release`` script to do this.
266
204
#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and
348
286
Merging the released code back to trunk
349
287
---------------------------------------
351
The rule is to keep ``NEWS`` sections sorted by date. You'll need to
352
review the merge and make sure that that is respected.
354
289
Merge the release branch back into the trunk. Check that changes in NEWS
355
290
were merged into the right sections. If it's not already done, advance
356
291
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
357
292
back into pqm for bzr.dev.
359
As soon as you change the version number in trunk, make sure you have
360
created the corresponding milestone to ensure the continuity in bug
361
targeting or nominating. Depending on the change, you may even have to
362
create a new series (if your change the major or minor release number), in
363
that case go to `At the start of a release cycle` and follow the instructions from there.
365
294
You should also merge (not pull) the release branch into
366
295
``lp:~bzr/bzr/current``, so that branch contains the current released code
369
Releases until the final one
370
----------------------------
372
Congratulations - you have made your first release. Have a beer
373
or fruit juice - it's on the house! If it was a beta, or
374
candidate, you're not finished yet. Another beta or candidate or
375
hopefully a final release is still to come.
377
The process is the same as for the first release. Goto `Doing a
378
particular release`_ and follow the instructions again. Some details change
379
between beta, candidate and final releases, but they should be
380
documented. If the instructions aren't clear enough, please fix them.
added
removed
doc/developers/releasing.txt
