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.14
22
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
24
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
26
#. Configure pqm-submit for this branch, with a section like this in
27
``~/.bazaar/locations.conf``::
29
[/home/mbp/bzr/prepare-1.14]
30
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
31
submit_branch = http://bazaar-vcs.org/bzr/bzr.1.14
32
public_branch = http://bazaar.your-domain.com/bzr
33
submit_to = bazaar@lists.canonical.com
34
smtp_server = mail.your-domain.com:25
36
Please see <http://doc.bazaar-vcs.org/latest/developers/HACKING.html#an-overview-of-pqm>
37
for more details on PQM
39
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
40
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
41
the output of ``bzr --version``.
43
#. Add the date and release number to ``./NEWS``
45
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
46
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
48
./tools/check-newsbugs.py NEWS
50
#. Summarize into one or two paragraphs what's new in this release.
52
#. Commit these changes to the release branch, using a command like::
54
bzr commit -m "Release 1.14."
56
The diff before you commit will be something like::
58
=== modified file 'NEWS'
59
--- NEWS 2008-09-17 23:09:18 +0000
60
+++ NEWS 2008-09-23 16:14:54 +0000
68
+This release includes many bug fixes and a few performance and feature
69
+improvements. ``bzr rm`` will now scan for missing files and remove them,
70
+like how ``bzr add`` scans for unknown files and adds them. A bit more
71
+polish has been applied to the stacking code. The b-tree indexing code has
72
+been brought in, with an eye on using it in a future repository format.
73
+There are only minor installer changes since bzr-1.7rc2.
79
=== modified file 'bzrlib/__init__.py'
80
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
81
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
83
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
84
# releaselevel of 'dev' for unreleased under-development code.
86
-version_info = (1, 7, 0, 'candidate', 2)
87
+version_info = (1, 7, 0, 'final', 0)
90
# API compatibility version: bzrlib is currently API compatible with 1.7.
92
#. Tag the new release::
96
#. Push those changes to a bzr reposistory that is public and accessible on
97
the Internet. PQM will pull from this repository when it attempts to merge
98
your changes. Then submit those changes to PQM for merge into the
99
appropriate release branch::
102
bzr pqm-submit -m "(mbp) prepare 1.14"
104
#. When PQM succeeds, pull down the master release branch.
107
Making the source tarball
108
-------------------------
110
#. Change into the source directory and run ::
114
This also makes a zip file, which is easier to access on Microsoft
117
#. Now we'll try expanding this tarball and running the test suite
118
to check for packaging problems::
120
make check-dist-tarball
123
Publishing the release
124
----------------------
126
Now you have the releasable product. The next step is making it
127
available to the world.
129
#. In <https://launchpad.net/bzr/> click the "Release series" for this
130
series, to take you to e.g. <https://launchpad.net/bzr/1.14>. Then
131
click "Register a release", and add information about this release.
133
#. Within that release, upload the source tarball and zipfile and the GPG
134
signature. Or, if you prefer, use the
135
``tools/packaging/lp-upload-release`` script to do this.
137
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
139
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
141
#. Check that the documentation for this release is available in
142
<http://doc.bazaar-vcs.org>. It should be automatically build when the
143
branch is created, by a cron script ``update-bzr-docs`` on
147
Announcing the release
148
----------------------
150
Now that the release is publicly available, tell people about it.
152
#. Make an announcement mail.
154
For release candidates, this is sent to the ``bazaar-announce`` and
155
``bazaar`` lists. For final releases, it should also be cc'd to
156
``info-gnu@gnu.org``, ``python-announce-list@python.org``,
157
``bug-directory@gnu.org``. In both cases, it is good to set
158
``Reply-To: bazaar@lists.canonical.com``, so that people who reply to
159
the announcement don't spam other lists.
161
The announce mail will look something like this:
163
| Subject: bzr x.yy released!
165
| <<Summary paragraph from news>>
167
| The Bazaar team is happy to announce availability of a new
168
| release of the bzr adaptive version control system.
170
| Thanks to everyone who contributed patches, suggestions, and
173
| Bazaar is now available for download from
174
| http://bazaar-vcs.org/Download as a source tarball; packages
175
| for various systems will be available soon.
177
| <<NEWS section from this release back to the last major release>>
179
#. Make an announcement through <https://launchpad.net/bzr/+announce>
181
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
182
ensuring the new topic text keeps the project name, web site link, etc.
184
#. Announce on http://freshmeat.net/projects/bzr/
186
This should be done for both release candidates and final releases. If
187
you do not have a Freshmeat account yet, ask one of the existing
190
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should be done
191
for final releases but not for Release Candidates.
193
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
196
python setup.py register
198
Remember to check the results afterwards.
200
To be able to register the release you must create an account on
201
<http://pypi.python.org/pypi> and have one of the existing owners of
202
the project add you to the group.
205
Merging the released code back to trunk
206
---------------------------------------
208
Merge the release branch back into the trunk. Check that changes in NEWS
209
were merged into the right sections. If it's not already done, advance
210
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
211
back into pqm for bzr.dev.
213
You should also merge (not pull) the release branch into
214
``lp:~bzr/bzr/current``, so that branch contains the current released code
221
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
223
* `Bazaar Developer Document Catalog <index.html>`_
224
* `Development cycles <cycle.html>`_: things that happen during the cycle
225
before the actual release.
228
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
