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).
24
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
26
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
32
To start a new release cycle:
34
#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
35
series for every *x.y* release.
37
#. Go to the series web page at <https://launchpad.net/bzr/x.y>
39
#. Create a new release at
40
<https://launchpad.net/bzr/x.y/+addrelease> and add
41
information about this release. We will not use it yet, but it
42
will be available for targeting or nominating bugs.
44
#. We create a new pqm-controlled branch for this release series, by
45
asking a Canonical sysadmin.
46
This branch means that from the first release beta or candidate onwards,
47
general development continues on the trunk, and only
48
specifically-targeted fixes go into the release branch.
50
#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
51
that series for the beta release, release candidate and the final release,
52
and their expected dates.
54
#. 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``.
62
#. Send mail to the list with the key dates, who will be the release
63
manager, and the main themes or targeted bugs. Ask people to nominate
64
objectives, or point out any high-risk things that are best done early,
65
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
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
69
18
release in a series, otherwise you should already have a branch.) ::
71
bzr branch trunk prepare-1.14
20
bzr branch trunk prepare-1.6
73
#. Configure pqm-submit for this branch, with a section like this (where
74
x.y is the version to release).
22
#. Configure pqm-submit for this branch, with a section like this in
75
23
``~/.bazaar/locations.conf``::
77
[/home/mbp/bzr/prepare-x.y]
25
[/home/mbp/bzr/prepare-1.4]
78
26
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
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
public_branch = http://bazaar.example.com/prepare-x.y
27
submit_branch = http://bazaar-vcs.org/bzr/bzr.1.4
82
28
submit_to = bazaar@lists.canonical.com
83
smtp_server = mail.example.com:25
85
Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
86
for more details on PQM
88
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
89
Make sure the corresponding milestone exists.
90
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
91
the output of ``bzr --version``.
93
For beta releases use::
95
version_info = (2, 1, 0, 'beta', 1)
98
For release candidates use::
100
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.
30
#. In the release branch, update ``version_info`` in
31
``./bzrlib/__init__.py``. Check the output of ``bzr --version``.
109
33
#. 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
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
119
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
121
./tools/check-newsbugs.py NEWS
123
(But note there can be some false positives, and this script may be
124
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
125
this slow you down too much.)
127
35
#. Summarize into one or two paragraphs what's new in this release.
129
37
#. Commit these changes to the release branch, using a command like::
131
bzr commit -m "Release 1.14."
39
bzr commit -m "Release 0.12rc1."
133
41
The diff before you commit will be something like::
135
43
=== modified file 'NEWS'
136
44
--- NEWS 2008-09-17 23:09:18 +0000
137
45
+++ NEWS 2008-09-23 16:14:54 +0000
142
50
+bzr 1.7 2008-09-23
143
51
+------------------
152
60
bzr 1.7rc2 2008-09-17
153
61
---------------------
156
64
=== modified file 'bzrlib/__init__.py'
157
65
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
158
66
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
160
68
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
161
69
# releaselevel of 'dev' for unreleased under-development code.
163
71
-version_info = (1, 7, 0, 'candidate', 2)
164
72
+version_info = (1, 7, 0, 'final', 0)
167
75
# API compatibility version: bzrlib is currently API compatible with 1.7.
169
#. Tag the new release::
173
#. Push those changes to a bzr reposistory that is public and accessible on
174
the Internet. PQM will pull from this repository when it attempts to merge
175
your changes. Then submit those changes to PQM for merge into the
176
appropriate release branch::
78
#. Submit those changes to PQM for merge into the appropriate release
179
bzr pqm-submit -m "(mbp) prepare 1.14"
82
bzr pqm-submit -m "(mbp) prepare 1.6"
181
84
#. When PQM succeeds, pull down the master release branch.
185
88
-------------------------
187
90
#. Change into the source directory and run ::
94
This also makes a zip file, which is easier to access on Microsoft
191
97
#. Now we'll try expanding this tarball and running the test suite
192
98
to check for packaging problems::
194
100
make check-dist-tarball
196
You may encounter failures while running the test suite caused
197
by your locally installed plugins. Use your own judgment to
198
decide if you can release with these failures. When in doubt,
199
disable the faulty plugins one by one until you get no more
203
Publishing the source tarball
204
-----------------------------
206
#. Go to the relevant milestone page in Launchpad.
208
#. Within that release, upload the source tarball and the GPG
209
signature. Or, if you prefer, use the
210
``tools/packaging/lp-upload-release`` script to do this.
213
Announcing the source freeze
214
----------------------------
216
#. Post to the ``bazaar`` list, saying that the source has been frozen.
217
This is the cue for platform maintainers and plugin authors to update
218
their code. This is done before the general public announcement of the
222
103
Publishing the release
223
104
----------------------
225
There is normally a delay of a few days after the source freeze to allow
226
for binaries to be built on various platforms. Once they have been built,
227
we have a releasable product. The next step is to make it generally
106
Now you have the releasable product. The next step is making it
228
107
available to the world.
109
#. In <https://launchpad.net/bzr/> click the "Release series" for this
110
series, to take you to e.g. <https://launchpad.net/bzr/1.1>. Then
111
click "Register a release", and add information about this release.
232
113
#. Within that release, upload the source tarball and zipfile and the GPG
233
114
signature. Or, if you prefer, use the
234
115
``tools/packaging/lp-upload-release`` script to do this.
236
#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and
239
#. Announce on the `Bazaar website <http://bazaar-vcs.org/>`_.
240
This page is edited via the lp:bzr-website branch. (Changes
241
pushed to this branch are refreshed by a cron job on escudero.)
243
#. Announce on the `Bazaar wiki <http://bazaar-vcs.org/Welcome>`_.
245
#. Check that the documentation for this release is available in
246
<http://doc.bazaar-vcs.org>. It should be automatically build when the
117
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
119
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
121
#. Check that the documentation for this release is available in
122
<http://doc.bazaar-vcs.org>. It should be automatically build when the
247
123
branch is created, by a cron script ``update-bzr-docs`` on
248
``escudero``. As of today (2009-08-27) ``igc`` manually updates the
249
pretty version of it.
252
127
Announcing the release
257
132
#. Make an announcement mail.
259
For release candidates or beta releases, this is sent to the ``bazaar``
260
list only to inform plugin authors and package or installer managers.
262
Once the installers are available, the mail can be sent to the
263
``bazaar-announce`` list too.
265
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
266
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
268
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
269
so that people who reply to the announcement don't spam other lists.
271
The announce mail will look something like this::
273
Subject: bzr x.yy released!
275
<<Summary paragraph from news>>
277
The Bazaar team is happy to announce availability of a new
278
release of the bzr adaptive version control system.
279
Bazaar is part of the GNU system <http://gnu.org/>.
281
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
286
for various systems will be available soon.
288
<<NEWS section from this release back to the last major release>>
290
Feel free to tweak this to your taste.
292
#. Make an announcement through <https://launchpad.net/bzr/+announce>
134
For release candidates, this is sent to the ``bazaar-announce`` and
135
``bazaar`` lists. For final releases, it should also be cc'd to
136
``info-gnu@gnu.org``, ``python-announce-list@python.org``,
137
``bug-directory@gnu.org``. In both cases, it is good to set
138
``Reply-To: bazaar@lists.canonical.com``, so that people who reply to
139
the announcement don't spam other lists.
141
The announce mail will look something like this:
143
| Subject: bzr x.yy released!
145
| <<Summary paragraph from news>>
147
| Thanks to everyone who contributed patches, suggestions, and
150
| bzr x.yy is now available for download from
151
| http://bazaar-vcs.org/Download as a source tarball; packages
152
| for various systems will be available soon.
154
| <<NEWS section from this release back to the last major release>>
294
156
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
295
157
ensuring the new topic text keeps the project name, web site link, etc.
297
159
#. Announce on http://freshmeat.net/projects/bzr/
299
This should be done for beta releases, release candidates and final
300
releases. If you do not have a Freshmeat account yet, ask one of the
303
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
304
be done for final releases but not for beta releases or Release Candidates.
161
This should be done for both release candidates and final releases. If
162
you do not have a Freshmeat account yet, ask one of the existing
165
#. Update http://en.wikipedia.org/wiki/Bzr -- this should be done for
166
final releases but not for Release Candidates.
306
168
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
307
169
done by running ::
323
185
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
324
186
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
You should also merge (not pull) the release branch into
333
``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.
353
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
355
* `Bazaar Developer Document Catalog <index.html>`_
356
* `Development cycles <cycle.html>`_: things that happen during the cycle
357
before the actual release.
192
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
194
* `Bazaar Developer Document Catalog <index.html>`_
195
* `Development cycles <cycle.html>`_: things that happen during the cycle
196
before the actual release.
360
200
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
