~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/releasing.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

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.
6
 
 
7
 
We normally have one person acting as the release manager, who 
8
 
organizes development for the release and also actually makes the release
9
 
tarball and posts announcements.  It can be a different person from one
10
 
release to the next.
11
 
 
12
 
See also: `Bazaar Developer Document Catalog <index.html>`_.
13
 
 
 
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.
14
19
 
15
20
.. contents::
16
21
 
17
 
General process
18
 
---------------
19
 
 
20
 
Our usual process is that one week before release we will make a release
21
 
branch from the trunk.  We do one commit to that branch to change the
22
 
version number to 'rc1', and advance the trunk version to 'dev' for the
23
 
next release.
24
 
 
25
 
We then publish and announce this release candidate according to the
26
 
process below.  We then have a week of general testing of the rc,
27
 
including some time for plugin authors to update their code for any
28
 
changes.
29
 
 
30
 
Normally no changes will be made on the release branch unless serious bugs
31
 
or regressions are found, and the release manager decides they should be
32
 
merged in.  After one week, the release branch's version number is updated
33
 
and it's published as the final release.  If regressions or serious
34
 
problems are discovered after the final release we may make an additional
35
 
point release from that branch.
36
 
 
37
 
The process or timing can vary if that seems appropriate in a particular
38
 
case but we try to release on a regular four week cycle.
39
 
 
40
 
The net effect is that the code gets some extra testing before release,
41
 
and the trunk is always open for general development.
42
 
 
43
 
 
44
 
 
45
 
 
46
 
Starting a Release
47
 
------------------
 
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
===============================
48
144
 
49
145
To start a new release cycle:
50
146
 
51
147
#. Send mail to the list with the key dates, who will be the release
52
 
   manager, and the main themes or targetted bugs.  Ask people to nominate
 
148
   manager, and the main themes or targeted bugs.  Ask people to nominate
53
149
   objectives, or point out any high-risk things that are best done early,
54
 
   or that interact with other changes.
55
 
 
56
 
#. Add a new "series" in Launchpad at <https://launchpad.net/bzr/+addseries>.  There is one 
57
 
   series for every *x.y* release.
58
 
 
59
 
 
60
 
Weekly Metronome Mail
61
 
---------------------
62
 
 
63
 
Every week the release manager should send a mail to the Bazaar list
64
 
covering these points (as appropriate):
65
 
 
66
 
* Early communication about changing dependencies or defaults
67
 
 
68
 
* Reminder re lifecycle and where we're up to right now, in particular the 
69
 
  dates for the next release and/or candidate.
70
 
 
71
 
* Summary of recent successes and pending work.
72
 
 
73
 
* Reminder re release objectives
74
 
 
75
 
* Reminder re things needing attention, e.g. bug triage, reviews, testing of certain things, etc.
76
 
 
77
 
 
78
 
Preparing the tree for release
79
 
------------------------------
80
 
 
81
 
.. Was previously at http://bazaar-vcs.org/ReleaseChecklist
82
 
 
83
 
.. TODO: Still needs more clarity on what's in a RC versus a final
84
 
.. release?
85
 
 
86
 
This is the procedure for making a new bzr release:
87
 
 
88
 
#. If the release is the first candidate, make a new branch in PQM. 
89
 
   (Contact Robert Collins for this step).
90
 
 
91
 
   Register the branch at https://launchpad.net/products/bzr/+addbranch
92
 
 
93
 
#. Make a local branch for preparing this release.  (Only for the first 
94
 
   release in a series, otherwise you should already have a branch.) ::
95
 
 
96
 
     bzr branch trunk prepare-1.6
97
 
 
98
 
#. Configure pqm-submit for this branch, with a section like this in
99
 
   ``~/.bazaar/locations.conf``::
100
 
 
101
 
        [/home/mbp/bzr/prepare-1.4]
 
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]
102
169
        pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
103
 
        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
104
173
        submit_to = bazaar@lists.canonical.com
105
 
 
106
 
#. In the release branch, update  ``version_info`` in
107
 
   ``./bzrlib/__init__.py``.  
108
 
   (This must match ``_script_version`` in the ``bzr`` script, but 
109
 
   that is updated at the start of the release cycle, and
110
 
   doesn't need to say if it's an rc or final release.)
111
 
 
112
 
   Run this command and check the output::
113
 
 
114
 
     ./bzr --version
115
 
 
116
 
#. Add the date and release number to ``./NEWS``, and a one-paragraph
117
 
   summary of changes 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.
118
248
 
119
249
#. Commit these changes to the release branch, using a command like::
120
 
    
121
 
     bzr commit -m "Release 0.12rc1." 
122
 
   
 
250
 
 
251
     bzr commit -m "Release 2.3.1"
 
252
 
123
253
   The diff before you commit will be something like::
124
254
 
125
 
       === modified file 'NEWS'
126
 
       --- NEWS        2006-10-23 13:11:17 +0000
127
 
       +++ NEWS        2006-10-23 22:50:50 +0000
128
 
       @@ -1,4 +1,4 @@
129
 
       -IN DEVELOPMENT
130
 
       +bzr 0.12rc1  2006-10-23
131
 
 
132
 
          IMPROVEMENTS:
133
 
 
134
 
 
135
 
       === modified file 'bzrlib/__init__.py'
136
 
       --- bzrlib/__init__.py  2006-10-16 01:47:43 +0000
137
 
       +++ bzrlib/__init__.py  2006-10-23 22:49:46 +0000
138
 
       @@ -35,7 +35,7 @@
139
 
        # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
140
 
        # releaselevel of 'dev' for unreleased under-development code.
141
 
 
142
 
       -version_info = (0, 12, 0, 'dev', 0)
143
 
       +version_info = (0, 12, 0, 'candidate', 1)
144
 
 
145
 
        if version_info[3] == 'final':
146
 
            version_string = '%d.%d.%d' % version_info[:3]
147
 
 
148
 
#. Submit those changes to PQM for merge into the appropriate release
149
 
   branch::
150
 
 
 
255
      === modified file 'bzrlib/__init__.py'
 
256
      --- bzrlib/__init__.py    2011-02-09 06:35:00 +0000
 
257
      +++ bzrlib/__init__.py    2011-03-10 10:24:47 +0000
 
258
      @@ -52,7 +52,7 @@
 
259
       # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
 
260
       # releaselevel of 'dev' for unreleased under-development code.
 
261
       
 
262
      -version_info = (2, 3, 1, 'dev', 0)
 
263
      +version_info = (2, 3, 1, 'final', 0)
 
264
       
 
265
       # API compatibility version
 
266
       api_minimum_version = (2, 3, 0)
 
267
      
 
268
      === modified file 'doc/en/release-notes/bzr-2.3.txt'
 
269
      --- doc/en/release-notes/bzr-2.3.txt      2011-03-09 08:30:16 +0000
 
270
      +++ doc/en/release-notes/bzr-2.3.txt      2011-03-10 10:40:47 +0000
 
271
      @@ -8,23 +8,10 @@
 
272
       bzr 2.3.1
 
273
       #########
 
274
       
 
275
      -:2.3.1: NOT RELEASED YET
 
276
      -
 
277
      -External Compatibility Breaks
 
278
      -*****************************
 
279
      -
 
280
      -.. These may require users to change the way they use Bazaar.
 
281
      -
 
282
      -New Features
 
283
      -************
 
284
      -
 
285
      -.. New commands, options, etc that users may wish to try out.
 
286
      -
 
287
      -Improvements
 
288
      -************
 
289
      -
 
290
      -.. Improvements to existing commands, especially improved performance 
 
291
      -   or memory usage, or better results.
 
292
      +:2.3.1: 2011-03-10
 
293
      +
 
294
      +This is a bugfix release. Upgrading is recommended for all users of earlier
 
295
      +2.3 releases.
 
296
       
 
297
       Bug Fixes
 
298
       *********
 
299
      
 
300
      === modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
 
301
      --- doc/en/whats-new/whats-new-in-2.3.txt 2011-02-03 16:29:18 +0000
 
302
      +++ doc/en/whats-new/whats-new-in-2.3.txt 2011-03-10 11:10:36 +0000
 
303
      @@ -17,8 +17,13 @@
 
304
       improvements made to the core product, it highlights enhancements within the
 
305
       broader Bazaar world of potential interest to those upgrading.
 
306
       
 
307
      -Bazaar 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
 
308
      -and 2.2, and can read and write repositories generated by all previous
 
309
      +Bazaar 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
 
310
      +versions that weren't included in 2.3.0 and fixes some bugs on its own.
 
311
      +
 
312
      +See the :doc:`../release-notes/index` for details.
 
313
      +
 
314
      +Bazaar 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
 
315
      +and 2.2. It can read and write repositories generated by all previous
 
316
       versions.
 
317
       
 
318
       Changed Behaviour
 
319
      
 
320
 
 
321
#. Tag the new release::
 
322
 
 
323
     bzr tag bzr-2.3.1
 
324
 
 
325
#. Push those changes to a bzr branch that is public and accessible on the
 
326
   Internet. PQM will pull from this branch when it attempts to merge your
 
327
   changes. Then submit those changes to PQM for merge into the appropriate
 
328
   release branch::
 
329
 
151
330
     bzr push
152
 
     bzr pqm-submit -m "(mbp) prepare 1.6"
 
331
     bzr pqm-submit -m "(vila) Release 2.3.1 (Vincent Ladeuil)"
 
332
 
 
333
   Or with hydrazine::
 
334
 
 
335
     bzr lp-propose -m "Release 1.14" --approve lp:bzr/1.14
 
336
     feed-pqm bzr
153
337
 
154
338
#. When PQM succeeds, pull down the master release branch.
155
339
 
158
342
-------------------------
159
343
 
160
344
#. Change into the source directory and run ::
161
 
  
 
345
 
162
346
     make dist
163
347
 
164
348
#. Now we'll try expanding this tarball and running the test suite
165
349
   to check for packaging problems::
166
 
 
167
 
     make check-dist-tarball
 
350
 
 
351
     make check-dist-tarball | subunit2pyunit
 
352
 
 
353
   You may encounter failures while running the test suite caused by your
 
354
   locally installed plugins. Use your own judgment to decide if you can
 
355
   release with these failures. When in doubt, disable the faulty plugins
 
356
   one by one until you get no more failures. Alternatively, you can use
 
357
   ``BZR_DISABLE_PLUGINS`` or ``BZR_PLUGIN_PATH=-site`` to disable one or
 
358
   all plugins.
 
359
 
 
360
   Remember that PQM has just tested everything too, this step is
 
361
   particularly testing that the pyrex extensions, which are updated
 
362
   by your local pyrex version when you run make dist, are in good
 
363
   shape.
 
364
 
 
365
 
 
366
Publishing the source tarball
 
367
-----------------------------
 
368
 
 
369
#. Go to the relevant <https://launchpad.net/bzr/x.y> series page in Launchpad.
 
370
 
 
371
#. Create a release of the milestone, and upload the source tarball and
 
372
   the GPG signature.  Or, if you prefer, use the
 
373
   ``tools/packaging/lp-upload-release`` script to do this. Note that
 
374
   this changes what the download widget on the Launchpad bzr home
 
375
   page shows, so don't stop the release process yet, or platform binary
 
376
   installers won't be made and the download list will stay very small!
 
377
   <https://bugs.launchpad.net/launchpad/+bug/586445>
 
378
 
 
379
 
 
380
Kick off the next cycle
 
381
-----------------------
 
382
 
 
383
From that point, there is no possible return, the tarball has been uploaded
 
384
so you can relax a bit.
 
385
 
 
386
You're still holding a "social" lock on the launchpad branch though. Until
 
387
your start the next cycle, nobody should land anything on this branch. If
 
388
they do, they either targeted the wrong branch or didn't update the news
 
389
file correctly, so the sooner the branch is opened again, the better.
 
390
 
 
391
This matters more for ``lp:bzr`` than for ``lp:bzr/x.y``, ``lp:bzr`` should
 
392
always be open for landing, so you should do `At the start of a release
 
393
cycle`_ as soon as possible (i.e. update the version number in ``bzr`` and
 
394
``bzrlib/__init__``, create/update the news files and create/update the
 
395
milestone for the next relase).
 
396
 
 
397
You may also need to do `At the start of a series cycle`_ if you're starting
 
398
a new series.
 
399
 
 
400
A word of caution: the instructions above works well for all releases but
 
401
there is one special case that requires a bit more care: when you release
 
402
the *last* beta for a given ``x.y`` series (from trunk aka lp:bzr), you need
 
403
to setup *two* branches for the next cycle:
 
404
 
 
405
#. ``lp:bzr`` needs to be opened for the next *series* ``x.(y+1)``
 
406
 
 
407
#. ``lp:bzr/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
 
408
   series. Since this is first real use of ``lp:bzr/x.y``, this is also the
 
409
   deadline for the PQM branch to be created.
 
410
 
 
411
Both are important as ``lp:bzr`` should remain open so any change can be
 
412
landed, ``lp:bzr/x.y`` on the other hand should be ready to receive bug
 
413
fixes.
 
414
 
 
415
``lp:bzr`` is generally more important as the bug fixes on ``lp:bzr/x.y``
 
416
won't be released sooner than a month from now whereas people may already
 
417
been waiting to land on ``lp:bzr``.
 
418
 
 
419
In a nutshell:
 
420
 
 
421
#. Create or update the ``x.y`` PQM branch based on whatever
 
422
   revision you want to release
 
423
 
 
424
#. Open ``lp:bzr`` for ``x.(y+1)``
 
425
 
 
426
#. Release ``x.y.0`` from ``lp:bzr/x.y``
 
427
 
 
428
#. Open ``lp:bzr/x.y`` for bug fixes
 
429
 
 
430
Announcing the source freeze
 
431
----------------------------
 
432
 
 
433
#. Post to the ``bazaar`` list, saying that the source has been frozen
 
434
   (gone gold). Be extra clear that this is only a *source* release
 
435
   targeted at packagers and installer builders (see
 
436
   <https://bugs.launchpad.net/launchpad/+bug/645084>).  This is the cue
 
437
   for platform maintainers and plugin authors to update their code.  This
 
438
   is done before the general public announcement of the release.
 
439
 
 
440
#. Pause for a few days.
168
441
 
169
442
 
170
443
Publishing the release
171
444
----------------------
172
445
 
173
 
Now you have the releasable product.  The next step is making it
 
446
There is normally a delay of a few days after the source freeze to allow
 
447
for binaries to be built on various platforms.  Once they have been built,
 
448
we have a releasable product.  The next step is to make it generally
174
449
available to the world.
175
450
 
176
 
#. In <https://launchpad.net/bzr/> click the "Release series" for this
177
 
   series, to take you to e.g. <https://launchpad.net/bzr/1.1>.  Then
178
 
   click "Register a release", and add information about this release.
179
 
 
180
 
#. Within that release, upload the source tarball and the GPG signature.
181
 
 
182
 
#. Link from http://bazaar-vcs.org/Download to the tarball and signature.
183
 
 
184
 
#. Update http://doc.bazaar-vcs.org/ to have a directory of documentation
185
 
   for this release.  (Controlled by the ``update-bzr-docs`` script on
186
 
   escudero, and also update the ``latest`` symlink in
187
 
   ``/srv/bazaar.canonical.com/doc/``.)
188
 
 
189
 
#. Announce on the `Bazaar home page`__.
190
 
   
191
 
 __ http://bazaar-vcs.org/
 
451
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
 
452
 
 
453
#. Announce on the `Bazaar website <http://bazaar.canonical.com/>`_.
 
454
   This page is edited via the lp:bzr-website branch. (Changes
 
455
   pushed to this branch are refreshed by a cron job on escudero.)
 
456
 
 
457
#. Check that the documentation for this release is available in
 
458
   <http://doc.bazaar.canonical.com>.  It should be automatically build when the
 
459
   branch is created, by a cron script ``update-bzr-docs`` on
 
460
   ``escudero``.
192
461
 
193
462
 
194
463
Announcing the release
196
465
 
197
466
Now that the release is publicly available, tell people about it.
198
467
 
199
 
#. Announce to ``bazaar-announce`` and ``bazaar`` mailing lists. 
200
 
   The announce mail will look something like this:
201
 
   
202
 
    | Subject: bzr 0.11 release candidate 1
203
 
    | 
204
 
    | INTRO HERE. Mention the release number and date, and why the release. (i.e. release candidate for testing, final release of a version, backport/bugfix etc).
205
 
    | 
206
 
    | Tarballs:
207
 
    | http://bazaar-vcs.org/releases/src/bzr-VERSION.tar.gz
208
 
    | and GPG signature:
209
 
    | http://bazaar-vcs.org/releases/src/bzr-VERSION.tar.gz.sig
210
 
    | 
211
 
    | DESCRIBE-CHANGES-IN-OVERVIEW-HERE
212
 
    | 
213
 
    | DESCRIBE-when the next release will be (if there is another - i.e. this is a release candidate)
214
 
    | 
215
 
    | Many thanks to all the contributors to this release! I've included the
216
 
    | contents of NEWS for VERSION below:
217
 
 
218
 
   To generate the data from NEWS, just copy and paste the relevant news section and clean it up as appropriate. The main clean-up task is to confirm that all major changes are indeed covered. This can be done by running ``bzr log`` back to the point when the branch was opened and cross checking the changes against the NEWS entries.
219
 
 
220
 
   (RC announcements should remind plugin maintainers to update their plugins.)
221
 
 
222
 
     * For point releases (i.e. a release candidate, or an incremental fix
223
 
       to a released version) take everything in the relevant NEWS section.  For
224
 
       example, for 0.11rc2 take everything in NEWS from the bzr 0.11rc2 line to the bzr 0.11rc1 line further down.
225
 
 
226
 
     * For major releases (i.e. 0.11, 0.12 etc), take all the combined NEWS sections from within that version: for 0.11 take all of the 0.11 specific section, plus 0.11rc2, plus 0.11rc1 etc.
227
 
 
228
 
#. Update the IRC channel topic. Use the ``/topic`` command to do this, ensuring the new topic text keeps the project name, web site link, etc.
 
468
#. Make an announcement mail.
 
469
 
 
470
   For beta releases, this is sent to the ``bazaar@lists.canonical.com``
 
471
   list only to inform plugin authors and people responsible for building
 
472
   packages or installers.
 
473
 
 
474
   Once the installers are available, the mail can be sent to the
 
475
   ``bazaar-announce`` list too.
 
476
 
 
477
   For stable releases, it should also be cc'd to ``info-gnu@gnu.org``,
 
478
   ``python-announce-list@python.org``, ``bug-directory@gnu.org``.
 
479
 
 
480
   In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
 
481
   so that people who reply to the announcement don't spam other lists.
 
482
 
 
483
   The announce mail will look something like this::
 
484
 
 
485
      Subject: bzr x.y.z released!
 
486
 
 
487
      The Bazaar team is happy to announce availability of a new
 
488
      release of the bzr adaptive version control system.
 
489
      Bazaar is part of the GNU system <http://gnu.org/>.
 
490
 
 
491
      <<Summary paragraph from news>>
 
492
 
 
493
      Thanks to everyone who contributed patches, suggestions, and
 
494
      feedback.
 
495
 
 
496
      Bazaar is now available for download from
 
497
      https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
 
498
      for various systems will be available soon.
 
499
 
 
500
      <<release notes from this release back to the last major release>>
 
501
 
 
502
   Feel free to tweak this to your taste.
 
503
 
 
504
#. Make an announcement through <https://launchpad.net/bzr/+announce>
229
505
 
230
506
#. Announce on http://freshmeat.net/projects/bzr/
231
 
   
232
 
   This should be done for both release candidates and final releases. If you do not have a Freshmeat account yet, ask one of the existing admins.
233
 
 
234
 
#. Update http://en.wikipedia.org/wiki/Bzr -- this should be done for final releases but not for Release Candidates.
235
 
 
236
 
#. Package maintainers should update packages when they see the
237
 
   announcement.
238
 
 
239
 
#. For final releases, also send the announcement mail to
240
 
   info-gnu@gnu.org and python-announce-list@python.org.
241
 
 
242
 
#. Also send a GNU directory update to bug-directory@gnu.org.
 
507
 
 
508
   This should be done for beta releases and stable releases. If you do not
 
509
   have a Freshmeat account yet, ask one of the existing admins.
 
510
 
 
511
   The purpose here is to point users to the latest stable release while still
 
512
   publishing announcements for beta releases.
 
513
 
 
514
   There are several kinds of modifications that could be done there via the
 
515
   ``Administration`` box in the lower right area of the page:
 
516
 
 
517
   * Edit the project: This is where most of the URLs proposed in the
 
518
     ``Links`` box are edited. This should rarely change except for the URLs
 
519
     related to the latest stable release.
 
520
 
 
521
   * New announcement: When doing a release, put the summary of the release
 
522
     (you can't embed URLs there, the moderation staff remove them). Users
 
523
     can still access the releases notes via the ``Release Notes`` URL in
 
524
     the ``Links`` box in the upper right area of the page. When doing the
 
525
     first stable release in a series, delete the ``Unstable installers``
 
526
     <https://launchpad.net/bzr/x.y/x.ybn> and ``Unstable source tarball``
 
527
     <http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
 
528
     links. Conversely, when creating the first beta in a development
 
529
     series, create these links again. Check all links when doing other
 
530
     kinds of release.
 
531
 
 
532
   * Set direct download: When releasing a new stable release, this should
 
533
     point to the corresponding launchpad page:
 
534
     <https://launchpad.net/bzr/x.y/x.y.z/>
 
535
 
 
536
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
 
537
   be done for the stable and beta releases.
243
538
 
244
539
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
245
540
   done by running ::
246
541
 
247
542
       python setup.py register
248
543
 
249
 
   Remember to check the results afterwards.
 
544
   Remember to check the results afterward -- this should be done for
 
545
   stable releases but not for beta releases.
250
546
 
251
547
   To be able to register the release you must create an account on
252
548
   <http://pypi.python.org/pypi> and have one of the existing owners of
256
552
Merging the released code back to trunk
257
553
---------------------------------------
258
554
 
259
 
Merge the release branch back into the trunk.  Check that changes in NEWS
260
 
were merged into the right sections.  If it's not already done, advance
261
 
the version number in ``bzr`` and ``bzrlib/__init__.py``.  Submit this
262
 
back into pqm for bzr.dev.
 
555
Merge the release branch back into the trunk.  The ``doc/en/release-notes``
 
556
changes should be merged into the right place because each release series
 
557
has its own release-notes file, but double-check.
 
558
 
 
559
If it's not already done, advance the version number in ``bzr`` and
 
560
``bzrlib/__init__.py``.  Submit this back into pqm for bzr.dev.
 
561
 
 
562
As soon as you change the version number in trunk, make sure you have
 
563
created the corresponding milestone to ensure the continuity in bug
 
564
targeting or nominating. Depending on the change, you may even have to
 
565
create a new series (if your change the major or minor release number), in
 
566
that case go to `At the start of a series cycle`_ and follow the
 
567
instructions from there.
 
568
 
 
569
 
 
570
Releases until the final one
 
571
----------------------------
 
572
 
 
573
Congratulations - you have made your first release.  Have a beer or fruit
 
574
juice - it's on the house! If it was a beta, you're not finished
 
575
yet. Another beta or hopefully a stable release is still to come.
 
576
 
 
577
The process is the same as for the first release. Goto `Doing a particular
 
578
release`_ and follow the instructions again. Some details change between
 
579
beta and stable releases, but they should be documented. If the instructions
 
580
aren't clear enough, please fix them.
 
581
 
 
582
 
 
583
Getting the release into Ubuntu
 
584
-------------------------------
 
585
 
 
586
(Feel free to propose or add new sections here about what we should do to
 
587
get bzr into other places.)
 
588
 
 
589
For the currently-under-development release of Ubuntu, no special action
 
590
is needed: the release should be picked by Debian and synced from there into
 
591
Ubuntu.
 
592
 
 
593
Releases off stable bzr branches should go in to the ``-updates`` of the
 
594
Ubuntu release that originally contained that branch.  (Ubuntu Lucid had
 
595
bzr 2.2.0, so should get every 2.2.x update.)  This means going through
 
596
the `SRU (Stable Release Updates)
 
597
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.   
 
598
 
 
599
Since September 2010, bzr has received approval by the technical
 
600
board for the `MicroReleaseExceptions
 
601
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
 
602
category so that whole bugfix releases can more easily be
 
603
approved.
 
604
 
 
605
Progress on these realeases is tracked on the `SRU wiki
 
606
<http://wiki.bazaar.canonical.com/UbuntuStableReleaseUpdates>`_
 
607
page.
 
608
 
 
609
**After making a bzr stable-release release, nominate the most serious bug
 
610
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
 
611
 
 
612
This requires a couple of tricks (please reconsider and tweak as things
 
613
evolves from one release to the other):
 
614
 
 
615
 * create a distro task with the ``Also affects distribution`` button and
 
616
   select ``bzr (Ubuntu)``.
 
617
 
 
618
 * change the *URL* to point to ``ubuntu/+source/bzr`` instead of ``bzr``
 
619
   (this is needed if you create the distro task but not if it exists
 
620
   already). You should now be able to click the ``Nominate for release``
 
621
   button and select the right Ubuntu release. As of September 2010, this
 
622
   means:
 
623
 
 
624
  * ``oneiric`` for the 2.4 series,
 
625
  * ``natty`` for the 2.3 series,
 
626
  * ``maverick`` for the 2.2 series,
 
627
  * ``lucid`` for the 2.1 series,
 
628
 
 
629
 * Subscribe the ``~ubuntu-sru`` team to the bug.
 
630
 
 
631
 * Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
 
632
   (we are targeting running the test suite during the build which, as of
 
633
   September 2010, fails for known reasons that are currently addressed).
 
634
   Search for bugs tagged with ``sru`` for examples and don't forget to tag
 
635
   the bug you selected.
263
636
 
264
637
 
265
638
See also
266
639
--------
267
640
 
268
 
 * `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
269
 
   packages.
 
641
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
 
642
  packages.
 
643
* `Bazaar Developer Document Catalog <index.html>`_
 
644
* `Development cycles <cycle.html>`_: things that happen during the cycle
 
645
  before the actual release.
270
646
 
271
647
..
272
648
   vim: filetype=rst textwidth=74 ai shiftwidth=4