~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/releasing.txt

  • Committer: Jelmer Vernooij
  • Date: 2011-08-29 19:06:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6119.
  • Revision ID: jelmer@samba.org-20110829190657-o5sa35xv779g79g9
Add Tree.has_versioned_directories.

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
5
release, and managing the release process.  This is just one phase of the
6
 
`overall development cycle <http://doc.bazaar-vcs.org/developers/cycle.html>`_,
7
 
but it's the most complex part.
8
 
This document gives a checklist you can follow from start to end in one
9
 
go.
 
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.
10
15
 
11
16
If you're helping the Release Manager (RM) for one reason or another, you
12
17
may notice that he didn't follow that document scrupulously. He may have
13
18
good reasons to do that but he may also have missed some parts.
14
19
 
15
 
Follow the document yourself and don't hesitate to create the missing
16
 
milestones for example (we tend to forget these ones a lot).
17
 
 
18
20
.. contents::
19
21
 
20
22
 
21
23
Preconditions
22
 
-------------
 
24
=============
 
25
 
 
26
#. PQM access rights (or you won't be able to land any change)
23
27
 
24
28
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
25
29
 
26
30
     bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
27
31
 
28
 
 
29
 
Starting a cycle
30
 
----------------
 
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
===============================
31
144
 
32
145
To start a new release cycle:
33
146
 
34
 
#. Create a new series at <https://launchpad.net/bzr/+addseries>. There is one
35
 
   series for every *x.y* release.
36
 
 
37
 
#. Go to the series web page at <https://launchpad.net/bzr/x.y>
38
 
 
39
 
#. Create a new release at
40
 
   <https://launchpad.net/bzr/x.y/+addrelease> and add
41
 
   information about this release. We will not use it yet, but it
42
 
   will be available for targeting or nominating bugs.
43
 
 
44
 
#. We create a new pqm-controlled branch for this release series, by
45
 
   asking a Canonical sysadmin.
46
 
   This branch means that from the first release beta or candidate onwards,
47
 
   general development continues on the trunk, and only
48
 
   specifically-targeted fixes go into the release branch.
49
 
 
50
 
#. Add milestones at <https://edge.launchpad.net/bzr/x.y/+addmilestone> to
51
 
   that series for the beta release, release candidate and the final release,
52
 
   and their expected dates.
53
 
 
54
 
#. Update the version number in the ``bzr`` script, and the
55
 
   ``bzrlib/__init__.py`` file. Make sure there is always a corresponding
56
 
   milestone when you change that version number.
57
 
 
58
 
#. Add a new section at the top of ``NEWS`` about the new release,
59
 
   including its version number and the headings from
60
 
   ``NEWS-template.txt``.
61
 
 
62
147
#. Send mail to the list with the key dates, who will be the release
63
148
   manager, and the main themes or targeted bugs.  Ask people to nominate
64
149
   objectives, or point out any high-risk things that are best done early,
65
150
   or that interact with other changes. This is called the metronome mail
66
151
   and is described in `Development cycles <cycle.html>`_.
67
152
 
68
 
#. Make a local branch for preparing this release.  (Only for the first
69
 
   release in a series, otherwise you should already have a branch.) ::
70
 
 
71
 
     bzr branch trunk prepare-1.14
 
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.
72
163
 
73
164
#. Configure pqm-submit for this branch, with a section like this (where
74
 
   x.y is the version to release).
75
 
   ``~/.bazaar/locations.conf``::
 
165
   ``x.y`` is the series for your release). **Or use hydrazine for easier
 
166
   setup** ``~/.bazaar/locations.conf``::
76
167
 
77
 
        [/home/mbp/bzr/prepare-x.y]
 
168
        [/home/mbp/bzr/x.y-dev]
78
169
        pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
79
170
        submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
80
171
        parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
81
 
        public_branch = http://bazaar.example.com/prepare-x.y
 
172
        public_branch = http://bazaar.example.com/x.y-dev
82
173
        submit_to = bazaar@lists.canonical.com
83
174
        smtp_server = mail.example.com:25
84
175
 
85
 
    Please see <http://doc.bazaar-vcs.org/developers/HACKING.html#an-overview-of-pqm>
 
176
    Please see <http://doc.bazaar.canonical.com/developers/HACKING.html#an-overview-of-pqm>
86
177
    for more details on PQM
87
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
 
88
209
#. In the release branch, update  ``version_info`` in ``./bzrlib/__init__.py``.
89
210
   Make sure the corresponding milestone exists.
90
211
   Double check that ./bzr ``_script_version`` matches ``version_info``. Check
91
 
   the output of ``bzr --version``.
 
212
   the output of ``./bzr --version``.
92
213
 
93
214
   For beta releases use::
94
215
 
 
216
       version_info = (2, 1, 0, 'beta', SERIAL)
 
217
 
 
218
   For instance 2.1b1::
 
219
 
95
220
       version_info = (2, 1, 0, 'beta', 1)
96
221
 
97
 
 
98
 
   For release candidates use::
99
 
 
100
 
       version_info = (2, 0, 1, 'candidate', 1)
101
 
 
102
 
 
103
 
Starting the release phase
104
 
--------------------------
105
 
 
106
 
#. Create a new milestone at <https://launchpad.net/bzr/x.y/+addmilestone>
107
 
   for the beta release or release candidate if you haven't already.
108
 
 
109
 
#. Add the date and release number to ``./NEWS``
110
 
 
111
 
   Depending on whether you're doing a beta or a bugfix release, you'll
112
 
   have to create a NEWS section for your release in the right
113
 
   place. Most of the time, the new section is at the top of the file
114
 
   (look what have been done for the various 2.0x and 2.1.0bx releases).
115
 
   The rule is to keep the sections sorted by date. You'll need to be
116
 
   cautious when merging back to trunk to respect that.
117
 
 
118
 
#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
119
 
   closed in Launchpad, you can run ``tools/check-newsbugs.py``::
120
 
 
121
 
     ./tools/check-newsbugs.py NEWS
122
 
 
123
 
   (But note there can be some false positives, and this script may be
124
 
   flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>.  Don't let
125
 
   this slow you down too much.)
126
 
 
127
 
#. Summarize into one or two paragraphs what's new in this release.
 
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.
128
248
 
129
249
#. Commit these changes to the release branch, using a command like::
130
250
 
131
 
     bzr commit -m "Release 1.14."
 
251
     bzr commit -m "Release 2.3.1"
132
252
 
133
253
   The diff before you commit will be something like::
134
254
 
135
 
     === modified file 'NEWS'
136
 
     --- NEWS        2008-09-17 23:09:18 +0000
137
 
     +++ NEWS        2008-09-23 16:14:54 +0000
138
 
     @@ -4,6 +4,23 @@
139
 
 
140
 
      .. contents::
141
 
 
142
 
     +bzr 1.7 2008-09-23
143
 
     +------------------
144
 
     +
145
 
     +This release includes many bug fixes and a few performance and feature
146
 
     +improvements.  ``bzr rm`` will now scan for missing files and remove them,
147
 
     +like how ``bzr add`` scans for unknown files and adds them. A bit more
148
 
     +polish has been applied to the stacking code. The b-tree indexing code has
149
 
     +been brought in, with an eye on using it in a future repository format.
150
 
     +There are only minor installer changes since bzr-1.7rc2.
151
 
     +
152
 
      bzr 1.7rc2 2008-09-17
153
 
      ---------------------
154
 
 
155
 
 
156
 
     === modified file 'bzrlib/__init__.py'
157
 
     --- bzrlib/__init__.py  2008-09-16 21:39:28 +0000
158
 
     +++ bzrlib/__init__.py  2008-09-23 16:14:54 +0000
159
 
     @@ -41,7 +41,7 @@
160
 
      # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
161
 
      # releaselevel of 'dev' for unreleased under-development code.
162
 
 
163
 
     -version_info = (1, 7, 0, 'candidate', 2)
164
 
     +version_info = (1, 7, 0, 'final', 0)
165
 
 
166
 
 
167
 
      # API compatibility version: bzrlib is currently API compatible with 1.7.
 
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
      
168
320
 
169
321
#. Tag the new release::
170
322
 
171
 
     bzr tag bzr-1.14
 
323
     bzr tag bzr-2.3.1
172
324
 
173
 
#. Push those changes to a bzr reposistory that is public and accessible on
174
 
   the Internet. PQM will pull from this repository when it attempts to merge
175
 
   your changes. Then submit those changes to PQM for merge into the
176
 
   appropriate release branch::
 
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::
177
329
 
178
330
     bzr push
179
 
     bzr pqm-submit -m "(mbp) prepare 1.14"
 
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
180
337
 
181
338
#. When PQM succeeds, pull down the master release branch.
182
339
 
191
348
#. Now we'll try expanding this tarball and running the test suite
192
349
   to check for packaging problems::
193
350
 
194
 
     make check-dist-tarball
195
 
 
196
 
   You may encounter failures while running the test suite caused
197
 
   by your locally installed plugins. Use your own judgment to
198
 
   decide if you can release with these failures. When in doubt,
199
 
   disable the faulty plugins one by one until you get no more
200
 
   failures.
 
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.
201
364
 
202
365
 
203
366
Publishing the source tarball
204
367
-----------------------------
205
368
 
206
 
#. Go to the relevant milestone page in Launchpad.
207
 
 
208
 
#. Within that release, upload the source tarball and the GPG
209
 
   signature.  Or, if you prefer, use the
210
 
   ``tools/packaging/lp-upload-release`` script to do this.
211
 
 
 
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
212
429
 
213
430
Announcing the source freeze
214
431
----------------------------
215
432
 
216
 
#. Post to the ``bazaar`` list, saying that the source has been frozen.
217
 
   This is the cue for platform maintainers and plugin authors to update
218
 
   their code.  This is done before the general public announcement of the
219
 
   release.
 
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.
220
441
 
221
442
 
222
443
Publishing the release
227
448
we have a releasable product.  The next step is to make it generally
228
449
available to the world.
229
450
 
230
 
go to the release
231
 
 
232
 
#. Within that release, upload the source tarball and zipfile and the GPG
233
 
   signature.  Or, if you prefer, use the
234
 
   ``tools/packaging/lp-upload-release`` script to do this.
235
 
 
236
 
#. Link from http://bazaar-vcs.org/SourceDownloads to the tarball and
237
 
   signature.
238
 
 
239
 
#. Announce on the `Bazaar website <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/>`_.
240
454
   This page is edited via the lp:bzr-website branch. (Changes
241
455
   pushed to this branch are refreshed by a cron job on escudero.)
242
456
 
243
 
#. Announce on the `Bazaar wiki <http://bazaar-vcs.org/Welcome>`_.
244
 
 
245
457
#. Check that the documentation for this release is available in
246
 
   <http://doc.bazaar-vcs.org>.  It should be automatically build when the
 
458
   <http://doc.bazaar.canonical.com>.  It should be automatically build when the
247
459
   branch is created, by a cron script ``update-bzr-docs`` on
248
 
   ``escudero``. As of today (2009-08-27) ``igc`` manually updates the
249
 
   pretty version of it.
 
460
   ``escudero``.
250
461
 
251
462
 
252
463
Announcing the release
256
467
 
257
468
#. Make an announcement mail.
258
469
 
259
 
   For release candidates or beta releases, this is sent to the ``bazaar``
260
 
   list only to inform plugin authors and package or installer managers.
 
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.
261
473
 
262
474
   Once the installers are available, the mail can be sent to the
263
475
   ``bazaar-announce`` list too.
264
476
 
265
 
   For final releases, it should also be cc'd to ``info-gnu@gnu.org``,
 
477
   For stable releases, it should also be cc'd to ``info-gnu@gnu.org``,
266
478
   ``python-announce-list@python.org``, ``bug-directory@gnu.org``.
267
479
 
268
480
   In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
270
482
 
271
483
   The announce mail will look something like this::
272
484
 
273
 
      Subject: bzr x.yy released!
274
 
 
275
 
      <<Summary paragraph from news>>
 
485
      Subject: bzr x.y.z released!
276
486
 
277
487
      The Bazaar team is happy to announce availability of a new
278
488
      release of the bzr adaptive version control system.
279
489
      Bazaar is part of the GNU system <http://gnu.org/>.
280
490
 
 
491
      <<Summary paragraph from news>>
 
492
 
281
493
      Thanks to everyone who contributed patches, suggestions, and
282
494
      feedback.
283
495
 
284
496
      Bazaar is now available for download from
285
 
      http://bazaar-vcs.org/Download as a source tarball; packages
 
497
      https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
286
498
      for various systems will be available soon.
287
499
 
288
 
      <<NEWS section from this release back to the last major release>>
 
500
      <<release notes from this release back to the last major release>>
289
501
 
290
502
   Feel free to tweak this to your taste.
291
503
 
292
504
#. Make an announcement through <https://launchpad.net/bzr/+announce>
293
505
 
294
 
#. Update the IRC channel topic. Use the ``/topic`` command to do this,
295
 
   ensuring the new topic text keeps the project name, web site link, etc.
296
 
 
297
506
#. Announce on http://freshmeat.net/projects/bzr/
298
507
 
299
 
   This should be done for beta releases, release candidates and final
300
 
   releases. If you do not have a Freshmeat account yet, ask one of the
301
 
   existing admins.
 
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/>
302
535
 
303
536
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
304
 
   be done for final releases but not for beta releases or Release Candidates.
 
537
   be done for the stable and beta releases.
305
538
 
306
539
#. Update the python package index: <http://pypi.python.org/pypi/bzr> - best
307
540
   done by running ::
308
541
 
309
542
       python setup.py register
310
543
 
311
 
   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.
312
546
 
313
547
   To be able to register the release you must create an account on
314
548
   <http://pypi.python.org/pypi> and have one of the existing owners of
318
552
Merging the released code back to trunk
319
553
---------------------------------------
320
554
 
321
 
Merge the release branch back into the trunk.  Check that changes in NEWS
322
 
were merged into the right sections.  If it's not already done, advance
323
 
the version number in ``bzr`` and ``bzrlib/__init__.py``.  Submit this
324
 
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.
325
561
 
326
562
As soon as you change the version number in trunk, make sure you have
327
563
created the corresponding milestone to ensure the continuity in bug
328
564
targeting or nominating. Depending on the change, you may even have to
329
565
create a new series (if your change the major or minor release number), in
330
 
that case go to `Starting a cycle` and follow the instructions from there.
 
566
that case go to `At the start of a series cycle`_ and follow the
 
567
instructions from there.
331
568
 
332
 
You should also merge (not pull) the release branch into
333
 
``lp:~bzr/bzr/current``, so that branch contains the current released code
334
 
at any time.
335
569
 
336
570
Releases until the final one
337
571
----------------------------
338
572
 
339
 
Congratulations - you have made your first release.  Have a beer
340
 
or fruit juice - it's on the house! If it was a beta, or
341
 
candidate, you're not finished yet. Another beta or candidate or
342
 
hopefully a final release is still to come.
343
 
 
344
 
The process is the same as for the first release. Goto `Starting the
345
 
release phase`_ and follow the instructions again. Some details change
346
 
between beta, candidate and final releases, but they should be
347
 
documented. If the instructions aren't clear enough, please fix them.
 
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.
348
636
 
349
637
 
350
638
See also