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.canonical.com/developers/cycle.html>`_,
7
but it's the most complex part. This document gives a checklist you can
8
follow from start to end in one go.
10
If you're helping the Release Manager (RM) for one reason or another, you
11
may notice that he didn't follow that document scrupulously. He may have
12
good reasons to do that but he may also have missed some parts.
14
Follow the document yourself and don't hesitate to create the missing
15
milestones for example (we tend to forget these ones a lot).
23
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
25
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
28
At the start of a release cycle
29
===============================
31
To start a new release cycle:
33
#. If this is the first release for a given *x.y* then create a new
34
series at <https://launchpad.net/bzr/+addseries>. There is one series
35
for every *x.y* release.
37
#. If you made a new series, create a new pqm-controlled branch for this
38
release series, by asking a Canonical sysadmin. This branch means that
39
from the first release beta or candidate onwards, general development
40
continues on the trunk, and only specifically-targeted fixes go into
43
#. If you made a new series, add milestones at
44
<https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for
45
the beta release, release candidate and the final release, and their
48
#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>
49
and add information about this release. We will not use it yet, but it
50
will be available for targeting or nominating bugs.
52
#. Send mail to the list with the key dates, who will be the release
53
manager, and the main themes or targeted bugs. Ask people to nominate
54
objectives, or point out any high-risk things that are best done early,
55
or that interact with other changes. This is called the metronome mail
56
and is described in `Development cycles <cycle.html>`_.
58
#. Make a local branch for preparing this release. (Only for the first
59
release in a series, otherwise you should already have a branch.) ::
61
bzr branch trunk prepare-1.14
63
#. Configure pqm-submit for this branch, with a section like this (where
64
x.y is the version to release). **Or use hydrazine for easy use**
65
``~/.bazaar/locations.conf``::
67
[/home/mbp/bzr/prepare-x.y]
68
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
69
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
70
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
71
public_branch = http://bazaar.example.com/prepare-x.y
72
submit_to = bazaar@lists.canonical.com
73
smtp_server = mail.example.com:25
75
Please see <http://doc.bazaar.canonical.com/developers/HACKING.html#an-overview-of-pqm>
76
for more details on PQM
78
#. Update the version number in the ``bzr`` script, and the
79
``bzrlib/__init__.py`` file::
81
version_info = (x, y, z, 'dev', 0)
83
#. Add a new section at the top of ``NEWS`` about the new release,
84
including its version number and the headings from
85
``NEWS-template.txt``.
87
#. Update the "What's New" documents in ``doc/en/whats-new``.
89
#. Commit this and send it to PQM.
92
Doing a particular release
93
==========================
95
Update the source code
96
----------------------
98
#. Check that there is a milestone for the release you're doing. If there
99
is no milestone it indicates a process problem - make the milestone but
100
also mail the list to raise this issue in our process. Milestones are
101
found at <https://launchpad.net/bzr/+milestone/x.y.z>.
103
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
104
Make sure the corresponding milestone exists.
105
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
106
the output of ``bzr --version``.
108
For beta releases use::
110
version_info = (2, 1, 0, 'beta', SERIAL)
114
version_info = (2, 1, 0, 'beta', 1)
116
For release candidates use::
118
version_info = (2, 0, 1, 'candidate', SERIAL)
120
For stable releases use::
122
version_info = (2, 1, 2, 'final', 0)
124
#. Update the ``./NEWS`` section for this release.
126
Fill out the date and a description of the release under the existing
127
header. If there isn't one, follow the above for using the NEWS
130
See *2.1.1* or similar for an example of what this looks like.
132
#. Add a summary of the release into the "What's New" document.
134
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
135
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
137
./tools/check-newsbugs.py NEWS
139
(But note there will be many false positives, and this script may be
140
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
141
this slow you down too much.)
143
#. Commit these changes to the release branch, using a command like::
145
bzr commit -m "Release 1.14."
147
The diff before you commit will be something like::
149
=== modified file 'NEWS'
150
--- NEWS 2008-09-17 23:09:18 +0000
151
+++ NEWS 2008-09-23 16:14:54 +0000
159
+This release includes many bug fixes and a few performance and feature
160
+improvements. ``bzr rm`` will now scan for missing files and remove them,
161
+like how ``bzr add`` scans for unknown files and adds them. A bit more
162
+polish has been applied to the stacking code. The b-tree indexing code has
163
+been brought in, with an eye on using it in a future repository format.
164
+There are only minor installer changes since bzr-1.7rc2.
166
bzr 1.7rc2 2008-09-17
167
---------------------
170
=== modified file 'bzrlib/__init__.py'
171
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
172
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
174
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
175
# releaselevel of 'dev' for unreleased under-development code.
177
-version_info = (1, 7, 0, 'candidate', 2)
178
+version_info = (1, 7, 0, 'final', 0)
181
# API compatibility version: bzrlib is currently API compatible with 1.7.
183
#. Tag the new release::
187
#. Push those changes to a bzr repository that is public and accessible on
188
the Internet. PQM will pull from this repository when it attempts to merge
189
your changes. Then submit those changes to PQM for merge into the
190
appropriate release branch::
193
bzr pqm-submit -m "(mbp) prepare 1.14"
197
bzr lp-propose -m "Release 1.14" --approve lp:bzr/1.14
200
#. When PQM succeeds, pull down the master release branch.
203
Making the source tarball
204
-------------------------
206
#. Change into the source directory and run ::
210
#. Now we'll try expanding this tarball and running the test suite
211
to check for packaging problems::
213
make check-dist-tarball
215
You may encounter failures while running the test suite caused
216
by your locally installed plugins. Use your own judgment to
217
decide if you can release with these failures. When in doubt,
218
disable the faulty plugins one by one until you get no more
221
Remember that PQM has just tested everything too, this step is
222
particularly testing that the pyrex extensions, which are updated
223
by your local pyrex version when you run make dist, are in good
227
Publishing the source tarball
228
-----------------------------
230
#. Go to the relevant milestone page in Launchpad.
232
#. Create a release of the milestone, and upload the source tarball and
233
the GPG signature. Or, if you prefer, use the
234
``tools/packaging/lp-upload-release`` script to do this. Note that
235
this changes what the download widget on the Launchpad bzr home
236
page shows, so don't stop the release process yet, or platform binary
237
installers won't be made and the download list will stay very small!
238
<https://bugs.edge.launchpad.net/launchpad/+bug/586445>
241
Announcing the source freeze
242
----------------------------
244
#. Post to the ``bazaar`` list, saying that the source has been frozen.
245
This is the cue for platform maintainers and plugin authors to update
246
their code. This is done before the general public announcement of the
250
Kick off the next cycle
251
-----------------------
253
#. To let developers work on the next release, do
254
`At the start of a release cycle` now.
256
#. Pause for a few days.
259
Publishing the release
260
----------------------
262
There is normally a delay of a few days after the source freeze to allow
263
for binaries to be built on various platforms. Once they have been built,
264
we have a releasable product. The next step is to make it generally
265
available to the world.
267
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
269
#. Announce on the `Bazaar website <http://bazaar.canonical.com/>`_.
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
#. Check that the documentation for this release is available in
274
<http://doc.bazaar.canonical.com>. It should be automatically build when the
275
branch is created, by a cron script ``update-bzr-docs`` on
276
``escudero``. As of today (2009-08-27) ``igc`` manually updates the
277
pretty version of it.
280
Announcing the release
281
----------------------
283
Now that the release is publicly available, tell people about it.
285
#. Make an announcement mail.
287
For release candidates or beta releases, this is sent to the ``bazaar``
288
list only to inform plugin authors and package or installer managers.
290
Once the installers are available, the mail can be sent to the
291
``bazaar-announce`` list too.
293
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
294
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
296
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
297
so that people who reply to the announcement don't spam other lists.
299
The announce mail will look something like this::
301
Subject: bzr x.y.z released!
303
<<Summary paragraph from news>>
305
The Bazaar team is happy to announce availability of a new
306
release of the bzr adaptive version control system.
307
Bazaar is part of the GNU system <http://gnu.org/>.
309
Thanks to everyone who contributed patches, suggestions, and
312
Bazaar is now available for download from
313
https://launchpad.net/bzr/2.x/2.x/ as a source tarball; packages
314
for various systems will be available soon.
316
<<NEWS section from this release back to the last major release>>
318
Feel free to tweak this to your taste.
320
#. Make an announcement through <https://launchpad.net/bzr/+announce>
322
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
323
ensuring the new topic text keeps the project name, web site link, etc.
325
#. Announce on http://freshmeat.net/projects/bzr/
327
This should be done for beta releases, release candidates and final
328
releases. If you do not have a Freshmeat account yet, ask one of the
331
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
332
be done for final releases but not for beta releases or Release Candidates.
334
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
337
python setup.py register
339
Remember to check the results afterwards.
341
To be able to register the release you must create an account on
342
<http://pypi.python.org/pypi> and have one of the existing owners of
343
the project add you to the group.
346
Merging the released code back to trunk
347
---------------------------------------
349
The rule is to keep ``NEWS`` sections sorted by date. You'll need to
350
review the merge and make sure that that is respected.
352
Merge the release branch back into the trunk. Check that changes in NEWS
353
were merged into the right sections. If it's not already done, advance
354
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
355
back into pqm for bzr.dev.
357
As soon as you change the version number in trunk, make sure you have
358
created the corresponding milestone to ensure the continuity in bug
359
targeting or nominating. Depending on the change, you may even have to
360
create a new series (if your change the major or minor release number), in
361
that case go to `At the start of a release cycle` and follow the instructions from there.
363
You should also merge (not pull) the release branch into
364
``lp:~bzr/bzr/current``, so that branch contains the current released code
367
Releases until the final one
368
----------------------------
370
Congratulations - you have made your first release. Have a beer
371
or fruit juice - it's on the house! If it was a beta, or
372
candidate, you're not finished yet. Another beta or candidate or
373
hopefully a final release is still to come.
375
The process is the same as for the first release. Goto `Doing a
376
particular release`_ and follow the instructions again. Some details change
377
between beta, candidate and final releases, but they should be
378
documented. If the instructions aren't clear enough, please fix them.
384
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
386
* `Bazaar Developer Document Catalog <index.html>`_
387
* `Development cycles <cycle.html>`_: things that happen during the cycle
388
before the actual release.
391
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
