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.
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
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
26
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**
66
``~/.bazaar/locations.conf``::
68
[/home/mbp/bzr/prepare-x.y]
69
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
73
submit_to = bazaar@lists.canonical.com
74
smtp_server = mail.example.com:25
76
Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
77
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
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
103
Make sure the corresponding milestone exists.
104
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.
131
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
132
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
134
./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.)
140
#. Commit these changes to the release branch, using a command like::
142
bzr commit -m "Release 1.14."
144
The diff before you commit will be something like::
146
=== modified file 'NEWS'
147
--- NEWS 2008-09-17 23:09:18 +0000
148
+++ NEWS 2008-09-23 16:14:54 +0000
156
+This release includes many bug fixes and a few performance and feature
157
+improvements. ``bzr rm`` will now scan for missing files and remove them,
158
+like how ``bzr add`` scans for unknown files and adds them. A bit more
159
+polish has been applied to the stacking code. The b-tree indexing code has
160
+been brought in, with an eye on using it in a future repository format.
161
+There are only minor installer changes since bzr-1.7rc2.
163
bzr 1.7rc2 2008-09-17
164
---------------------
167
=== modified file 'bzrlib/__init__.py'
168
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
169
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
171
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
172
# releaselevel of 'dev' for unreleased under-development code.
174
-version_info = (1, 7, 0, 'candidate', 2)
175
+version_info = (1, 7, 0, 'final', 0)
178
# API compatibility version: bzrlib is currently API compatible with 1.7.
180
#. Tag the new release::
184
#. Push those changes to a bzr repository that is public and accessible on
185
the Internet. PQM will pull from this repository when it attempts to merge
186
your changes. Then submit those changes to PQM for merge into the
187
appropriate release branch::
190
bzr pqm-submit -m "(mbp) prepare 1.14"
194
bzr lp-propose -m "Release 1.14" --approve lp:bzr/1.14
197
#. When PQM succeeds, pull down the master release branch.
200
Making the source tarball
201
-------------------------
203
#. Change into the source directory and run ::
207
#. Now we'll try expanding this tarball and running the test suite
208
to check for packaging problems::
210
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
Publishing the release
257
----------------------
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
262
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
277
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
Announcing the release
283
----------------------
285
Now that the release is publicly available, tell people about it.
287
#. 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.
322
#. Make an announcement through <https://launchpad.net/bzr/+announce>
324
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
325
ensuring the new topic text keeps the project name, web site link, etc.
327
#. Announce on http://freshmeat.net/projects/bzr/
329
This should be done for beta releases, release candidates and final
330
releases. If you do not have a Freshmeat account yet, ask one of the
333
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
334
be done for final releases but not for beta releases or Release Candidates.
336
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
339
python setup.py register
341
Remember to check the results afterwards.
343
To be able to register the release you must create an account on
344
<http://pypi.python.org/pypi> and have one of the existing owners of
345
the project add you to the group.
348
Merging the released code back to trunk
349
---------------------------------------
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
Merge the release branch back into the trunk. Check that changes in NEWS
355
were merged into the right sections. If it's not already done, advance
356
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
357
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
You should also merge (not pull) the release branch into
366
``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.
386
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
388
* `Bazaar Developer Document Catalog <index.html>`_
389
* `Development cycles <cycle.html>`_: things that happen during the cycle
390
before the actual release.
393
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
