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 <cycle.html>`_, but it's the most complex part.
7
This document gives a checklist you can follow from start to end in one
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.6
22
#. Configure pqm-submit for this branch, with a section like this in
23
``~/.bazaar/locations.conf``::
25
[/home/mbp/bzr/prepare-1.4]
26
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
27
submit_branch = http://bazaar-vcs.org/bzr/bzr.1.4
28
submit_to = bazaar@lists.canonical.com
30
#. In the release branch, update ``version_info`` in
31
``./bzrlib/__init__.py``. Check the output of ``bzr --version``.
33
#. Add the date and release number to ``./NEWS``
35
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
36
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
38
./tools/check-newsbugs.py NEWS
40
#. Summarize into one or two paragraphs what's new in this release.
42
#. Commit these changes to the release branch, using a command like::
44
bzr commit -m "Release 0.12rc1."
46
The diff before you commit will be something like::
48
=== modified file 'NEWS'
49
--- NEWS 2008-09-17 23:09:18 +0000
50
+++ NEWS 2008-09-23 16:14:54 +0000
58
+This release includes many bug fixes and a few performance and feature
59
+improvements. ``bzr rm`` will now scan for missing files and remove them,
60
+like how ``bzr add`` scans for unknown files and adds them. A bit more
61
+polish has been applied to the stacking code. The b-tree indexing code has
62
+been brought in, with an eye on using it in a future repository format.
63
+There are only minor installer changes since bzr-1.7rc2.
69
=== modified file 'bzrlib/__init__.py'
70
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
71
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
73
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
74
# releaselevel of 'dev' for unreleased under-development code.
76
-version_info = (1, 7, 0, 'candidate', 2)
77
+version_info = (1, 7, 0, 'final', 0)
80
# API compatibility version: bzrlib is currently API compatible with 1.7.
82
#. Tag the new release::
86
#. Submit those changes to PQM for merge into the appropriate release
90
bzr pqm-submit -m "(mbp) prepare 1.6"
92
#. When PQM succeeds, pull down the master release branch.
95
Making the source tarball
96
-------------------------
98
#. Change into the source directory and run ::
102
This also makes a zip file, which is easier to access on Microsoft
105
#. Now we'll try expanding this tarball and running the test suite
106
to check for packaging problems::
108
make check-dist-tarball
111
Publishing the release
112
----------------------
114
Now you have the releasable product. The next step is making it
115
available to the world.
117
#. In <https://launchpad.net/bzr/> click the "Release series" for this
118
series, to take you to e.g. <https://launchpad.net/bzr/1.1>. Then
119
click "Register a release", and add information about this release.
121
#. Within that release, upload the source tarball and zipfile and the GPG
122
signature. Or, if you prefer, use the
123
``tools/packaging/lp-upload-release`` script to do this.
125
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
127
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
129
#. Check that the documentation for this release is available in
130
<http://doc.bazaar-vcs.org>. It should be automatically build when the
131
branch is created, by a cron script ``update-bzr-docs`` on
135
Announcing the release
136
----------------------
138
Now that the release is publicly available, tell people about it.
140
#. Make an announcement mail.
142
For release candidates, this is sent to the ``bazaar-announce`` and
143
``bazaar`` lists. For final releases, it should also be cc'd to
144
``info-gnu@gnu.org``, ``python-announce-list@python.org``,
145
``bug-directory@gnu.org``. In both cases, it is good to set
146
``Reply-To: bazaar@lists.canonical.com``, so that people who reply to
147
the announcement don't spam other lists.
149
The announce mail will look something like this:
151
| Subject: bzr x.yy released!
153
| <<Summary paragraph from news>>
155
| The Bazaar team is happy to announce availability of a new
156
| release of the bzr adaptive version control system.
158
| Thanks to everyone who contributed patches, suggestions, and
161
| Bazaar is now available for download from
162
| http://bazaar-vcs.org/Download as a source tarball; packages
163
| for various systems will be available soon.
165
| <<NEWS section from this release back to the last major release>>
167
#. Make an announcement through <https://launchpad.net/bzr/+announce>
169
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
170
ensuring the new topic text keeps the project name, web site link, etc.
172
#. Announce on http://freshmeat.net/projects/bzr/
174
This should be done for both release candidates and final releases. If
175
you do not have a Freshmeat account yet, ask one of the existing
178
#. Update http://en.wikipedia.org/wiki/Bzr -- this should be done for
179
final releases but not for Release Candidates.
181
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
184
python setup.py register
186
Remember to check the results afterwards.
188
To be able to register the release you must create an account on
189
<http://pypi.python.org/pypi> and have one of the existing owners of
190
the project add you to the group.
193
Merging the released code back to trunk
194
---------------------------------------
196
Merge the release branch back into the trunk. Check that changes in NEWS
197
were merged into the right sections. If it's not already done, advance
198
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
199
back into pqm for bzr.dev.
205
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
207
* `Bazaar Developer Document Catalog <index.html>`_
208
* `Development cycles <cycle.html>`_: things that happen during the cycle
209
before the actual release.
213
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
