24
23
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
26
25
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
27
Release provisional planning
28
============================
30
We currently maintain four series. Concurrently releasing them all at the
31
same time makes it harder to shorten the delay between the source
32
availability and the package building longer than necessary (we delay the
33
official announcement until most of our users can install the new release).
35
In order to continue to do time-based releases, we need to plan the
36
releases by series to minimize the collisions.
38
We want to respect the following rules::
40
* the most recent series should release once a month,
42
* the most recent stable series should release every other month (based
43
on the amount of bug fixes, this can be shorter or longer depending
44
on the bugs importance),
46
* previous series should relesase on a a regular basis without
47
interfering with the most recent series with a decreasing order of
48
priority (again this should be based on bugs importance and user
51
* the death of a series should be planned ahead of time. 6 months
52
should give enough time to our users to migrate to a more recent
55
* there should not be more than 2 releases in the same week (but the
56
Release Manager is free to ignore this (get in touch with packagers
59
* the series are aligned with Ubuntu releases for convenience since we
60
create a new series every 6 months. This means that we support the
61
stable series for 2 years. Note that we also propose the most recent
62
stable series via the ppa, so whether we keep supporting LTS directly
63
or via the ppa is still an open question.
69
The 2.3 series has entered the beta phase and 2.3.0 should be released soon
70
enough to be included into Natty Narwhal. This gives the following expected
88
The 2.2 series is the current stable release and is included in Maverick
89
Meerkat. The planned releases are::
103
The 2.1 series is the stable release included in Lucid Lynx. The planned
124
The 2.0 series is the stable release included in Karmic Koala. The planned
127
* 2.0.7: 2011-03 will be the last release for the 2.0 series.
144
At the start of a release cycle
145
===============================
32
147
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
149
#. If this is the first release for a given *x.y* then create a new
150
series at <https://launchpad.net/bzr/+addseries>. There is one series
151
for every *x.y* release.
153
#. If you made a new series, create a new pqm-controlled branch for this
154
release series, by asking a Canonical sysadmin. This branch means that
155
from the first release beta or candidate onwards, general development
156
continues on the trunk, and only specifically-targeted fixes go into
159
#. If you made a new series, add milestones at
160
<https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for
161
the beta release, release candidate and the final release, and their
164
#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>
165
and add information about this release. We will not use it yet, but it
42
166
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
168
#. Send mail to the list with the key dates, who will be the release
63
169
manager, and the main themes or targeted bugs. Ask people to nominate
64
170
objectives, or point out any high-risk things that are best done early,
82
188
submit_to = bazaar@lists.canonical.com
83
189
smtp_server = mail.example.com:25
85
Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
191
Please see <http://doc.bazaar.canonical.com/developers/HACKING.html#an-overview-of-pqm>
86
192
for more details on PQM
194
#. Update the version number in the ``bzr`` script, and the
195
``bzrlib/__init__.py`` file::
197
version_info = (x, y, z, 'dev', 0)
199
#. Add a new section at the top of ``NEWS`` about the new release,
200
including its version number and the headings from
201
``NEWS-template.txt``.
203
#. Update the "What's New" documents in ``doc/en/whats-new``.
205
#. Commit this and send it to PQM.
208
Doing a particular release
209
==========================
211
Update the source code
212
----------------------
214
#. Check that there is a milestone for the release you're doing. If there
215
is no milestone it indicates a process problem - make the milestone but
216
also mail the list to raise this issue in our process. Milestones are
217
found at <https://launchpad.net/bzr/+milestone/x.y.z>.
88
219
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
89
220
Make sure the corresponding milestone exists.
90
221
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
93
224
For beta releases use::
226
version_info = (2, 1, 0, 'beta', SERIAL)
95
230
version_info = (2, 1, 0, 'beta', 1)
98
232
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.
234
version_info = (2, 0, 1, 'candidate', SERIAL)
236
For stable releases use::
238
version_info = (2, 1, 2, 'final', 0)
240
#. Update the ``./NEWS`` section for this release.
242
Fill out the date and a description of the release under the existing
243
header. If there isn't one, follow the above for using the NEWS
246
See *2.1.1* or similar for an example of what this looks like.
248
#. Add a summary of the release into the "What's New" document.
118
250
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
119
251
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
121
253
./tools/check-newsbugs.py NEWS
123
(But note there can be some false positives, and this script may be
255
(But note there will be many false positives, and this script may be
124
256
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
125
257
this slow you down too much.)
127
#. Summarize into one or two paragraphs what's new in this release.
129
259
#. Commit these changes to the release branch, using a command like::
131
261
bzr commit -m "Release 1.14."
199
337
disable the faulty plugins one by one until you get no more
340
Remember that PQM has just tested everything too, this step is
341
particularly testing that the pyrex extensions, which are updated
342
by your local pyrex version when you run make dist, are in good
203
346
Publishing the source tarball
204
347
-----------------------------
206
349
#. 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.
351
#. Create a release of the milestone, and upload the source tarball and
352
the GPG signature. Or, if you prefer, use the
353
``tools/packaging/lp-upload-release`` script to do this. Note that
354
this changes what the download widget on the Launchpad bzr home
355
page shows, so don't stop the release process yet, or platform binary
356
installers won't be made and the download list will stay very small!
357
<https://bugs.launchpad.net/launchpad/+bug/586445>
213
360
Announcing the source freeze
214
361
----------------------------
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
363
#. Post to the ``bazaar`` list, saying that the source has been frozen
364
(gone gold). Be extra clear that this is only a *source* release
365
targeted at packagers and installer builders (see
366
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue
367
for platform maintainers and plugin authors to update their code. This
368
is done before the general public announcement of the release.
371
Kick off the next cycle
372
-----------------------
374
#. To let developers work on the next release, do
375
`At the start of a release cycle` now.
377
#. Pause for a few days.
222
380
Publishing the release
227
385
we have a releasable product. The next step is to make it generally
228
386
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/>`_.
388
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
390
#. Announce on the `Bazaar website <http://bazaar.canonical.com/>`_.
240
391
This page is edited via the lp:bzr-website branch. (Changes
241
392
pushed to this branch are refreshed by a cron job on escudero.)
243
#. Announce on the `Bazaar wiki <http://bazaar-vcs.org/Welcome>`_.
245
394
#. Check that the documentation for this release is available in
246
<http://doc.bazaar-vcs.org>. It should be automatically build when the
395
<http://doc.bazaar.canonical.com>. It should be automatically build when the
247
396
branch is created, by a cron script ``update-bzr-docs`` on
248
397
``escudero``. As of today (2009-08-27) ``igc`` manually updates the
249
398
pretty version of it.
271
420
The announce mail will look something like this::
273
Subject: bzr x.yy released!
275
<<Summary paragraph from news>>
422
Subject: bzr x.y.z released!
277
424
The Bazaar team is happy to announce availability of a new
278
425
release of the bzr adaptive version control system.
279
426
Bazaar is part of the GNU system <http://gnu.org/>.
428
<<Summary paragraph from news>>
281
430
Thanks to everyone who contributed patches, suggestions, and
284
433
Bazaar is now available for download from
285
http://bazaar-vcs.org/Download as a source tarball; packages
434
https://launchpad.net/bzr/2.x/2.x/ as a source tarball; packages
286
435
for various systems will be available soon.
288
437
<<NEWS section from this release back to the last major release>>
341
493
candidate, you're not finished yet. Another beta or candidate or
342
494
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
496
The process is the same as for the first release. Goto `Doing a
497
particular release`_ and follow the instructions again. Some details change
346
498
between beta, candidate and final releases, but they should be
347
499
documented. If the instructions aren't clear enough, please fix them.
502
Getting the release into Ubuntu
503
-------------------------------
505
(Feel free to propose or add new sections here about what we should do to
506
get bzr into other places.)
508
For the currently-under-development release of Ubuntu, no special action
509
is needed: the release should be picked by Debian and synced from there into
512
Releases off stable bzr branches should go in to the ``-updates`` of the
513
Ubuntu release that originally contained that branch. (Ubuntu Lucid had
514
bzr 2.2.0, so should get every 2.2.x update.) This means going through
515
the `SRU (Stable Release Updates)
516
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.
518
As of September 2010, bzr has applied to the technical board to be added
519
to the `MicroReleaseExceptions
520
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
521
category so that whole bugfix releases can more easily be approved.
523
**After making a bzr stable-release release, nominate the most serious bug
524
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
526
This requires a couple of tricks (please reconsider and tweak as things
527
evolves from one release to the other):
529
* create a distro task with the ``Also affects distribution`` button and
530
select ``bzr (Ubuntu)``.
532
* change the *URL* to point to ``ubuntu/+source/bzr`` instead of ``bzr``
533
(this is needed if you create the distro task but not if it exists
534
already). You should now be able to click the ``Nominate for release``
535
button and select the right Ubuntu release. As of September 2010, this
538
* ``maverick`` for the 2.2 series,
539
* ``lucid`` for the 2.1 series,
540
* ``karmic`` for the 2.0 series.
542
* Subscribe the ``~ubuntu-sru`` team to the bug.
544
* Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
545
(we are targeting running the test suite during the build which, as of
546
September 2010, fails for known reasons that are currently addressed).
547
Search for bugs tagged with ``sru`` for examples and don't forget to tag
548
the bug you selected.
added
removed
doc/developers/releasing.txt
