~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/releasing.txt

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
Releasing Bazaar
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 <cycle.html>`_, but it's the most complex part.
7
 
This document gives a checklist you can follow from start to end in one
8
 
go.
 
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.
 
15
 
 
16
If you're helping the Release Manager (RM) for one reason or another, you
 
17
may notice that he didn't follow that document scrupulously. He may have
 
18
good reasons to do that but he may also have missed some parts.
9
19
 
10
20
.. contents::
11
21
 
12
 
Preparing the tree for release
13
 
------------------------------
14
 
 
15
 
.. Was previously at http://bazaar-vcs.org/ReleaseChecklist
16
 
 
17
 
#. Make a local branch for preparing this release.  (Only for the first 
18
 
   release in a series, otherwise you should already have a branch.) ::
19
 
 
20
 
     bzr branch trunk prepare-1.6
21
 
 
22
 
#. Configure pqm-submit for this branch, with a section like this in
23
 
   ``~/.bazaar/locations.conf``::
24
 
 
25
 
        [/home/mbp/bzr/prepare-1.4]
 
22
 
 
23
Preconditions
 
24
=============
 
25
 
 
26
#. PQM access rights (or you won't be able to land any change)
 
27
 
 
28
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
 
29
 
 
30
     bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
 
31
 
 
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).
 
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
 
 
142
At the start of a release cycle
 
143
===============================
 
144
 
 
145
To start a new release cycle:
 
146
 
 
147
#. Send mail to the list with the key dates, who will be the release
 
148
   manager, and the main themes or targeted bugs.  Ask people to nominate
 
149
   objectives, or point out any high-risk things that are best done early,
 
150
   or that interact with other changes. This is called the metronome mail
 
151
   and is described in `Development cycles <cycle.html>`_.
 
152
 
 
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.
 
163
 
 
164
#. 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``::
 
167
 
 
168
        [/home/mbp/bzr/x.y-dev]
26
169
        pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
27
 
        submit_branch = http://bazaar-vcs.org/bzr/bzr.1.4
 
170
        submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
 
171
        parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
 
172
        public_branch = http://bazaar.example.com/x.y-dev
28
173
        submit_to = bazaar@lists.canonical.com
29
 
 
30
 
#. In the release branch, update  ``version_info`` in
31
 
   ``./bzrlib/__init__.py``.  Check the output of ``bzr --version``.
32
 
 
33
 
#. Add the date and release number to ``./NEWS``
34
 
 
35
 
#. Summarize into one or two paragraphs what's new in this release.
 
174
        smtp_server = mail.example.com:25
 
175
 
 
176
    Please see <http://doc.bazaar.canonical.com/developers/HACKING.html#an-overview-of-pqm>
 
177
    for more details on PQM
 
178
 
 
179
#. Update the version number in the ``bzr`` script, and the
 
180
   ``bzrlib/__init__.py`` file::
 
181
   
 
182
       version_info = (x, y, z, 'dev', 0)
 
183
   
 
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``.
 
187
 
 
188
#. Update the "What's New" documents in ``doc/en/whats-new``.
 
189
 
 
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
#. Commit this and send it to PQM.
 
196
 
 
197
 
 
198
Doing a particular release
 
199
==========================
 
200
 
 
201
Update the source code
 
202
----------------------
 
203
 
 
204
#. Check that there is a milestone for the release you're doing. If there
 
205
   is no milestone it indicates a process problem - make the milestone but
 
206
   also mail the list to raise this issue in our process. Milestones are
 
207
   found at <https://launchpad.net/bzr/+milestone/x.y.z>.
 
208
 
 
209
#. In the release branch, update  ``version_info`` in ``./bzrlib/__init__.py``.
 
210
   Make sure the corresponding milestone exists.
 
211
   Double check that ./bzr ``_script_version`` matches ``version_info``. Check
 
212
   the output of ``./bzr --version``.
 
213
 
 
214
   For beta releases use::
 
215
 
 
216
       version_info = (2, 1, 0, 'beta', SERIAL)
 
217
 
 
218
   For instance 2.1b1::
 
219
 
 
220
       version_info = (2, 1, 0, 'beta', 1)
 
221
 
 
222
   For stable releases use::
 
223
 
 
224
       version_info = (2, 1, 2, 'final', 0)
 
225
 
 
226
#. Update the ``./doc/en/release-notes/`` section for this release.
 
227
 
 
228
   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.
 
231
 
 
232
   See *2.1.1* or similar for an example of what this looks like.
 
233
 
 
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
36
261
 
37
262
#. Commit these changes to the release branch, using a command like::
38
 
    
39
 
     bzr commit -m "Release 0.12rc1." 
40
 
   
 
263
 
 
264
     bzr commit -m "Release 2.3.1"
 
265
 
41
266
   The diff before you commit will be something like::
42
267
 
43
 
     === modified file 'NEWS'
44
 
     --- NEWS        2008-09-17 23:09:18 +0000
45
 
     +++ NEWS        2008-09-23 16:14:54 +0000
46
 
     @@ -4,6 +4,23 @@
47
 
     
48
 
      .. contents::
49
 
     
50
 
     +bzr 1.7 2008-09-23
51
 
     +------------------
52
 
     +
53
 
     +This release includes many bug fixes and a few performance and feature
54
 
     +improvements.  ``bzr rm`` will now scan for missing files and remove them,
55
 
     +like how ``bzr add`` scans for unknown files and adds them. A bit more
56
 
     +polish has been applied to the stacking code. The b-tree indexing code has
57
 
     +been brought in, with an eye on using it in a future repository format.
58
 
     +There are only minor installer changes since bzr-1.7rc2.
59
 
     +
60
 
      bzr 1.7rc2 2008-09-17
61
 
      ---------------------
62
 
     
63
 
     
64
 
     === modified file 'bzrlib/__init__.py'
65
 
     --- bzrlib/__init__.py  2008-09-16 21:39:28 +0000
66
 
     +++ bzrlib/__init__.py  2008-09-23 16:14:54 +0000
67
 
     @@ -41,7 +41,7 @@
68
 
      # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
69
 
      # releaselevel of 'dev' for unreleased under-development code.
70
 
     
71
 
     -version_info = (1, 7, 0, 'candidate', 2)
72
 
     +version_info = (1, 7, 0, 'final', 0)
73
 
     
74
 
     
75
 
      # API compatibility version: bzrlib is currently API compatible with 1.7.
76
 
      
77
 
 
78
 
#. Submit those changes to PQM for merge into the appropriate release
79
 
   branch::
80
 
 
 
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
      
 
333
 
 
334
#. Tag the new release::
 
335
 
 
336
     bzr tag bzr-2.3.1
 
337
 
 
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::
 
342
 
81
343
     bzr push
82
 
     bzr pqm-submit -m "(mbp) prepare 1.6"
 
344
     bzr pqm-submit -m "(vila) Release 2.3.1 (Vincent Ladeuil)"
 
345
 
 
346
   Or with hydrazine::
 
347
 
 
348
     bzr lp-propose -m "Release 1.14" --approve lp:bzr/1.14
 
349
     feed-pqm bzr
83
350
 
84
351
#. When PQM succeeds, pull down the master release branch.
85
352
 
88
355
-------------------------
89
356
 
90
357
#. Change into the source directory and run ::
91
 
  
 
358
 
92
359
     make dist
93
360
 
94
 
   This also makes a zip file, which is easier to access on Microsoft
95
 
   Windows.
96
 
 
97
361
#. Now we'll try expanding this tarball and running the test suite
98
362
   to check for packaging problems::
99
 
 
100
 
     make check-dist-tarball
 
363
 
 
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
 
381
 
 
382
   Remember that PQM has just tested everything too, this step is
 
383
   particularly testing that the pyrex extensions, which are updated
 
384
   by your local pyrex version when you run make dist, are in good
 
385
   shape.
 
386
 
 
387
 
 
388
Publishing the source tarball
 
389
-----------------------------
 
390
 
 
391
#. Go to the relevant <https://launchpad.net/bzr/x.y> series page in Launchpad.
 
392
 
 
393
#. Create a release of the milestone, and upload the source tarball and
 
394
   the GPG signature.  Or, if you prefer, use the
 
395
   ``tools/packaging/lp-upload-release`` script to do this. Note that
 
396
   this changes what the download widget on the Launchpad bzr home
 
397
   page shows, so don't stop the release process yet, or platform binary
 
398
   installers won't be made and the download list will stay very small!
 
399
   <https://bugs.launchpad.net/launchpad/+bug/586445>
 
400
 
 
401
 
 
402
Kick off the next cycle
 
403
-----------------------
 
404
 
 
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. 
101
496
 
102
497
 
103
498
Publishing the release
104
499
----------------------
105
500
 
106
 
Now you have the releasable product.  The next step is making it
 
501
There is normally a delay of a few days after the source freeze to allow
 
502
for binaries to be built on various platforms.  Once they have been built,
 
503
we have a releasable product.  The next step is to make it generally
107
504
available to the world.
108
505
 
109
 
#. In <https://launchpad.net/bzr/> click the "Release series" for this
110
 
   series, to take you to e.g. <https://launchpad.net/bzr/1.1>.  Then
111
 
   click "Register a release", and add information about this release.
112
 
 
113
 
#. Within that release, upload the source tarball and zipfile and the GPG
114
 
   signature.  Or, if you prefer, use the
115
 
   ``tools/packaging/lp-upload-release`` script to do this.
116
 
 
117
 
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
118
 
 
119
 
#. Announce on the `Bazaar home page <http://bazaar-vcs.org/>`_.
120
 
 
121
 
#. Check that the documentation for this release is available in 
122
 
   <http://doc.bazaar-vcs.org>.  It should be automatically build when the 
 
506
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
 
507
 
 
508
#. Announce on the `Bazaar website <http://bazaar.canonical.com/>`_.
 
509
   This page is edited via the lp:bzr-website branch. (Changes
 
510
   pushed to this branch are refreshed by a cron job on escudero.)
 
511
 
 
512
#. Check that the documentation for this release is available in
 
513
   <http://doc.bazaar.canonical.com>.  It should be automatically build when the
123
514
   branch is created, by a cron script ``update-bzr-docs`` on
124
515
   ``escudero``.
125
516
 
131
522
 
132
523
#. Make an announcement mail.
133
524
 
134
 
   For release candidates, this is sent to the ``bazaar-announce`` and
135
 
   ``bazaar`` lists.  For final releases, it should also be cc'd to 
136
 
   ``info-gnu@gnu.org``, ``python-announce-list@python.org``, 
137
 
   ``bug-directory@gnu.org``.  In both cases, it is good to set
138
 
   ``Reply-To: bazaar@lists.canonical.com``, so that people who reply to
139
 
   the announcement don't spam other lists.
140
 
 
141
 
   The announce mail will look something like this:
142
 
   
143
 
    | Subject: bzr x.yy released!
144
 
    | 
145
 
    | <<Summary paragraph from news>>
146
 
    |
147
 
    | The Bazaar team is happy to announce availability of a new 
148
 
    | release of the bzr adaptive version control system.
149
 
    |
150
 
    | Thanks to everyone who contributed patches, suggestions, and
151
 
    | feedback.
152
 
    | 
153
 
    | Bazaar is now available for download from 
154
 
    | http://bazaar-vcs.org/Download as a source tarball; packages 
155
 
    | for various systems will be available soon.
156
 
    | 
157
 
    | <<NEWS section from this release back to the last major release>>
 
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``,
 
530
   ``python-announce-list@python.org``, ``bug-directory@gnu.org``.
 
531
 
 
532
   In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
 
533
   so that people who reply to the announcement don't spam other lists.
 
534
 
 
535
   The announce mail will look something like this::
 
536
 
 
537
      Subject: bzr x.y.z released!
 
538
 
 
539
      The Bazaar team is happy to announce availability of a new
 
540
      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.
 
545
 
 
546
      <<Summary paragraph from news>>
 
547
 
 
548
      Thanks to everyone who contributed patches, suggestions, and
 
549
      feedback.
 
550
 
 
551
      Bazaar is now available for download from
 
552
      https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
 
553
      for various systems will be available soon.
 
554
 
 
555
      <<release notes from this release back to the last major release>>
 
556
 
 
557
   Feel free to tweak this to your taste.
158
558
 
159
559
#. Make an announcement through <https://launchpad.net/bzr/+announce>
160
560
 
161
 
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
162
 
   ensuring the new topic text keeps the project name, web site link, etc.
163
 
 
164
561
#. Announce on http://freshmeat.net/projects/bzr/
165
 
   
166
 
   This should be done for both release candidates and final releases. If
167
 
   you do not have a Freshmeat account yet, ask one of the existing
168
 
   admins.
169
 
 
170
 
#. Update http://en.wikipedia.org/wiki/Bzr -- this should be done for
171
 
   final releases but not for Release Candidates.
 
562
 
 
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/>
 
591
 
 
592
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
 
593
   be done for the stable and beta releases.
172
594
 
173
595
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
174
596
   done by running ::
175
597
 
176
598
       python setup.py register
177
599
 
178
 
   Remember to check the results afterwards.
 
600
   Remember to check the results afterward -- this should be done for
 
601
   stable releases but not for beta releases nor SRUs.
179
602
 
180
603
   To be able to register the release you must create an account on
181
604
   <http://pypi.python.org/pypi> and have one of the existing owners of
185
608
Merging the released code back to trunk
186
609
---------------------------------------
187
610
 
188
 
Merge the release branch back into the trunk.  Check that changes in NEWS
189
 
were merged into the right sections.  If it's not already done, advance
190
 
the version number in ``bzr`` and ``bzrlib/__init__.py``.  Submit this
191
 
back into pqm for bzr.dev.
 
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.
 
614
 
 
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.
 
617
 
 
618
As soon as you change the version number in trunk, make sure you have
 
619
created the corresponding milestone to ensure the continuity in bug
 
620
targeting or nominating. Depending on the change, you may even have to
 
621
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.
 
624
 
 
625
 
 
626
Releases until the final one
 
627
----------------------------
 
628
 
 
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.
 
632
 
 
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.
 
637
 
 
638
 
 
639
Getting the release into Ubuntu
 
640
-------------------------------
 
641
 
 
642
(Feel free to propose or add new sections here about what we should do to
 
643
get bzr into other places.)
 
644
 
 
645
For the currently-under-development release of Ubuntu, no special action
 
646
is needed: the release should be picked by Debian and synced from there into
 
647
Ubuntu.
 
648
 
 
649
Releases off stable bzr branches should go in to the ``-updates`` of the
 
650
Ubuntu release that originally contained that branch.  (Ubuntu Lucid had
 
651
bzr 2.2.0, so should get every 2.2.x update.)  This means going through
 
652
the `SRU (Stable Release Updates)
 
653
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.   
 
654
 
 
655
Since September 2010, bzr has received approval by the technical
 
656
board for the `MicroReleaseExceptions
 
657
<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.
 
664
 
 
665
**After making a bzr stable-release release, nominate the most serious bug
 
666
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
 
667
 
 
668
This requires a couple of tricks (please reconsider and tweak as things
 
669
evolves from one release to the other):
 
670
 
 
671
 * create a distro task with the ``Also affects distribution`` button and
 
672
   select ``bzr (Ubuntu)``.
 
673
 
 
674
 * change the *URL* to point to ``ubuntu/+source/bzr`` instead of ``bzr``
 
675
   (this is needed if you create the distro task but not if it exists
 
676
   already). You should now be able to click the ``Nominate for release``
 
677
   button and select the right Ubuntu release. As of September 2010, this
 
678
   means:
 
679
 
 
680
  * ``oneiric`` for the 2.4 series,
 
681
  * ``natty`` for the 2.3 series,
 
682
  * ``maverick`` for the 2.2 series,
 
683
  * ``lucid`` for the 2.1 series,
 
684
 
 
685
 * Subscribe the ``~ubuntu-sru`` team to the bug.
 
686
 
 
687
 * Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
 
688
   (we are targeting running the test suite during the build which, as of
 
689
   September 2010, fails for known reasons that are currently addressed).
 
690
   Search for bugs tagged with ``sru`` for examples and don't forget to tag
 
691
   the bug you selected.
192
692
 
193
693
 
194
694
See also
195
695
--------
196
696
 
197
 
 * `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
198
 
   packages.
199
 
 * `Bazaar Developer Document Catalog <index.html>`_
200
 
 * `Development cycles <cycle.html>`_: things that happen during the cycle
201
 
   before the actual release.
202
 
 
 
697
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
 
698
  packages.
 
699
* `Bazaar Developer Document Catalog <index.html>`_
 
700
* `Development cycles <cycle.html>`_: things that happen during the cycle
 
701
  before the actual release.
203
702
 
204
703
..
205
704
   vim: filetype=rst textwidth=74 ai shiftwidth=4