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
16
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
18
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
24
To start a new release cycle:
26
#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
27
series for every *x.y* release.
29
#. Go to the series web page at <https://launchpad.net/bzr/x.y>
31
#. Create a new release at
32
<https://launchpad.net/bzr/x.y/+addrelease> and add
33
information about this release. We will not use it yet, but it
34
will be available for targeting or nominating bugs.
36
#. We create a new pqm-controlled branch for this release series, by
37
asking a Canonical sysadmin.
38
This branch means that from the first release beta or candidate onwards,
39
general development continues on the trunk, and only
40
specifically-targeted fixes go into the release branch.
42
#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
43
that series for the beta release, release candidate and the final release,
44
and their expected dates.
46
#. Update the version number in the ``bzr`` script, and the
47
``bzrlib/__init__.py`` file.
49
#. Send mail to the list with the key dates, who will be the release
50
manager, and the main themes or targeted bugs. Ask people to nominate
51
objectives, or point out any high-risk things that are best done early,
52
or that interact with other changes. This is called the metronome mail
53
and as RM you're supposed to send other metronome mails at your rythm.
56
Starting the release phase
57
--------------------------
59
When it's time to make the first beta release or release candidate:
61
#. Make a beta release or release candidate. The milestone for this
62
candidate will already exist (see Starting a cycle above).
64
Preparing the tree for release
65
------------------------------
67
#. Make a local branch for preparing this release. (Only for the first
68
release in a series, otherwise you should already have a branch.) ::
70
bzr branch trunk prepare-1.14
72
#. Configure pqm-submit for this branch, with a section like this in
73
``~/.bazaar/locations.conf``::
75
[/home/mbp/bzr/prepare-1.14]
76
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
77
submit_branch = lp:bzr/2.0
78
public_branch = http://bazaar.example.com/prepare-2.0
79
submit_to = bazaar@lists.canonical.com
80
smtp_server = mail.example.com:25
82
Please see <http://doc.bazaar-vcs.org/latest/developers/HACKING.html#an-overview-of-pqm>
83
for more details on PQM
85
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
86
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
87
the output of ``bzr --version``.
89
For beta releases use::
91
version_info = (2, 1, 0, 'beta', 1)
94
For release candidates use::
96
version_info = (2, 0, 1, 'candidate', 1)
99
#. Add the date and release number to ``./NEWS``
101
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
102
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
104
./tools/check-newsbugs.py NEWS
106
(But note there can be some false positives, and this script may be
107
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
108
this slow you down too much.)
110
#. Summarize into one or two paragraphs what's new in this release.
112
#. Commit these changes to the release branch, using a command like::
114
bzr commit -m "Release 1.14."
116
The diff before you commit will be something like::
118
=== modified file 'NEWS'
119
--- NEWS 2008-09-17 23:09:18 +0000
120
+++ NEWS 2008-09-23 16:14:54 +0000
128
+This release includes many bug fixes and a few performance and feature
129
+improvements. ``bzr rm`` will now scan for missing files and remove them,
130
+like how ``bzr add`` scans for unknown files and adds them. A bit more
131
+polish has been applied to the stacking code. The b-tree indexing code has
132
+been brought in, with an eye on using it in a future repository format.
133
+There are only minor installer changes since bzr-1.7rc2.
135
bzr 1.7rc2 2008-09-17
136
---------------------
139
=== modified file 'bzrlib/__init__.py'
140
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
141
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
143
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
144
# releaselevel of 'dev' for unreleased under-development code.
146
-version_info = (1, 7, 0, 'candidate', 2)
147
+version_info = (1, 7, 0, 'final', 0)
150
# API compatibility version: bzrlib is currently API compatible with 1.7.
152
#. Tag the new release::
156
#. Push those changes to a bzr reposistory that is public and accessible on
157
the Internet. PQM will pull from this repository when it attempts to merge
158
your changes. Then submit those changes to PQM for merge into the
159
appropriate release branch::
162
bzr pqm-submit -m "(mbp) prepare 1.14"
164
#. When PQM succeeds, pull down the master release branch.
167
Making the source tarball
168
-------------------------
170
#. Change into the source directory and run ::
174
This also makes a zip file, which is easier to access on Microsoft
177
#. Now we'll try expanding this tarball and running the test suite
178
to check for packaging problems::
180
make check-dist-tarball
182
You may encounter failures while running the test suite caused
183
by your locally installed plugins. Use your own judgment to
184
decide if you can release with these failures. When in doubt,
185
disable the faulty plugins one by one until you get no more
189
Publishing the release
190
----------------------
192
Now you have the beta or releasable product. The next step is making it
193
available to the world.
197
#. Within that release, upload the source tarball and zipfile and the GPG
198
signature. Or, if you prefer, use the
199
``tools/packaging/lp-upload-release`` script to do this.
201
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
203
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
205
#. Check that the documentation for this release is available in
206
<http://doc.bazaar-vcs.org>. It should be automatically build when the
207
branch is created, by a cron script ``update-bzr-docs`` on
208
``escudero``. As of today (2009-08-27) ``igc`` manually updates the
209
pretty version of it.
212
Announcing the release
213
----------------------
215
Now that the release is publicly available, tell people about it.
217
#. Make an announcement mail.
219
For release candidates or beta releases, this is sent to the ``bazaar``
220
list only to inform plugin authors and package or installer managers.
222
Once the installers are available, the mail can be sent to the
223
``bazaar-announce`` list too.
225
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
226
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
228
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
229
so that people who reply to the announcement don't spam other lists.
231
The announce mail will look something like this::
233
Subject: bzr x.yy released!
235
<<Summary paragraph from news>>
237
The Bazaar team is happy to announce availability of a new
238
release of the bzr adaptive version control system.
239
Bazaar is part of the GNU system <http://gnu.org/>.
241
Thanks to everyone who contributed patches, suggestions, and
244
Bazaar is now available for download from
245
http://bazaar-vcs.org/Download as a source tarball; packages
246
for various systems will be available soon.
248
<<NEWS section from this release back to the last major release>>
250
Feel free to tweak this to your taste.
252
#. Make an announcement through <https://launchpad.net/bzr/+announce>
254
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
255
ensuring the new topic text keeps the project name, web site link, etc.
257
#. Announce on http://freshmeat.net/projects/bzr/
259
This should be done for beta releases, release candidates and final
260
releases. If you do not have a Freshmeat account yet, ask one of the
263
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
264
be done for final releases but not for beta releases or Release Candidates.
266
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
269
python setup.py register
271
Remember to check the results afterwards.
273
To be able to register the release you must create an account on
274
<http://pypi.python.org/pypi> and have one of the existing owners of
275
the project add you to the group.
278
Merging the released code back to trunk
279
---------------------------------------
281
Merge the release branch back into the trunk. Check that changes in NEWS
282
were merged into the right sections. If it's not already done, advance
283
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
284
back into pqm for bzr.dev.
286
You should also merge (not pull) the release branch into
287
``lp:~bzr/bzr/current``, so that branch contains the current released code
294
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
296
* `Bazaar Developer Document Catalog <index.html>`_
297
* `Development cycles <cycle.html>`_: things that happen during the cycle
298
before the actual release.
301
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
