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
`overall development cycle <cycle.html>`_, 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).
12
Preparing the tree for release
13
------------------------------
15
.. Was previously at http://bazaar-vcs.org/ReleaseChecklist
17
#. Make a local branch for preparing this release. (Only for the first
18
release in a series, otherwise you should already have a branch.) ::
20
bzr branch trunk prepare-1.14
24
22
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
26
24
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
29
At the start of a release cycle
30
===============================
32
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
51
will be available for targeting or nominating bugs.
53
#. Send mail to the list with the key dates, who will be the release
54
manager, and the main themes or targeted bugs. Ask people to nominate
55
objectives, or point out any high-risk things that are best done early,
56
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
60
release in a series, otherwise you should already have a branch.) ::
62
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**
26
#. Configure pqm-submit for this branch, with a section like this in
66
27
``~/.bazaar/locations.conf``::
68
[/home/mbp/bzr/prepare-x.y]
29
[/home/mbp/bzr/prepare-1.14]
69
30
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
31
submit_branch = http://bazaar-vcs.org/bzr/bzr.1.14
32
public_branch = http://bazaar.your-domain.com/bzr
73
33
submit_to = bazaar@lists.canonical.com
74
smtp_server = mail.example.com:25
34
smtp_server = mail.your-domain.com:25
76
Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
36
Please see <http://doc.bazaar-vcs.org/latest/developers/HACKING.html#an-overview-of-pqm>
77
37
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
39
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
103
Make sure the corresponding milestone exists.
104
40
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
105
the output of ``bzr --version``.
107
For beta releases use::
109
version_info = (2, 1, 0, 'beta', SERIAL)
113
version_info = (2, 1, 0, 'beta', 1)
115
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.
41
the output of ``bzr --version``.
43
#. Add the date and release number to ``./NEWS``
131
45
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
132
46
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
134
48
./tools/check-newsbugs.py NEWS
136
(But note there will be many false positives, and this script may be
137
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
138
this slow you down too much.)
50
#. Summarize into one or two paragraphs what's new in this release.
140
52
#. Commit these changes to the release branch, using a command like::
142
bzr commit -m "Release 1.14."
54
bzr commit -m "Release 1.14."
144
56
The diff before you commit will be something like::
146
58
=== modified file 'NEWS'
147
59
--- NEWS 2008-09-17 23:09:18 +0000
148
60
+++ NEWS 2008-09-23 16:14:54 +0000
153
65
+bzr 1.7 2008-09-23
154
66
+------------------
163
75
bzr 1.7rc2 2008-09-17
164
76
---------------------
167
79
=== modified file 'bzrlib/__init__.py'
168
80
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
169
81
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
171
83
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
172
84
# releaselevel of 'dev' for unreleased under-development code.
174
86
-version_info = (1, 7, 0, 'candidate', 2)
175
87
+version_info = (1, 7, 0, 'final', 0)
178
90
# API compatibility version: bzrlib is currently API compatible with 1.7.
180
92
#. Tag the new release::
184
#. Push those changes to a bzr repository that is public and accessible on
96
#. Push those changes to a bzr reposistory that is public and accessible on
185
97
the Internet. PQM will pull from this repository when it attempts to merge
186
98
your changes. Then submit those changes to PQM for merge into the
187
99
appropriate release branch::
190
102
bzr pqm-submit -m "(mbp) prepare 1.14"
194
bzr lp-propose -m "Release 1.14" --approve lp:bzr/1.14
197
104
#. When PQM succeeds, pull down the master release branch.
201
108
-------------------------
203
110
#. Change into the source directory and run ::
114
This also makes a zip file, which is easier to access on Microsoft
207
117
#. Now we'll try expanding this tarball and running the test suite
208
118
to check for packaging problems::
210
120
make check-dist-tarball
212
You may encounter failures while running the test suite caused
213
by your locally installed plugins. Use your own judgment to
214
decide if you can release with these failures. When in doubt,
215
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
123
Publishing the release
257
124
----------------------
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
126
Now you have the releasable product. The next step is making it
262
127
available to the world.
264
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
266
#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and
269
#. Announce on the `Bazaar website <http://bazaar-vcs.org/>`_.
270
This page is edited via the lp:bzr-website branch. (Changes
271
pushed to this branch are refreshed by a cron job on escudero.)
273
#. Announce on the `Bazaar wiki <http://bazaar-vcs.org/Welcome>`_.
275
#. Check that the documentation for this release is available in
276
<http://doc.bazaar-vcs.org>. It should be automatically build when the
129
#. In <https://launchpad.net/bzr/> click the "Release series" for this
130
series, to take you to e.g. <https://launchpad.net/bzr/1.14>. Then
131
click "Register a release", and add information about this release.
133
#. Within that release, upload the source tarball and zipfile and the GPG
134
signature. Or, if you prefer, use the
135
``tools/packaging/lp-upload-release`` script to do this.
137
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
139
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
141
#. Check that the documentation for this release is available in
142
<http://doc.bazaar-vcs.org>. It should be automatically build when the
277
143
branch is created, by a cron script ``update-bzr-docs`` on
278
``escudero``. As of today (2009-08-27) ``igc`` manually updates the
279
pretty version of it.
282
147
Announcing the release
287
152
#. Make an announcement mail.
289
For release candidates or beta releases, this is sent to the ``bazaar``
290
list only to inform plugin authors and package or installer managers.
292
Once the installers are available, the mail can be sent to the
293
``bazaar-announce`` list too.
295
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
296
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
298
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
299
so that people who reply to the announcement don't spam other lists.
301
The announce mail will look something like this::
303
Subject: bzr x.y.z released!
305
<<Summary paragraph from news>>
307
The Bazaar team is happy to announce availability of a new
308
release of the bzr adaptive version control system.
309
Bazaar is part of the GNU system <http://gnu.org/>.
311
Thanks to everyone who contributed patches, suggestions, and
314
Bazaar is now available for download from
315
http://bazaar-vcs.org/Download as a source tarball; packages
316
for various systems will be available soon.
318
<<NEWS section from this release back to the last major release>>
320
Feel free to tweak this to your taste.
154
For release candidates, this is sent to the ``bazaar-announce`` and
155
``bazaar`` lists. For final releases, it should also be cc'd to
156
``info-gnu@gnu.org``, ``python-announce-list@python.org``,
157
``bug-directory@gnu.org``. In both cases, it is good to set
158
``Reply-To: bazaar@lists.canonical.com``, so that people who reply to
159
the announcement don't spam other lists.
161
The announce mail will look something like this:
163
| Subject: bzr x.yy released!
165
| <<Summary paragraph from news>>
167
| The Bazaar team is happy to announce availability of a new
168
| release of the bzr adaptive version control system.
170
| Thanks to everyone who contributed patches, suggestions, and
173
| Bazaar is now available for download from
174
| http://bazaar-vcs.org/Download as a source tarball; packages
175
| for various systems will be available soon.
177
| <<NEWS section from this release back to the last major release>>
322
179
#. Make an announcement through <https://launchpad.net/bzr/+announce>
348
205
Merging the released code back to trunk
349
206
---------------------------------------
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
208
Merge the release branch back into the trunk. Check that changes in NEWS
355
209
were merged into the right sections. If it's not already done, advance
356
210
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
357
211
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
213
You should also merge (not pull) the release branch into
366
214
``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
