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
17
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
19
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
25
To start a new release cycle:
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/x.y>
32
#. Create a new release at
33
<https://launchpad.net/bzr/x.y/+addrelease> and add
34
information about this release. We will not use it yet, but it
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/x.y/+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.
50
#. Send mail to the list with the key dates, who will be the release
51
manager, and the main themes or targeted bugs. Ask people to nominate
52
objectives, or point out any high-risk things that are best done early,
53
or that interact with other changes. This is called the metronome mail
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
#. Make a beta release or release candidate. The milestone for this
63
candidate will already exist (see Starting a cycle above).
65
Preparing the tree for release
66
------------------------------
68
#. Make a local branch for preparing this release. (Only for the first
69
release in a series, otherwise you should already have a branch.) ::
71
bzr branch trunk prepare-1.14
73
#. Configure pqm-submit for this branch, with a section like this (where
74
x.y is the version to release).
75
``~/.bazaar/locations.conf``::
77
[/home/mbp/bzr/prepare-x.y]
78
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
79
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
80
public_branch = http://bazaar.example.com/prepare-x.y
81
submit_to = bazaar@lists.canonical.com
82
smtp_server = mail.example.com:25
84
Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
85
for more details on PQM
87
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
88
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
89
the output of ``bzr --version``.
91
For beta releases use::
93
version_info = (2, 1, 0, 'beta', 1)
96
For release candidates use::
98
version_info = (2, 0, 1, 'candidate', 1)
101
#. Add the date and release number to ``./NEWS``
103
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
104
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
106
./tools/check-newsbugs.py NEWS
108
(But note there can be some false positives, and this script may be
109
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
110
this slow you down too much.)
112
#. Summarize into one or two paragraphs what's new in this release.
114
#. Commit these changes to the release branch, using a command like::
116
bzr commit -m "Release 1.14."
118
The diff before you commit will be something like::
120
=== modified file 'NEWS'
121
--- NEWS 2008-09-17 23:09:18 +0000
122
+++ NEWS 2008-09-23 16:14:54 +0000
130
+This release includes many bug fixes and a few performance and feature
131
+improvements. ``bzr rm`` will now scan for missing files and remove them,
132
+like how ``bzr add`` scans for unknown files and adds them. A bit more
133
+polish has been applied to the stacking code. The b-tree indexing code has
134
+been brought in, with an eye on using it in a future repository format.
135
+There are only minor installer changes since bzr-1.7rc2.
137
bzr 1.7rc2 2008-09-17
138
---------------------
141
=== modified file 'bzrlib/__init__.py'
142
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
143
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
145
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
146
# releaselevel of 'dev' for unreleased under-development code.
148
-version_info = (1, 7, 0, 'candidate', 2)
149
+version_info = (1, 7, 0, 'final', 0)
152
# API compatibility version: bzrlib is currently API compatible with 1.7.
154
#. Tag the new release::
158
#. Push those changes to a bzr reposistory that is public and accessible on
159
the Internet. PQM will pull from this repository when it attempts to merge
160
your changes. Then submit those changes to PQM for merge into the
161
appropriate release branch::
164
bzr pqm-submit -m "(mbp) prepare 1.14"
166
#. When PQM succeeds, pull down the master release branch.
169
Making the source tarball
170
-------------------------
172
#. Change into the source directory and run ::
176
#. Now we'll try expanding this tarball and running the test suite
177
to check for packaging problems::
179
make check-dist-tarball
181
You may encounter failures while running the test suite caused
182
by your locally installed plugins. Use your own judgment to
183
decide if you can release with these failures. When in doubt,
184
disable the faulty plugins one by one until you get no more
188
Publishing the source tarball
189
-----------------------------
191
#. Go to the relevant milestone page in Launchpad.
193
#. Within that release, upload the source tarball and the GPG
194
signature. Or, if you prefer, use the
195
``tools/packaging/lp-upload-release`` script to do this.
198
Announcing the source freeze
199
----------------------------
201
#. Post to the ``bazaar`` list, saying that the source has been frozen.
202
This is the cue for platform maintainers and plugin authors to update
203
their code. This is done before the general public announcement of the
207
Publishing the release
208
----------------------
210
There is normally a delay of a few days after the source freeze to allow
211
for binaries to be built on various platforms. Once they have been built,
212
we have a releasable product. The next step is to make it generally
213
available to the world.
215
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
217
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
219
#. Check that the documentation for this release is available in
220
<http://doc.bazaar-vcs.org>. It should be automatically build when the
221
branch is created, by a cron script ``update-bzr-docs`` on
222
``escudero``. As of today (2009-08-27) ``igc`` manually updates the
223
pretty version of it.
226
Announcing the release
227
----------------------
229
Now that the release is publicly available, tell people about it.
231
#. Make an announcement mail.
233
For release candidates or beta releases, this is sent to the ``bazaar``
234
list only to inform plugin authors and package or installer managers.
236
Once the installers are available, the mail can be sent to the
237
``bazaar-announce`` list too.
239
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
240
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
242
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
243
so that people who reply to the announcement don't spam other lists.
245
The announce mail will look something like this::
247
Subject: bzr x.yy released!
249
<<Summary paragraph from news>>
251
The Bazaar team is happy to announce availability of a new
252
release of the bzr adaptive version control system.
253
Bazaar is part of the GNU system <http://gnu.org/>.
255
Thanks to everyone who contributed patches, suggestions, and
258
Bazaar is now available for download from
259
http://bazaar-vcs.org/Download as a source tarball; packages
260
for various systems will be available soon.
262
<<NEWS section from this release back to the last major release>>
264
Feel free to tweak this to your taste.
266
#. Make an announcement through <https://launchpad.net/bzr/+announce>
268
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
269
ensuring the new topic text keeps the project name, web site link, etc.
271
#. Announce on http://freshmeat.net/projects/bzr/
273
This should be done for beta releases, release candidates and final
274
releases. If you do not have a Freshmeat account yet, ask one of the
277
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
278
be done for final releases but not for beta releases or Release Candidates.
280
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
283
python setup.py register
285
Remember to check the results afterwards.
287
To be able to register the release you must create an account on
288
<http://pypi.python.org/pypi> and have one of the existing owners of
289
the project add you to the group.
292
Merging the released code back to trunk
293
---------------------------------------
295
Merge the release branch back into the trunk. Check that changes in NEWS
296
were merged into the right sections. If it's not already done, advance
297
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
298
back into pqm for bzr.dev.
300
You should also merge (not pull) the release branch into
301
``lp:~bzr/bzr/current``, so that branch contains the current released code
308
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
310
* `Bazaar Developer Document Catalog <index.html>`_
311
* `Development cycles <cycle.html>`_: things that happen during the cycle
312
before the actual release.
315
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
