~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/releasing.txt

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

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