« back to all changes in this revision
Viewing changes to doc/developers/releasing.txt
- browse files at revision 6046
- compare with another revision
- download diff
- download tarball
- view history from revision 6046
- Committer: Canonical.com Patch Queue Manager
- Date: 2011-07-27 03:03:49 UTC
- mfrom: (6015.3.7 trivial)
- Revision ID: pqm@pqm.ubuntu.com-20110727030349-wcq2ay0knn995ae4
(mbp) log a message when we get a EINVAL on a transport operation (Martin
Pool)
Pool)
- files removed:
- bzrlib/tests/per_intertree/test_file_content_matches.py
- files modified:
- bzrlib/branch.py
added
removed
doc/developers/releasing.txt
2
2
################
3
3
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
7
<http://doc.bazaar.canonical.com/developers/cycle.html>`_, (go re-read this
8
document to ensure it hasn't been updated since you last read it) but it's
9
the most complex part.
10
11
If you're doing your first release you can follow this document and read
12
each step explanation. It's also a good practice to read it for any release
13
to ensure you don't miss a step and to update it as the release process
14
evolves.
5
release, and managing the release process. This is just one phase of
6
the `overall development cycle
7
<http://doc.bazaar.canonical.com/developers/cycle.html>`_, (go re-read
8
this document to ensure it hasn't been updated) but it's the most
9
complex part. This document gives a checklist you can follow from start
10
to end in one go.
15
11
16
12
If you're helping the Release Manager (RM) for one reason or another, you
17
13
may notice that he didn't follow that document scrupulously. He may have
18
14
good reasons to do that but he may also have missed some parts.
19
15
16
Follow the document yourself and don't hesitate to create the missing
17
milestones for example (we tend to forget these ones a lot).
18
20
19
.. contents::
21
20
22
21
23
22
Preconditions
24
23
=============
25
24
26
#. PQM access rights (or you won't be able to land any change)
27
28
25
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
29
26
30
27
bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
31
28
32
#. Alternatively, you can download and install ``lp:hydrazine`` (the main
33
difference is that hydrazine requires the branch to land to be hosted on
34
launchpad).
35
36
What do we release
37
==================
38
39
In this document, we're talking about source releases only, packages and
40
installers are built from this but we won't talk about them here.
41
42
Every release is part of a series, ``bzr-2.4.1`` is part of series ``2.4``.
43
44
We do two different kind of releases: the betas releases and the stable
45
releases for a given series.
46
47
For a given series, releases will be done to deliver new versions of bzr to
48
different kinds of users:
49
50
#. beta releases: named ``x.ybn`` where ``x.y`` is the series and ``n``
51
starts at 1 and is incremented. These releases are targeted to beta
52
testers who don't want to run from source but are interested in features
53
or improvements.
54
55
#. stable releases: name ``x.y.z`` where ``x.y.`` is the series and ``z``
56
starts at 1 and is incremented. These releases are targeted at people
57
that want bugfixes only and no new features.
58
59
60
Differences in the release process between beta and stable release will be
61
mentioned when needed.
62
29
63
30
When do we relase ?
64
31
===================
65
32
66
As of July 2011, we maintain four series (and one that is about to be EOLed).
67
Concurrently releasing them all at the same time makes it harder to shorten
68
the delay between the source availability and the package building longer
69
than necessary (we delay the official announcement until most of our users
70
can install the new release).
33
As of October 2010, we mantain four series. Concurrently releasing them
34
all at the same time makes it harder to shorten the delay between the
35
source availability and the package building longer than necessary (we
36
delay the official announcement until most of our users can install the new
37
release).
71
38
72
39
In order to continue to do time-based releases, we need to plan the
73
40
releases by series to minimize the collisions. In the end, it's the Release
74
41
Manager call to decide whether he prefers to do all releases at once
75
42
though, so the rules presented here are a conservative approach.
76
43
77
We want to respect the following rules:
78
79
#. as much as possible releases should not disturb development, and
80
ongoing development should not disturb releases,
81
82
#. the most recent development series should release once a month during
83
the beta period (see `Development cycles <cycle.html>`_ for more
84
details),
85
86
#. the most recent stable series should release every other month (based
87
on the amount of bug fixes, this can be shorter or longer depending on
88
the bugs importance),
89
90
#. previous series should release on a regular basis without interfering
91
with the most recent series with a decreasing order of priority (again
92
this should be based on bugs importance and user feedback),
93
94
#. the death of a series should be planned ahead of time. 6 months should
95
give enough time to our users to migrate to a more recent series. This
96
doesn't mean we will make a release at the end of the series, just that
97
before the end date we *could* possibly put out another release if
98
there was a sufficiently important fix. Beyond that date, we won't
99
even land changes on that branch (unless something causes a miraculous
100
resurrection.)
101
102
#. there should not be more than 2 releases in the same week (but the
103
Release Manager is free to ignore this (get in touch with packagers
104
though),
105
106
#. the series are aligned with Ubuntu releases for convenience since we
107
create a new series every 6 months. This means that we support the
108
stable series for 18 months. Note that we also propose the most recent
109
stable series via the stable PPA but that the SRU processs allow us to
110
reach a wider audience.
111
112
At the start of a series cycle
113
==============================
114
115
To start a new series cycle:
116
117
#. Create a new series ``x.y`` at <https://launchpad.net/bzr/+addseries>.
118
119
#. Add milestones at <https://launchpad.net/bzr/x.y/+addmilestone> to that
120
series for the beta releases and the stable series mentioning their
121
expected dates. Only the milestone associated to the next release in
122
this series should be left active to avoid clutter when targeting bugs.
123
124
#. If you made a new series, you will need to create a new pqm-controlled
125
branch for this release series. This branch will be used only from the
126
first non-beta release onwards. It needs to be created by a Canonical
127
sysadmin (ask the core devs for instructions or to do it for you).
128
129
#. Start a new release-notes file::
130
131
cd doc/en/release-notes
132
cp series-template.txt bzr-x.y.txt # e.g. bzr-2.3.txt
133
bzr add bzr-x.y.txt
134
135
#. Start a new whats-new file::
136
137
cd doc/en/whats-new
138
cp template.txt bzr-x.y.txt # e.g. bzr-2.6.txt
139
bzr add bzr-x.y.txt
44
We want to respect the following rules::
45
46
#. as much as possible releases should not disturb development, and
47
ongoing development should not disturb releases,
48
49
#. the most recent development series should release once a month during
50
the beta period (see `Development cycles <cycle.html>`_ for more
51
details),
52
53
#. the most recent stable series should release every other month (based
54
on the amount of bug fixes, this can be shorter or longer depending on
55
the bugs importance),
56
57
#. previous series should relesase on a regular basis without interfering
58
with the most recent series with a decreasing order of priority (again
59
this should be based on bugs importance and user feedback),
60
61
#. the death of a series should be planned ahead of time. 6 months should
62
give enough time to our users to migrate to a more recent series. This
63
doesn't mean we will make a release at the end of the series, just that
64
before the end date we _could_ possibly put out another release if
65
there was a sufficiently important fix. Beyond that date, we won't
66
even land changes on that branch (unless something causes a miraculous
67
resurrection.)
68
69
#. there should not be more than 2 releases in the same week (but the
70
Release Manager is free to ignore this (get in touch with packagers
71
though),
72
73
#. the series are aligned with Ubuntu releases for convenience since we
74
create a new series every 6 months. This means that we support the
75
stable series for 18 months. Note that we also propose the most recent
76
stable series via the ppa, so whether we keep supporting LTS directly
77
or via the ppa is still an open question.
140
78
141
79
142
80
At the start of a release cycle
144
82
145
83
To start a new release cycle:
146
84
85
#. If this is the first release for a given *x.y* then create a new
86
series at <https://launchpad.net/bzr/+addseries>. There is one series
87
for every *x.y* release.
88
89
#. If you made a new series, create a new pqm-controlled branch for this
90
release series, by asking a Canonical sysadmin. This branch means that
91
from the first release beta or candidate onwards, general development
92
continues on the trunk, and only specifically-targeted fixes go into
93
the release branch.
94
95
#. If you made a new series, add milestones at
96
<https://launchpad.net/bzr/x.y/+addmilestone> to that series for
97
the beta release, release candidate and the final release, and their
98
expected dates.
99
100
#. Create a new milestone <https://launchpad.net/bzr/x.y/+addmilestone>
101
and add information about this release. We will not use it yet, but it
102
will be available for targeting or nominating bugs.
103
147
104
#. Send mail to the list with the key dates, who will be the release
148
105
manager, and the main themes or targeted bugs. Ask people to nominate
149
106
objectives, or point out any high-risk things that are best done early,
150
107
or that interact with other changes. This is called the metronome mail
151
108
and is described in `Development cycles <cycle.html>`_.
152
109
153
#. Make a local branch to prepare the release::
154
155
bzr branch lp:bzr/x.y x.y-dev
156
157
If you're doing your first beta release, branch from trunk::
158
159
bzr branch lp:bzr x.y-dev
160
161
Note that you will generally reuse the same branch for all releases in a
162
given series.
110
#. Make a local branch for preparing this release. (Only for the first
111
release in a series, otherwise you should already have a branch.) ::
112
113
bzr branch trunk prepare-1.14
163
114
164
115
#. Configure pqm-submit for this branch, with a section like this (where
165
``x.y`` is the series for your release). **Or use hydrazine for easier
166
setup** ``~/.bazaar/locations.conf``::
116
x.y is the version to release). **Or use hydrazine for easy use**
117
``~/.bazaar/locations.conf``::
167
118
168
[/home/mbp/bzr/x.y-dev]
119
[/home/mbp/bzr/prepare-x.y]
169
120
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
170
121
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
171
122
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
172
public_branch = http://bazaar.example.com/x.y-dev
123
public_branch = http://bazaar.example.com/prepare-x.y
173
124
submit_to = bazaar@lists.canonical.com
174
125
smtp_server = mail.example.com:25
175
126
181
132
182
133
version_info = (x, y, z, 'dev', 0)
183
134
135
#. If you made a new series, then start a new release-notes file::
136
137
cd doc/en/release-notes
138
cp series-template.txt bzr-x.y.txt # e.g. bzr-2.3.txt
139
bzr add bzr-x.y.txt
140
184
141
#. Add a new section at the top of the current release notes (in
185
142
``doc/en/release-notes``) about the new release, including its version
186
143
number and the headings from ``release-template.txt``.
187
144
188
145
#. Update the "What's New" documents in ``doc/en/whats-new``.
189
146
190
#. Make sure a milestone exists for your release and that it is active,
191
<https://launchpad.net/bzr/x.y> lists the existing milestones,
192
<https://launchpad.net/bzr/x.y/x.y.z/+edit> allows you to toggle the
193
active flag.
194
195
147
#. Commit this and send it to PQM.
196
148
197
149
209
161
#. In the release branch, update ``version_info`` in ``./bzrlib/__init__.py``.
210
162
Make sure the corresponding milestone exists.
211
163
Double check that ./bzr ``_script_version`` matches ``version_info``. Check
212
the output of ``./bzr --version``.
164
the output of ``bzr --version``.
213
165
214
166
For beta releases use::
215
167
219
171
220
172
version_info = (2, 1, 0, 'beta', 1)
221
173
174
For release candidates use::
175
176
version_info = (2, 0, 1, 'candidate', SERIAL)
177
222
178
For stable releases use::
223
179
224
180
version_info = (2, 1, 2, 'final', 0)
231
187
232
188
See *2.1.1* or similar for an example of what this looks like.
233
189
234
#. Add or check the summary of the release into the "What's New" document.
190
#. Add a summary of the release into the "What's New" document.
235
191
236
192
#. To check that all bugs mentioned in the release notes are actually
237
193
marked as closed in Launchpad, you can run
239
195
240
196
./tools/check-newsbugs.py doc/en/release-notes/bzr-x.y.txt
241
197
242
As of 2011-07-18, all bugs mentioned in the output of the script requires
243
some sort of intervention (either changing the status if it's not 'Fix
244
Released' or setting a different milestone if the bug hasn't been
245
fixed). A few false positives may remain in the older series, don't let
246
this slow you down too much. This script accepts options you may find
247
useful, use ``./tools/check-newsbugs.py`` to display its usage.
198
As of 2011-05-26, only a few false positives remain in the older
199
series. Don't let this slow you down too much. This script accepts
200
options you may find useful, use ``./tools/check-newsbugs.py`` to display
201
its usage.
248
202
249
203
#. Commit these changes to the release branch, using a command like::
250
204
322
276
323
277
bzr tag bzr-2.3.1
324
278
325
#. Push those changes to a bzr branch that is public and accessible on the
326
Internet. PQM will pull from this branch when it attempts to merge your
327
changes. Then submit those changes to PQM for merge into the appropriate
328
release branch::
279
#. Push those changes to a bzr repository that is public and accessible on
280
the Internet. PQM will pull from this repository when it attempts to merge
281
your changes. Then submit those changes to PQM for merge into the
282
appropriate release branch::
329
283
330
284
bzr push
331
285
bzr pqm-submit -m "(vila) Release 2.3.1 (Vincent Ladeuil)"
366
320
Publishing the source tarball
367
321
-----------------------------
368
322
369
#. Go to the relevant <https://launchpad.net/bzr/x.y> series page in Launchpad.
323
#. Go to the relevant series page in Launchpad.
370
324
371
325
#. Create a release of the milestone, and upload the source tarball and
372
326
the GPG signature. Or, if you prefer, use the
377
331
<https://bugs.launchpad.net/launchpad/+bug/586445>
378
332
379
333
380
Kick off the next cycle
381
-----------------------
382
383
From that point, there is no possible return, the tarball has been uploaded
384
so you can relax a bit.
385
386
You're still holding a "social" lock on the launchpad branch though. Until
387
your start the next cycle, nobody should land anything on this branch. If
388
they do, they either targeted the wrong branch or didn't update the news
389
file correctly, so the sooner the branch is opened again, the better.
390
391
This matters more for ``lp:bzr`` than for ``lp:bzr/x.y``, ``lp:bzr`` should
392
always be open for landing, so you should do `At the start of a release
393
cycle`_ as soon as possible (i.e. update the version number in ``bzr`` and
394
``bzrlib/__init__``, create/update the news files and create/update the
395
milestone for the next relase).
396
397
You may also need to do `At the start of a series cycle`_ if you're starting
398
a new series.
399
400
A word of caution: the instructions above works well for all releases but
401
there is one special case that requires a bit more care: when you release
402
the *last* beta for a given ``x.y`` series (from trunk aka lp:bzr), you need
403
to setup *two* branches for the next cycle:
404
405
#. ``lp:bzr`` needs to be opened for the next *series* ``x.(y+1)``
406
407
#. ``lp:bzr/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
408
series. Since this is first real use of ``lp:bzr/x.y``, this is also the
409
deadline for the PQM branch to be created.
410
411
Both are important as ``lp:bzr`` should remain open so any change can be
412
landed, ``lp:bzr/x.y`` on the other hand should be ready to receive bug
413
fixes.
414
415
``lp:bzr`` is generally more important as the bug fixes on ``lp:bzr/x.y``
416
won't be released sooner than a month from now whereas people may already
417
been waiting to land on ``lp:bzr``.
418
419
In a nutshell:
420
421
#. Create or update the ``x.y`` PQM branch based on whatever
422
revision you want to release
423
424
#. Open ``lp:bzr`` for ``x.(y+1)``
425
426
#. Release ``x.y.0`` from ``lp:bzr/x.y``
427
428
#. Open ``lp:bzr/x.y`` for bug fixes
429
430
334
Announcing the source freeze
431
335
----------------------------
432
336
437
341
for platform maintainers and plugin authors to update their code. This
438
342
is done before the general public announcement of the release.
439
343
344
345
Kick off the next cycle
346
-----------------------
347
348
#. To let developers work on the next release, do
349
`At the start of a release cycle` now.
350
440
351
#. Pause for a few days.
441
352
442
353
467
378
468
379
#. Make an announcement mail.
469
380
470
For beta releases, this is sent to the ``bazaar@lists.canonical.com``
471
list only to inform plugin authors and people responsible for building
472
packages or installers.
381
For release candidates or beta releases, this is sent to the ``bazaar``
382
list only to inform plugin authors and package or installer managers.
473
383
474
384
Once the installers are available, the mail can be sent to the
475
385
``bazaar-announce`` list too.
476
386
477
For stable releases, it should also be cc'd to ``info-gnu@gnu.org``,
387
For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
478
388
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
479
389
480
390
In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
503
413
504
414
#. Make an announcement through <https://launchpad.net/bzr/+announce>
505
415
416
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
417
ensuring the new topic text keeps the project name, web site link, etc.
418
506
419
#. Announce on http://freshmeat.net/projects/bzr/
507
420
508
This should be done for beta releases and stable releases. If you do not
509
have a Freshmeat account yet, ask one of the existing admins.
421
This should be done for beta releases, release candidates and final
422
releases. If you do not have a Freshmeat account yet, ask one of the
423
existing admins.
510
424
511
425
The purpose here is to point users to the latest stable release while still
512
publishing announcements for beta releases.
426
publishing announcements for development releases.
513
427
514
428
There are several kinds of modifications that could be done there via the
515
429
``Administration`` box in the lower right area of the page:
518
432
``Links`` box are edited. This should rarely change except for the URLs
519
433
related to the latest stable release.
520
434
521
* New announcement: When doing a release, put the summary of the release
522
(you can't embed URLs there, the moderation staff remove them). Users
523
can still access the releases notes via the ``Release Notes`` URL in
524
the ``Links`` box in the upper right area of the page. When doing the
525
first stable release in a series, delete the ``Unstable installers``
526
<https://launchpad.net/bzr/x.y/x.ybn> and ``Unstable source tarball``
435
* New announcement: When doing a release (beta, candidates, final), put the
436
summary of the release (you can't embed URLs there, the moderation staff
437
remove them). Users can still access the releases notes via the ``Release
438
Notes`` URL in the ``Links`` box in the upper right area of the
439
page. When doing the first stable release in a series, delete the
440
``Unstable installers`` <https://launchpad.net/bzr/x.y/x.ybn> and
441
``Unstable source tarball``
527
442
<http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
528
links. Conversely, when creating the first beta in a development
529
series, create these links again. Check all links when doing other
530
kinds of release.
443
links. Conversely, when creating the first beta in a development series,
444
create these links again. Check all links when doing other kinds of
445
release.
531
446
532
447
* Set direct download: When releasing a new stable release, this should
533
448
point to the corresponding launchpad page:
534
449
<https://launchpad.net/bzr/x.y/x.y.z/>
535
450
536
451
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
537
be done for the stable and beta releases.
452
be done for final releases but not for beta releases or Release Candidates.
538
453
539
454
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
540
455
done by running ::
541
456
542
457
python setup.py register
543
458
544
Remember to check the results afterward -- this should be done for
545
stable releases but not for beta releases.
459
Remember to check the results afterwards -- this should be done for
460
final releases but not for beta releases or Release Candidates.
546
461
547
462
To be able to register the release you must create an account on
548
463
<http://pypi.python.org/pypi> and have one of the existing owners of
552
467
Merging the released code back to trunk
553
468
---------------------------------------
554
469
555
Merge the release branch back into the trunk. The ``doc/en/release-notes``
556
changes should be merged into the right place because each release series
557
has its own release-notes file, but double-check.
470
Merge the release branch back into the trunk. The
471
``doc/en/release-notes`` changes should be merged into the right place
472
because each release series has its own release-notes file, but
473
double-check.
558
474
559
475
If it's not already done, advance the version number in ``bzr`` and
560
476
``bzrlib/__init__.py``. Submit this back into pqm for bzr.dev.
563
479
created the corresponding milestone to ensure the continuity in bug
564
480
targeting or nominating. Depending on the change, you may even have to
565
481
create a new series (if your change the major or minor release number), in
566
that case go to `At the start of a series cycle`_ and follow the
567
instructions from there.
482
that case go to `At the start of a release cycle` and follow the instructions from there.
568
483
484
You should also merge (not pull) the release branch into
485
``lp:~bzr/bzr/current``, so that branch contains the current released code
486
at any time.
569
487
570
488
Releases until the final one
571
489
----------------------------
572
490
573
Congratulations - you have made your first release. Have a beer or fruit
574
juice - it's on the house! If it was a beta, you're not finished
575
yet. Another beta or hopefully a stable release is still to come.
491
Congratulations - you have made your first release. Have a beer
492
or fruit juice - it's on the house! If it was a beta, or
493
candidate, you're not finished yet. Another beta or candidate or
494
hopefully a final release is still to come.
576
495
577
The process is the same as for the first release. Goto `Doing a particular
578
release`_ and follow the instructions again. Some details change between
579
beta and stable releases, but they should be documented. If the instructions
580
aren't clear enough, please fix them.
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
498
between beta, candidate and final releases, but they should be
499
documented. If the instructions aren't clear enough, please fix them.
581
500
582
501
583
502
Getting the release into Ubuntu
596
515
the `SRU (Stable Release Updates)
597
516
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.
598
517
599
Since September 2010, bzr has received approval by the technical
600
board for the `MicroReleaseExceptions
518
As of September 2010, bzr has applied to the technical board to be added
519
to the `MicroReleaseExceptions
601
520
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
602
category so that whole bugfix releases can more easily be
603
approved.
604
605
Progress on these realeases is tracked on the `SRU wiki
606
<http://wiki.bazaar.canonical.com/UbuntuStableReleaseUpdates>`_
607
page.
521
category so that whole bugfix releases can more easily be approved.
608
522
609
523
**After making a bzr stable-release release, nominate the most serious bug
610
524
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
621
535
button and select the right Ubuntu release. As of September 2010, this
622
536
means:
623
537
624
* ``oneiric`` for the 2.4 series,
625
* ``natty`` for the 2.3 series,
626
538
* ``maverick`` for the 2.2 series,
627
539
* ``lucid`` for the 2.1 series,
540
* ``karmic`` for the 2.0 series.
628
541
629
542
* Subscribe the ``~ubuntu-sru`` team to the bug.
630
543
Loggerhead is a web-based interface for Breezy
Version: 2.0.1