~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/releasing.txt

  • Committer: Vincent Ladeuil
  • Date: 2010-10-07 06:08:01 UTC
  • mto: This revision was merged to the branch mainline in revision 5491.
  • Revision ID: v.ladeuil+lp@free.fr-20101007060801-wfdhizfhfmctl8qa
Fix some typos and propose a release planning.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
 
4
4
This document describes the processes for making and announcing a Bazaar
5
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.
 
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.
15
9
 
16
10
If you're helping the Release Manager (RM) for one reason or another, you
17
11
may notice that he didn't follow that document scrupulously. He may have
18
12
good reasons to do that but he may also have missed some parts.
19
13
 
 
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).
 
16
 
20
17
.. contents::
21
18
 
22
19
 
23
20
Preconditions
24
21
=============
25
22
 
26
 
#. PQM access rights (or you won't be able to land any change)
27
 
 
28
23
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
29
24
 
30
25
     bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
31
26
 
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
 
 
63
 
When do we relase ?
64
 
===================
65
 
 
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).
 
27
Release provisional planning
 
28
============================
 
29
 
 
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).
71
34
 
72
35
In order to continue to do time-based releases, we need to plan the
73
 
releases by series to minimize the collisions. In the end, it's the Release
74
 
Manager call to decide whether he prefers to do all releases at once
75
 
though, so the rules presented here are a conservative approach.
76
 
 
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
 
36
releases by series to minimize the collisions.
 
37
 
 
38
We want to respect the following rules::
 
39
 
 
40
 * the most recent series should release once a month,
 
41
 
 
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),
 
45
 
 
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
 
49
   feedback,
 
50
 
 
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
 
53
   series,
 
54
 
 
55
 * there should not be more than 2 releases in the same week (but the
103
56
   Release Manager is free to ignore this (get in touch with packagers
104
57
   though),
105
58
 
106
 
#. the series are aligned with Ubuntu releases for convenience since we
 
59
 * the series are aligned with Ubuntu releases for convenience since we
107
60
   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
 
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.
 
64
 
 
65
 
 
66
2.3 series
 
67
----------
 
68
 
 
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
 
71
releases::
 
72
 
 
73
 * 2.3.0: 2011-02-03
 
74
 
 
75
 * 2.3rc2: 2011-01-06
 
76
 
 
77
 * 2.3rc1: 2010-12-02
 
78
 
 
79
 * 2.3b3: 2010-11-04
 
80
 
 
81
 * 2.3b2: 2010-10-08
 
82
 
 
83
 * 2.3.b1: 2010-09-19
 
84
 
 
85
2.2 series
 
86
----------
 
87
 
 
88
The 2.2 series is the current stable release and is included in Maverick
 
89
Meerkat. The planned releases are::
 
90
 
 
91
 * 2.2.3: 2010-12-16
 
92
 
 
93
 * 2.2.2: 2010-11-18
 
94
 
 
95
 * 2.2.1: 2010-09-17
 
96
 
 
97
 * 2.2.0: 2010-08-06
 
98
 
 
99
 
 
100
2.1 series
 
101
----------
 
102
 
 
103
The 2.1 series is the stable release included in Lucid Lynx. The planned
 
104
releases are::
 
105
 
 
106
 * 2.1.6: 2011-01
 
107
 
 
108
 * 2.1.5: 2010-12
 
109
 
 
110
 * 2.1.4: 2010-11
 
111
 
 
112
 * 2.1.3: 2010-09-16
 
113
 
 
114
 * 2.1.2: 2010-05-27
 
115
 
 
116
 * 2.1.1: 2010-03-02
 
117
 
 
118
 * 2.1.0: 2010-02-11
 
119
 
 
120
 
 
121
2.0 series
 
122
----------
 
123
 
 
124
The 2.0 series is the stable release included in Karmic Koala. The planned
 
125
release are::
 
126
 
 
127
 * 2.0.7: 2011-03 will be the last release for the 2.0 series.
 
128
 
 
129
 * 2.0.6: 2010-09-16
 
130
 
 
131
 * 2.0.5: 2010-03-22
 
132
 
 
133
 * 2.0.4: 2010-01-21
 
134
 
 
135
 * 2.0.3: 2009-12-14
 
136
 
 
137
 * 2.0.2: 2009-11-02
 
138
 
 
139
 * 2.0.1: 2009-10-14
 
140
 
 
141
 * 2.0.0: 2009-09-21
140
142
 
141
143
 
142
144
At the start of a release cycle
144
146
 
145
147
To start a new release cycle:
146
148
 
 
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.
 
152
 
 
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
 
157
   the release branch.
 
158
 
 
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
 
162
   expected dates.
 
163
 
 
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
 
166
   will be available for targeting or nominating bugs.
 
167
 
147
168
#. Send mail to the list with the key dates, who will be the release
148
169
   manager, and the main themes or targeted bugs.  Ask people to nominate
149
170
   objectives, or point out any high-risk things that are best done early,
150
171
   or that interact with other changes. This is called the metronome mail
151
172
   and is described in `Development cycles <cycle.html>`_.
152
173
 
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.
 
174
#. Make a local branch for preparing this release.  (Only for the first
 
175
   release in a series, otherwise you should already have a branch.) ::
 
176
 
 
177
     bzr branch trunk prepare-1.14
163
178
 
164
179
#. 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``::
 
180
   x.y is the version to release). **Or use hydrazine for easy use**
 
181
   ``~/.bazaar/locations.conf``::
167
182
 
168
 
        [/home/mbp/bzr/x.y-dev]
 
183
        [/home/mbp/bzr/prepare-x.y]
169
184
        pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
170
185
        submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
171
186
        parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
172
 
        public_branch = http://bazaar.example.com/x.y-dev
 
187
        public_branch = http://bazaar.example.com/prepare-x.y
173
188
        submit_to = bazaar@lists.canonical.com
174
189
        smtp_server = mail.example.com:25
175
190
 
181
196
   
182
197
       version_info = (x, y, z, 'dev', 0)
183
198
   
184
 
#. Add a new section at the top of the current release notes (in
185
 
   ``doc/en/release-notes``) about the new release, including its version
186
 
   number and the headings from ``release-template.txt``.
 
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``.
187
202
 
188
203
#. Update the "What's New" documents in ``doc/en/whats-new``.
189
204
 
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
205
#. Commit this and send it to PQM.
196
206
 
197
207
 
209
219
#. In the release branch, update  ``version_info`` in ``./bzrlib/__init__.py``.
210
220
   Make sure the corresponding milestone exists.
211
221
   Double check that ./bzr ``_script_version`` matches ``version_info``. Check
212
 
   the output of ``./bzr --version``.
 
222
   the output of ``bzr --version``.
213
223
 
214
224
   For beta releases use::
215
225
 
219
229
 
220
230
       version_info = (2, 1, 0, 'beta', 1)
221
231
 
 
232
   For release candidates use::
 
233
 
 
234
       version_info = (2, 0, 1, 'candidate', SERIAL)
 
235
 
222
236
   For stable releases use::
223
237
 
224
238
       version_info = (2, 1, 2, 'final', 0)
225
239
 
226
 
#. Update the ``./doc/en/release-notes/`` section for this release.
 
240
#. Update the ``./NEWS`` section for this release.
227
241
 
228
242
   Fill out the date and a description of the release under the existing
229
 
   header. If there isn't one, follow the instructions above for using the
230
 
   ``release-template.txt`` file.
 
243
   header. If there isn't one, follow the above for using the NEWS
 
244
   template.
231
245
 
232
246
   See *2.1.1* or similar for an example of what this looks like.
233
247
 
234
 
#. Add or check the summary of the release into the "What's New" document.
235
 
 
236
 
#. To check that all bugs mentioned in the release notes are actually
237
 
   marked as closed in Launchpad, you can run
238
 
   ``tools/check-newsbugs.py``::
239
 
 
240
 
     ./tools/check-newsbugs.py doc/en/release-notes/bzr-x.y.txt
241
 
 
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 (``-w``
248
 
   will open each bug in your browser for example).
249
 
 
250
 
#. For beta releases update the translation template::
251
 
 
252
 
     make -f po/bzr.pot
253
 
 
254
 
   This is especially important for the final beta release which is
255
 
   when translations are frozen and translators are requested to make
256
 
   the translations.
257
 
 
258
 
#. For stable releases update the translations::
259
 
 
260
 
     bzr merge lp:~bzr-core/bzr/bzr-translations-export-x.y
 
248
#. Add a summary of the release into the "What's New" document.
 
249
 
 
250
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
 
251
   closed in Launchpad, you can run ``tools/check-newsbugs.py``::
 
252
 
 
253
     ./tools/check-newsbugs.py NEWS
 
254
 
 
255
   (But note there will be many false positives, and this script may be
 
256
   flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>.  Don't let
 
257
   this slow you down too much.)
261
258
 
262
259
#. Commit these changes to the release branch, using a command like::
263
260
 
264
 
     bzr commit -m "Release 2.3.1"
 
261
     bzr commit -m "Release 1.14."
265
262
 
266
263
   The diff before you commit will be something like::
267
264
 
268
 
      === modified file 'bzrlib/__init__.py'
269
 
      --- bzrlib/__init__.py    2011-02-09 06:35:00 +0000
270
 
      +++ bzrlib/__init__.py    2011-03-10 10:24:47 +0000
271
 
      @@ -52,7 +52,7 @@
272
 
       # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
273
 
       # releaselevel of 'dev' for unreleased under-development code.
274
 
       
275
 
      -version_info = (2, 3, 1, 'dev', 0)
276
 
      +version_info = (2, 3, 1, 'final', 0)
277
 
       
278
 
       # API compatibility version
279
 
       api_minimum_version = (2, 3, 0)
280
 
      
281
 
      === modified file 'doc/en/release-notes/bzr-2.3.txt'
282
 
      --- doc/en/release-notes/bzr-2.3.txt      2011-03-09 08:30:16 +0000
283
 
      +++ doc/en/release-notes/bzr-2.3.txt      2011-03-10 10:40:47 +0000
284
 
      @@ -8,23 +8,10 @@
285
 
       bzr 2.3.1
286
 
       #########
287
 
       
288
 
      -:2.3.1: NOT RELEASED YET
289
 
      -
290
 
      -External Compatibility Breaks
291
 
      -*****************************
292
 
      -
293
 
      -.. These may require users to change the way they use Bazaar.
294
 
      -
295
 
      -New Features
296
 
      -************
297
 
      -
298
 
      -.. New commands, options, etc that users may wish to try out.
299
 
      -
300
 
      -Improvements
301
 
      -************
302
 
      -
303
 
      -.. Improvements to existing commands, especially improved performance 
304
 
      -   or memory usage, or better results.
305
 
      +:2.3.1: 2011-03-10
306
 
      +
307
 
      +This is a bugfix release. Upgrading is recommended for all users of earlier
308
 
      +2.3 releases.
309
 
       
310
 
       Bug Fixes
311
 
       *********
312
 
      
313
 
      === modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
314
 
      --- doc/en/whats-new/whats-new-in-2.3.txt 2011-02-03 16:29:18 +0000
315
 
      +++ doc/en/whats-new/whats-new-in-2.3.txt 2011-03-10 11:10:36 +0000
316
 
      @@ -17,8 +17,13 @@
317
 
       improvements made to the core product, it highlights enhancements within the
318
 
       broader Bazaar world of potential interest to those upgrading.
319
 
       
320
 
      -Bazaar 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
321
 
      -and 2.2, and can read and write repositories generated by all previous
322
 
      +Bazaar 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
323
 
      +versions that weren't included in 2.3.0 and fixes some bugs on its own.
324
 
      +
325
 
      +See the :doc:`../release-notes/index` for details.
326
 
      +
327
 
      +Bazaar 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
328
 
      +and 2.2. It can read and write repositories generated by all previous
329
 
       versions.
330
 
       
331
 
       Changed Behaviour
332
 
      
 
265
     === modified file 'NEWS'
 
266
     --- NEWS        2008-09-17 23:09:18 +0000
 
267
     +++ NEWS        2008-09-23 16:14:54 +0000
 
268
     @@ -4,6 +4,23 @@
 
269
 
 
270
      .. contents::
 
271
 
 
272
     +bzr 1.7 2008-09-23
 
273
     +------------------
 
274
     +
 
275
     +This release includes many bug fixes and a few performance and feature
 
276
     +improvements.  ``bzr rm`` will now scan for missing files and remove them,
 
277
     +like how ``bzr add`` scans for unknown files and adds them. A bit more
 
278
     +polish has been applied to the stacking code. The b-tree indexing code has
 
279
     +been brought in, with an eye on using it in a future repository format.
 
280
     +There are only minor installer changes since bzr-1.7rc2.
 
281
     +
 
282
      bzr 1.7rc2 2008-09-17
 
283
      ---------------------
 
284
 
 
285
 
 
286
     === modified file 'bzrlib/__init__.py'
 
287
     --- bzrlib/__init__.py  2008-09-16 21:39:28 +0000
 
288
     +++ bzrlib/__init__.py  2008-09-23 16:14:54 +0000
 
289
     @@ -41,7 +41,7 @@
 
290
      # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
 
291
      # releaselevel of 'dev' for unreleased under-development code.
 
292
 
 
293
     -version_info = (1, 7, 0, 'candidate', 2)
 
294
     +version_info = (1, 7, 0, 'final', 0)
 
295
 
 
296
 
 
297
      # API compatibility version: bzrlib is currently API compatible with 1.7.
 
298
 
 
299
   Note that the NEWS file formatting has evolved, this example needs to
 
300
   be updated.
333
301
 
334
302
#. Tag the new release::
335
303
 
336
 
     bzr tag bzr-2.3.1
 
304
     bzr tag bzr-1.14
337
305
 
338
 
#. Push those changes to a bzr branch that is public and accessible on the
339
 
   Internet. PQM will pull from this branch when it attempts to merge your
340
 
   changes. Then submit those changes to PQM for merge into the appropriate
341
 
   release branch::
 
306
#. Push those changes to a bzr repository that is public and accessible on
 
307
   the Internet. PQM will pull from this repository when it attempts to merge
 
308
   your changes. Then submit those changes to PQM for merge into the
 
309
   appropriate release branch::
342
310
 
343
311
     bzr push
344
 
     bzr pqm-submit -m "(vila) Release 2.3.1 (Vincent Ladeuil)"
 
312
     bzr pqm-submit -m "(mbp) prepare 1.14"
345
313
 
346
314
   Or with hydrazine::
347
315
 
361
329
#. Now we'll try expanding this tarball and running the test suite
362
330
   to check for packaging problems::
363
331
 
364
 
     make check-dist-tarball | subunit2pyunit
365
 
 
366
 
   You may encounter failures while running the test suite caused by your
367
 
   locally installed plugins. Use your own judgment to decide if you can
368
 
   release with these failures. When in doubt, disable the faulty plugins
369
 
   one by one until you get no more failures. Alternatively, you can use
370
 
   ``BZR_DISABLE_PLUGINS`` or ``BZR_PLUGIN_PATH=-site`` to disable one or
371
 
   all plugins.
372
 
 
373
 
   Until <http://pad.lv/839461> is fixed, you may encounter issues if you
374
 
   cut a release for old stable branches (<= 2.2) and use a more recent
375
 
   OS/distro. If that's the case, check the bug status and use the following
376
 
   workaround if no fix is available::
377
 
 
378
 
     export TTPATH=<local branch of lp:testtools -r 0.9.2>
379
 
     export SUPATH=<local branch of lp:subunit -r 0.0.6>
380
 
     PYTHONPATH=$TTPATH:$SUPATH/python PATH=$SUPATH/filters:${PATH} BZR_PLUGIN_PATH=-site make check-dist-tarball PYTHON=python2.6 | subunit2pyunit
 
332
     make check-dist-tarball
 
333
 
 
334
   You may encounter failures while running the test suite caused
 
335
   by your locally installed plugins. Use your own judgment to
 
336
   decide if you can release with these failures. When in doubt,
 
337
   disable the faulty plugins one by one until you get no more
 
338
   failures.
381
339
 
382
340
   Remember that PQM has just tested everything too, this step is
383
341
   particularly testing that the pyrex extensions, which are updated
388
346
Publishing the source tarball
389
347
-----------------------------
390
348
 
391
 
#. Go to the relevant <https://launchpad.net/bzr/x.y> series page in Launchpad.
 
349
#. Go to the relevant milestone page in Launchpad.
392
350
 
393
351
#. Create a release of the milestone, and upload the source tarball and
394
352
   the GPG signature.  Or, if you prefer, use the
399
357
   <https://bugs.launchpad.net/launchpad/+bug/586445>
400
358
 
401
359
 
 
360
Announcing the source freeze
 
361
----------------------------
 
362
 
 
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.
 
369
 
 
370
 
402
371
Kick off the next cycle
403
372
-----------------------
404
373
 
405
 
From that point, there is no possible return, the tarball has been uploaded
406
 
so you can relax a bit.
407
 
 
408
 
You're still holding a "social" lock on the launchpad branch though. Until
409
 
your start the next cycle, nobody should land anything on this branch. If
410
 
they do, they either targeted the wrong branch or didn't update the news
411
 
file correctly, so the sooner the branch is opened again, the better.
412
 
 
413
 
This matters more for ``lp:bzr`` than for ``lp:bzr/x.y``, ``lp:bzr`` should
414
 
always be open for landing, so you should do `At the start of a release
415
 
cycle`_ as soon as possible (i.e. update the version number in ``bzr`` and
416
 
``bzrlib/__init__``, create/update the news files and create/update the
417
 
milestone for the next relase).
418
 
 
419
 
You may also need to do `At the start of a series cycle`_ if you're starting
420
 
a new series.
421
 
 
422
 
The final beta - branching and translations
423
 
-------------------------------------------
424
 
 
425
 
A word of caution: the instructions above works well for all releases but
426
 
there is one special case that requires a bit more care: when you release
427
 
the *last* beta for a given ``x.y`` series (from trunk aka lp:bzr), you need
428
 
to setup *two* branches for the next cycle:
429
 
 
430
 
#. ``lp:bzr`` needs to be opened for the next *series* ``x.(y+1)``
431
 
 
432
 
#. ``lp:bzr/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
433
 
   series. Since this is first real use of ``lp:bzr/x.y``, this is also the
434
 
   deadline for the PQM branch to be created.
435
 
 
436
 
Both are important as ``lp:bzr`` should remain open so any change can be
437
 
landed, ``lp:bzr/x.y`` on the other hand should be ready to receive bug
438
 
fixes.
439
 
 
440
 
``lp:bzr`` is generally more important as the bug fixes on ``lp:bzr/x.y``
441
 
won't be released sooner than a month from now whereas people may already
442
 
been waiting to land on ``lp:bzr``.
443
 
 
444
 
In a nutshell:
445
 
 
446
 
#. Create or update the ``x.y`` PQM branch based on whatever
447
 
   revision you want to release
448
 
 
449
 
#. Open ``lp:bzr`` for ``x.(y+1)``
450
 
 
451
 
#. Release ``x.y.0`` from ``lp:bzr/x.y``
452
 
 
453
 
#. Open ``lp:bzr/x.y`` for bug fixes
454
 
 
455
 
You also need to ensure Launchpad is set up to import/export
456
 
translations for the new branch and inform translators.
457
 
 
458
 
#. Push a branch::
459
 
 
460
 
     bzr push lp:~bzr-core/bzr/bzr-translations-export-x.y
461
 
 
462
 
#. On the translations series synchronization settings page
463
 
   <https://translations.launchpad.net/bzr/x.y/+translations-settings>
464
 
   turn on ``Import template files`` then for exports click ``Choose a
465
 
   target branch`` and point it at the branch you just pushed.
466
 
 
467
 
#. E-mail translators to announce that the forthcoming stable release
468
 
   of bzr is ready for translations.  Send to
469
 
   ``translators@lists.launchpad.net`` and
470
 
   ``ubuntu-translators@lists.ubuntu.com``.
471
 
 
472
 
#. The series is now frozen for strings and API, see below for adding
473
 
   that to the announcement.
474
 
 
475
 
Announcing the source freeze
476
 
----------------------------
477
 
 
478
 
#. Post to the ``bazaar@lists.canonical.com`` list, saying that the source
479
 
   has been frozen (gone gold). Be extra clear that this is only a *source*
480
 
   release targeted at packagers and installer builders (see
481
 
   <https://bugs.launchpad.net/launchpad/+bug/645084>).  This is the cue for
482
 
   platform maintainers and plugin authors to update their code.  This is
483
 
   done before the general public announcement of the release.
484
 
 
485
 
   The freeze announcement generally guess the date of the official public
486
 
   announcement, for the most recent stable series (the one supported by the
487
 
   installers and most of the distributions) it's generally a few days after
488
 
   the freeze. For older series supported only via SRUs for Ubuntu, we don't
489
 
   control the process as tightly so guessing the date is not appropriate.
490
 
 
491
 
   For the final beta release include in your announcement a notice of
492
 
   API and translation freezes nothing that public methods should not
493
 
   be removed or changed and strings should not be added or changed.
494
 
 
495
 
#. Pause for a few days. 
 
374
#. To let developers work on the next release, do
 
375
   `At the start of a release cycle` now.
 
376
 
 
377
#. Pause for a few days.
496
378
 
497
379
 
498
380
Publishing the release
512
394
#. Check that the documentation for this release is available in
513
395
   <http://doc.bazaar.canonical.com>.  It should be automatically build when the
514
396
   branch is created, by a cron script ``update-bzr-docs`` on
515
 
   ``escudero``.
 
397
   ``escudero``. As of today (2009-08-27) ``igc`` manually updates the
 
398
   pretty version of it.
516
399
 
517
400
 
518
401
Announcing the release
522
405
 
523
406
#. Make an announcement mail.
524
407
 
525
 
   For beta releases, this is sent to the ``bazaar@lists.canonical.com`` and
526
 
   ``bazaar-announce@lists.canonical.com`` lists.
527
 
 
528
 
   For stable releases (excluding SRUs which are for older stable releases),
529
 
   it should also be cc'd to ``info-gnu@gnu.org``,
 
408
   For release candidates or beta releases, this is sent to the ``bazaar``
 
409
   list only to inform plugin authors and package or installer managers.
 
410
 
 
411
   Once the installers are available, the mail can be sent to the
 
412
   ``bazaar-announce`` list too.
 
413
 
 
414
   For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
530
415
   ``python-announce-list@python.org``, ``bug-directory@gnu.org``.
531
416
 
532
417
   In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
538
423
 
539
424
      The Bazaar team is happy to announce availability of a new
540
425
      release of the bzr adaptive version control system.
541
 
 
542
 
      Bazaar <http://bazaar.canonical.com/> is a Canonical project and part
543
 
      of the GNU project <http://gnu.org/> to produce a free operating
544
 
      system.
 
426
      Bazaar is part of the GNU system <http://gnu.org/>.
545
427
 
546
428
      <<Summary paragraph from news>>
547
429
 
549
431
      feedback.
550
432
 
551
433
      Bazaar is now available for download from
552
 
      https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
 
434
      https://launchpad.net/bzr/2.x/2.x/ as a source tarball; packages
553
435
      for various systems will be available soon.
554
436
 
555
 
      <<release notes from this release back to the last major release>>
 
437
      <<NEWS section from this release back to the last major release>>
556
438
 
557
439
   Feel free to tweak this to your taste.
558
440
 
559
441
#. Make an announcement through <https://launchpad.net/bzr/+announce>
560
442
 
 
443
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
 
444
   ensuring the new topic text keeps the project name, web site link, etc.
 
445
 
561
446
#. Announce on http://freshmeat.net/projects/bzr/
562
447
 
563
 
   This should be done for beta releases and stable releases. If you do not
564
 
   have a Freshmeat account yet, ask one of the existing admins.
565
 
 
566
 
   The purpose here is to point users to the latest stable release
567
 
   (i.e. SRUs are excluded) while still publishing announcements for beta
568
 
   releases.
569
 
 
570
 
   There are several kinds of modifications that could be done there via the
571
 
   ``Administration`` box in the lower right area of the page:
572
 
 
573
 
   * Edit the project: This is where most of the URLs proposed in the
574
 
     ``Links`` box are edited. This should rarely change except for the URLs
575
 
     related to the latest stable release.
576
 
 
577
 
   * New announcement: When doing a release, put the summary of the release
578
 
     (you can't embed URLs there, the moderation staff remove them). Users
579
 
     can still access the releases notes via the ``Release Notes`` URL in
580
 
     the ``Links`` box in the upper right area of the page. When doing the
581
 
     first stable release in a series, delete the ``Unstable installers``
582
 
     <https://launchpad.net/bzr/x.y/x.ybn> and ``Unstable source tarball``
583
 
     <http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
584
 
     links. Conversely, when creating the first beta in a development
585
 
     series, create these links again. Check all links when doing other
586
 
     kinds of release.
587
 
 
588
 
   * Set direct download: When releasing a new stable release, this should
589
 
     point to the corresponding launchpad page:
590
 
     <https://launchpad.net/bzr/x.y/x.y.z/>
 
448
   This should be done for beta releases, release candidates and final
 
449
   releases. If you do not have a Freshmeat account yet, ask one of the
 
450
   existing admins.
591
451
 
592
452
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
593
 
   be done for the stable and beta releases.
 
453
   be done for final releases but not for beta releases or Release Candidates.
594
454
 
595
455
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
596
456
   done by running ::
597
457
 
598
458
       python setup.py register
599
459
 
600
 
   Remember to check the results afterward -- this should be done for
601
 
   stable releases but not for beta releases nor SRUs.
 
460
   Remember to check the results afterwards.
602
461
 
603
462
   To be able to register the release you must create an account on
604
463
   <http://pypi.python.org/pypi> and have one of the existing owners of
608
467
Merging the released code back to trunk
609
468
---------------------------------------
610
469
 
611
 
Merge the release branch back into the trunk.  The ``doc/en/release-notes``
612
 
changes should be merged into the right place because each release series
613
 
has its own release-notes file, but double-check.
 
470
The rule is to keep ``NEWS`` sections sorted by date. You'll need to
 
471
review the merge and make sure that that is respected.
614
472
 
615
 
If it's not already done, advance the version number in ``bzr`` and
616
 
``bzrlib/__init__.py``.  Submit this back into pqm for bzr.dev.
 
473
Merge the release branch back into the trunk.  Check that changes in NEWS
 
474
were merged into the right sections.  If it's not already done, advance
 
475
the version number in ``bzr`` and ``bzrlib/__init__.py``.  Submit this
 
476
back into pqm for bzr.dev.
617
477
 
618
478
As soon as you change the version number in trunk, make sure you have
619
479
created the corresponding milestone to ensure the continuity in bug
620
480
targeting or nominating. Depending on the change, you may even have to
621
481
create a new series (if your change the major or minor release number), in
622
 
that case go to `At the start of a series cycle`_ and follow the
623
 
instructions from there.
 
482
that case go to `At the start of a release cycle` and follow the instructions from there.
624
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.
625
487
 
626
488
Releases until the final one
627
489
----------------------------
628
490
 
629
 
Congratulations - you have made your first release.  Have a beer or fruit
630
 
juice - it's on the house! If it was a beta, you're not finished
631
 
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.
632
495
 
633
 
The process is the same as for the first release. Goto `Doing a particular
634
 
release`_ and follow the instructions again. Some details change between
635
 
beta and stable releases, but they should be documented. If the instructions
636
 
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.
637
500
 
638
501
 
639
502
Getting the release into Ubuntu
652
515
the `SRU (Stable Release Updates)
653
516
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.   
654
517
 
655
 
Since September 2010, bzr has received approval by the technical
656
 
board for the `MicroReleaseExceptions
 
518
As of September 2010, bzr has applied to the technical board to be added
 
519
to the `MicroReleaseExceptions
657
520
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
658
 
category so that whole bugfix releases can more easily be
659
 
approved.
660
 
 
661
 
Progress on these realeases is tracked on the `SRU wiki
662
 
<http://wiki.bazaar.canonical.com/UbuntuStableReleaseUpdates>`_
663
 
page.
 
521
category so that whole bugfix releases can more easily be approved.
664
522
 
665
523
**After making a bzr stable-release release, nominate the most serious bug
666
524
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
677
535
   button and select the right Ubuntu release. As of September 2010, this
678
536
   means:
679
537
 
680
 
  * ``oneiric`` for the 2.4 series,
681
 
  * ``natty`` for the 2.3 series,
682
538
  * ``maverick`` for the 2.2 series,
683
539
  * ``lucid`` for the 2.1 series,
 
540
  * ``karmic`` for the 2.0 series.
684
541
 
685
542
 * Subscribe the ``~ubuntu-sru`` team to the bug.
686
543