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.canonical.com/developers/cycle.html>`_,
7
but it's the most complex part. This document gives a checklist you can
8
follow from start to end in one go.
10
If you're helping the Release Manager (RM) for one reason or another, you
11
may notice that he didn't follow that document scrupulously. He may have
12
good reasons to do that but he may also have missed some parts.
14
Follow the document yourself and don't hesitate to create the missing
15
milestones for example (we tend to forget these ones a lot).
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
23
16
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
25
18
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
28
At the start of a release cycle
29
===============================
31
24
To start a new release cycle:
33
#. If this is the first release for a given *x.y* then create a new
34
series at <https://launchpad.net/bzr/+addseries>. There is one series
35
for every *x.y* release.
37
#. If you made a new series, create a new pqm-controlled branch for this
38
release series, by asking a Canonical sysadmin. This branch means that
39
from the first release beta or candidate onwards, general development
40
continues on the trunk, and only specifically-targeted fixes go into
43
#. If you made a new series, add milestones at
44
<https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for
45
the beta release, release candidate and the final release, and their
48
#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>
49
and add information about this release. We will not use it yet, but it
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/2.0>
31
#. Create a new release at
32
<https://launchpad.net/bzr/2.0/+addrelease> and add
33
information about this release. We will not use it yet, but it
50
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/2.0/+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.
52
49
#. Send mail to the list with the key dates, who will be the release
53
50
manager, and the main themes or targeted bugs. Ask people to nominate
54
51
objectives, or point out any high-risk things that are best done early,
55
52
or that interact with other changes. This is called the metronome mail
56
and is described in `Development cycles <cycle.html>`_.
58
#. Make a local branch for preparing this release. (Only for the first
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
#. Create a new milestone at <https://launchpad.net/bzr/2.0/+addmilestone>
62
for the beta release or release candidate.
64
#. Make a beta release or release candidate.
66
Preparing the tree for release
67
------------------------------
69
#. Make a local branch for preparing this release. (Only for the first
59
70
release in a series, otherwise you should already have a branch.) ::
61
72
bzr branch trunk prepare-1.14
63
#. Configure pqm-submit for this branch, with a section like this (where
64
x.y is the version to release). **Or use hydrazine for easy use**
74
#. Configure pqm-submit for this branch, with a section like this in
65
75
``~/.bazaar/locations.conf``::
67
[/home/mbp/bzr/prepare-x.y]
77
[/home/mbp/bzr/prepare-1.14]
68
78
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
69
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
70
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
71
public_branch = http://bazaar.example.com/prepare-x.y
79
submit_branch = lp:bzr/2.0
80
public_branch = http://bazaar.example.com/prepare-2.0
72
81
submit_to = bazaar@lists.canonical.com
73
82
smtp_server = mail.example.com:25
75
Please see <http://doc.bazaar.canonical.com/developers/HACKING.html#an-overview-of-pqm>
84
Please see <http://doc.bazaar-vcs.org/latest/developers/HACKING.html#an-overview-of-pqm>
76
85
for more details on PQM
78
#. Update the version number in the ``bzr`` script, and the
79
``bzrlib/__init__.py`` file::
81
version_info = (x, y, z, 'dev', 0)
83
#. Add a new section at the top of ``NEWS`` about the new release,
84
including its version number and the headings from
85
``NEWS-template.txt``.
87
#. Update the "What's New" documents in ``doc/en/whats-new``.
89
#. Commit this and send it to PQM.
92
Doing a particular release
93
==========================
95
Update the source code
96
----------------------
98
#. Check that there is a milestone for the release you're doing. If there
99
is no milestone it indicates a process problem - make the milestone but
100
also mail the list to raise this issue in our process. Milestones are
101
found at <https://launchpad.net/bzr/+milestone/x.y.z>.
103
87
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
104
Make sure the corresponding milestone exists.
105
88
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
106
89
the output of ``bzr --version``.
108
91
For beta releases use::
110
version_info = (2, 1, 0, 'beta', SERIAL)
114
93
version_info = (2, 1, 0, 'beta', 1)
116
96
For release candidates use::
118
version_info = (2, 0, 1, 'candidate', SERIAL)
120
For stable releases use::
122
version_info = (2, 1, 2, 'final', 0)
124
#. Update the ``./NEWS`` section for this release.
126
Fill out the date and a description of the release under the existing
127
header. If there isn't one, follow the above for using the NEWS
130
See *2.1.1* or similar for an example of what this looks like.
132
#. Add a summary of the release into the "What's New" document.
98
version_info = (2, 0, 1, 'candidate', 1)
101
#. Add the date and release number to ``./NEWS``
134
103
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
135
104
closed in Launchpad, you can run ``tools/check-newsbugs.py``::
137
106
./tools/check-newsbugs.py NEWS
139
(But note there will be many false positives, and this script may be
108
(But note there can be some false positives, and this script may be
140
109
flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>. Don't let
141
110
this slow you down too much.)
112
#. Summarize into one or two paragraphs what's new in this release.
143
114
#. Commit these changes to the release branch, using a command like::
145
bzr commit -m "Release 1.14."
116
bzr commit -m "Release 1.14."
147
118
The diff before you commit will be something like::
149
120
=== modified file 'NEWS'
150
121
--- NEWS 2008-09-17 23:09:18 +0000
151
122
+++ NEWS 2008-09-23 16:14:54 +0000
156
127
+bzr 1.7 2008-09-23
157
128
+------------------
346
295
Merging the released code back to trunk
347
296
---------------------------------------
349
The rule is to keep ``NEWS`` sections sorted by date. You'll need to
350
review the merge and make sure that that is respected.
352
298
Merge the release branch back into the trunk. Check that changes in NEWS
353
299
were merged into the right sections. If it's not already done, advance
354
300
the version number in ``bzr`` and ``bzrlib/__init__.py``. Submit this
355
301
back into pqm for bzr.dev.
357
As soon as you change the version number in trunk, make sure you have
358
created the corresponding milestone to ensure the continuity in bug
359
targeting or nominating. Depending on the change, you may even have to
360
create a new series (if your change the major or minor release number), in
361
that case go to `At the start of a release cycle` and follow the instructions from there.
363
303
You should also merge (not pull) the release branch into
364
304
``lp:~bzr/bzr/current``, so that branch contains the current released code
367
Releases until the final one
368
----------------------------
370
Congratulations - you have made your first release. Have a beer
371
or fruit juice - it's on the house! If it was a beta, or
372
candidate, you're not finished yet. Another beta or candidate or
373
hopefully a final release is still to come.
375
The process is the same as for the first release. Goto `Doing a
376
particular release`_ and follow the instructions again. Some details change
377
between beta, candidate and final releases, but they should be
378
documented. If the instructions aren't clear enough, please fix them.
381
Getting the release into Ubuntu
382
-------------------------------
384
(Feel free to propose or add new sections here about what we should do to
385
get bzr into other places.)
387
For the currently-under-development release of Ubuntu, no special action
388
is needed: the release should be picked by Debian and synced from there into
391
Releases off stable bzr branches should go in to the ``-updates`` of the
392
Ubuntu release that originally contained that branch. (Ubuntu Lucid had
393
bzr 2.2.0, so should get every 2.2.x update.) This means going through
394
the `SRU (Stable Release Updates)
395
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.
397
As of September 2010, bzr has applied to the technical board to be added
398
to the `MicroReleaseExceptions
399
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
400
category so that whole bugfix releases can more easily be approved.
402
**After making a bzr stable-release release, nominate the most serious bug
403
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
405
This requires a couple of tricks (please reconsider and tweak as things
406
evolves from one release to the other):
408
* create a distro task with the ``Also affects distribution`` button and
409
select ``bzr (Ubuntu)``.
411
* change the *URL* to point to ``ubuntu/+source/bzr`` instead of ``bzr``
412
(this is needed if you create the distro task but not if it exists
413
already). You should now be able to click the ``Nominate for release``
414
button and select the right Ubuntu release. As of September 2010, this
417
* ``maverick`` for the 2.2 series,
418
* ``lucid`` for the 2.1 series,
419
* ``karmic`` for the 2.0 series.
421
* Subscribe the ``~ubuntu-sru`` team to the bug.
423
* Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
424
(we are targeting running the test suite during the build which, as of
425
September 2010, fails for known reasons that are currently addressed).
426
Search for bugs tagged with ``sru`` for examples and don't forget to tag
427
the bug you selected.
added
removed
doc/developers/releasing.txt
