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.
8
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).
5
release, and managing the release process.
7
See also: `Bazaar Developer Document Catalog <index.html>`_.
24
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
26
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
32
16
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
18
#. 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
19
manager, and the main themes or targetted bugs. Ask people to nominate
64
20
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
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
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
81
public_branch = http://bazaar.example.com/prepare-x.y
82
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.
109
#. 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
#. Summarize into one or two paragraphs what's new in this release.
21
or that interact with other changes.
23
#. Add a new "series" in Launchpad at <https://launchpad.net/bzr/+addseries>. There is one
24
series for every *x.y* release.
29
TODO: Things to cover:
31
* Early communication to downstream teams (e.g. Launchpad) about changes in dependencies.
32
* Reminder re lifecycle and where we're up to right now
33
* Summary of recent successes and pending work
34
* Reminder re release objectives
35
* Reminder re things needing attention, e.g. bug triage, reviews, testing of certain things, etc.
41
TODO: Get material from http://bazaar-vcs.org/FeatureFreeze.
45
Preparing the tree for release
46
------------------------------
48
.. Was previously at http://bazaar-vcs.org/ReleaseChecklist
50
.. TODO: Still needs more clarity on what's in a RC versus a final
53
This is the procedure for making a new bzr release:
55
#. If the release is the first candidate, make a new branch in PQM.
56
(Contact Robert Collins for this step).
58
Register the branch at https://launchpad.net/products/bzr/+addbranch
60
#. Run the automatic test suite and any non-automated tests. (For example, try a download over http; these should eventually be scripted though not automatically run.). Try to have all optional dependencies installed so that there are no tests skipped. Also make sure that you have the c extensions compiled (``make`` or ``python setup.py build_ext -i``).
62
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``
64
#. Add the date and release number to ``./NEWS``.
129
66
#. Commit these changes to the release branch, using a command like::
131
bzr commit -m "Release 1.14."
68
bzr commit -m "(jam) Release 0.12rc1."
133
70
The diff before you commit will be something like::
135
=== modified file 'NEWS'
136
--- NEWS 2008-09-17 23:09:18 +0000
137
+++ NEWS 2008-09-23 16:14:54 +0000
145
+This release includes many bug fixes and a few performance and feature
146
+improvements. ``bzr rm`` will now scan for missing files and remove them,
147
+like how ``bzr add`` scans for unknown files and adds them. A bit more
148
+polish has been applied to the stacking code. The b-tree indexing code has
149
+been brought in, with an eye on using it in a future repository format.
150
+There are only minor installer changes since bzr-1.7rc2.
152
bzr 1.7rc2 2008-09-17
153
---------------------
156
=== modified file 'bzrlib/__init__.py'
157
--- bzrlib/__init__.py 2008-09-16 21:39:28 +0000
158
+++ bzrlib/__init__.py 2008-09-23 16:14:54 +0000
160
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
161
# releaselevel of 'dev' for unreleased under-development code.
163
-version_info = (1, 7, 0, 'candidate', 2)
164
+version_info = (1, 7, 0, 'final', 0)
167
# 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::
179
bzr pqm-submit -m "(mbp) prepare 1.14"
72
=== modified file 'NEWS'
73
--- NEWS 2006-10-23 13:11:17 +0000
74
+++ NEWS 2006-10-23 22:50:50 +0000
77
+bzr 0.12rc1 2006-10-23
82
=== modified file 'bzrlib/__init__.py'
83
--- bzrlib/__init__.py 2006-10-16 01:47:43 +0000
84
+++ bzrlib/__init__.py 2006-10-23 22:49:46 +0000
86
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
87
# releaselevel of 'dev' for unreleased under-development code.
89
-version_info = (0, 12, 0, 'dev', 0)
90
+version_info = (0, 12, 0, 'candidate', 1)
92
if version_info[3] == 'final':
93
version_string = '%d.%d.%d' % version_info[:3]
95
#. Submit those changes to PQM for merge into the appropriate release
181
98
#. When PQM succeeds, pull down the master release branch.
184
100
Making the source tarball
185
101
-------------------------
187
#. Change into the source directory and run ::
103
#. Change into the source directory and run
191
#. Now we'll try expanding this tarball and running the test suite
192
to check for packaging problems::
194
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
107
#. Unpack the tarball into a temporary directory and run ``make check`` in
108
that directory, to check for packaging problems.
222
111
Publishing the release
223
112
----------------------
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
114
Now you have the releasable product. The next step is making it
228
115
available to the world.
232
#. Within that release, upload the source tarball and zipfile and the GPG
233
signature. Or, if you prefer, use the
234
``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
247
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.
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 the GPG signature.
123
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
125
#. Update http://doc.bazaar-vcs.org/ to have a directory of documentation
126
for this release. (Controlled by the ``update-bzr-docs`` script on
127
escudero, and also update the ``latest`` symlink in
128
``/srv/bazaar.canonical.com/doc/``.)
130
#. Announce on the `Bazaar home page`__
132
__ http://bazaar-vcs.org/
252
135
Announcing the release
255
138
Now that the release is publicly available, tell people about it.
257
#. 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>
294
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
295
ensuring the new topic text keeps the project name, web site link, etc.
140
#. Announce to ``bazaar-announce`` and ``bazaar`` mailing lists.
141
The announce mail will look something like this:
143
| Subject: bzr 0.11 release candidate 1
145
| INTRO HERE. Mention the release number and date, and why the release. (i.e. release candidate for testing, final release of a version, backport/bugfix etc).
148
| http://bazaar-vcs.org/releases/src/bzr-VERSION.tar.gz
150
| http://bazaar-vcs.org/releases/src/bzr-VERSION.tar.gz.sig
152
| DESCRIBE-CHANGES-IN-OVERVIEW-HERE
154
| DESCRIBE-when the next release will be (if there is another - i.e. this is a release candidate)
156
| Many thanks to all the contributors to this release! I've included the
157
| contents of NEWS for VERSION below:
159
To generate the data from NEWS, just copy and paste the relevant news section and clean it up as appropriate. The main clean-up task is to confirm that all major changes are indeed covered. This can be done by running ``bzr log`` back to the point when the branch was opened and cross checking the changes against the NEWS entries.
161
(RC announcements should remind plugin maintainers to update their plugins.)
163
* For point releases (i.e. a release candidate, or an incremental fix
164
to a released version) take everything in the relevant NEWS section. For
165
example, for 0.11rc2 take everything in NEWS from the bzr 0.11rc2 line to the bzr 0.11rc1 line further down.
167
* For major releases (i.e. 0.11, 0.12 etc), take all the combined NEWS sections from within that version: for 0.11 take all of the 0.11 specific section, plus 0.11rc2, plus 0.11rc1 etc.
169
#. Update the IRC channel topic. Use the ``/topic`` command to do this, ensuring the new topic text keeps the project name, web site link, etc.
297
171
#. 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.
173
This should be done for both release candidates and final releases. If you do not have a Freshmeat account yet, ask one of the existing admins.
175
#. Update http://en.wikipedia.org/wiki/Bzr -- this should be done for final releases but not Release Candidates.
177
#. Package maintainers should update packages when they see the
182
#. Post to http://mail.python.org/mailman/listinfo/python-announce-list for major releases
306
184
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
307
185
done by running ::
323
197
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
324
198
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.
360
vim: filetype=rst textwidth=74 ai shiftwidth=4
201
Updating the PPA for a new release
202
----------------------------------
204
We build Ubuntu ``.deb`` packages for Bazaar as an important part of the release
205
process. These packages are hosted in a `Personal Package Archive (PPA)`__ on
206
Launchpad, at <https://launchpad.net/~bzr/+archive>.
208
__ https://help.launchpad.net/PPAQuickStart
210
We build packages for every supported Ubuntu release
211
<https://wiki.ubuntu.com/Releases>. Packages need no longer be updated
212
when the release passes end-of-life because all users should
215
The ``debian/`` directory containing the packaging information is kept in
216
branches on Launchpad, named like
217
<https://code.launchpad.net/~bzr/bzrtools/packaging-dapper>.
219
Preconditions for building these packages:
221
* You must have a Launchpad account and be a member of the `~bzr`__ team
223
__ https://edge.launchpad.net/~bzr/+members>
225
* You must have a GPG key registered to your Launchpad account.
227
* Configure ``dput`` to upload to our PPA with this section in your
231
fqdn = ppa.launchpad.net
233
incoming = ~bzr/ubuntu
235
allow_unsigned_uploads = 0
237
* You need a Ubuntu (or probably Debian) machine, and ::
239
sudo apt-get install build-essential devscripts dput
241
Here is the process; there are some steps which should be automated in
244
#. You will need a working directory for each supported release, such as
245
``~/bzr/Packaging/dapper``
247
#. Download the official tarball of the release to e.g. ``~/bzr/Releases``
249
#. Copy the original tarball into your per-disto directory, then untar it
250
and if necessary rename it::
252
cp -l ~/bzr/Releases/bzrtools-1.3.0.tar.gz bzrtools_1.3.0.orig.tar.gz
253
tar xfvz bzrtools_1.3.0.orig.tar.gz
254
mv bzrtools bzrtools-1.3.0
256
#. Change into that directory and check out the packaging branch::
260
bzr+ssh://bazaar.launchpad.net/~bzr/bzrtools/packaging-dapper \
263
#. For Bazaar plugins, change the ``debian/control`` file to express a
264
dependency on the correct version of ``bzr``.
266
For bzrtools this is typically::
268
Build-Depends-Indep: bzr (>= 1.3~), rsync
269
Depends: ${python:Depends}, bzr (>= 1.3~), bzr (<< 1.4~), patch
271
#. Make a new ``debian/changelog`` entry for the new release,
272
either by using ``dch`` or just editing the file::
274
dch -v '1.3.0-1~bazaar1~dapper1' -D dapper
276
dch will default to the distro you're working in and this isn't checked
277
against the version number (which is just our conversion), so make sure
280
**Caution:** Release candidates must insert a tilde to make them sort before the
281
final release, like this: ``bzr-1.4~rc2-1~bazaar1~dapper1``.
283
Make sure you have the correct email address for yourself, version
284
number, and distribution. It should look something like this::
286
bzrtools (1.3.0-1~bazaar1~dapper1) dapper; urgency=low
288
* New upstream release.
290
-- John Sample <sample@example.com> Mon, 31 Mar 2008 12:36:27 +1100
292
If you need to upload the package again to fix a problem, normally you
293
should increment the last number in the version number, following the
294
distro name. Make sure not to omit the initial ``-1``, and make sure
295
that the distro name in the version is consistent with the target name
296
outside the parenthesis.
298
#. Commit these changes into the packaging branch::
300
bzr ci -m '1.3.0-1~bazaar1~dapper1: New upstream release.' debian
302
#. Build a source package::
306
This will create a ``.changes`` file in the per-distro directory,
307
and should invoke gpg to sign it with your key.
308
Check that file is reasonable: it should be uploading to the intended
309
distribution, have a .orig file included, and the right version number.
311
#. Upload into the PPA::
313
dput bzr-ppa ../bzrtools__1.3.0-1\~bazaar1\~dapper1_source.changes
315
Don't forget the ``bzr-ppa`` component or dput will try to upload into
316
the main archive by default. You can disable this by adding this
317
section to your ``.dput.cf``::
320
fqdn = SPECIFY.A.PPA.NAME
322
#. You should soon get an "upload accepted" mail from Launchpad, which
323
means that your package is waiting to be built. You can then track its
324
progress in <https://launchpad.net/~bzr/+archive> and
325
<https://launchpad.net/~bzr/+archive/+builds>.
added
removed
doc/developers/releasing.txt
