~bzr-pqm/bzr/bzr.dev

3383.2.3 by Martin Pool
Separate out and update the release manager instructions
1
Releasing Bazaar
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
2
################
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
3
4
This document describes the processes for making and announcing a Bazaar
6011.3.1 by Vincent Ladeuil
releasing notes refresh
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
6011.3.6 by Vincent Ladeuil
Fix typos caught by Martin.
12
each step explanation. It's also a good practice to read it for any release
6011.3.1 by Vincent Ladeuil
releasing notes refresh
13
to ensure you don't miss a step and to update it as the release process
14
evolves.
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
15
4634.13.4 by Vincent Ladeuil
More tweaks.
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
4634.13.6 by Vincent Ladeuil
Fixed as per Ian's review.
18
good reasons to do that but he may also have missed some parts.
4634.13.4 by Vincent Ladeuil
More tweaks.
19
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
20
.. contents::
21
4584.2.1 by Martin Pool
Update release cycle doc for 6m cycles
22
4632.2.1 by Martin Pool
Release docs: bzr-pqm is a precondition not part of the every-release process
23
Preconditions
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
24
=============
4632.2.1 by Martin Pool
Release docs: bzr-pqm is a precondition not part of the every-release process
25
6011.3.1 by Vincent Ladeuil
releasing notes refresh
26
#. PQM access rights (or you won't be able to land any change)
27
4632.2.1 by Martin Pool
Release docs: bzr-pqm is a precondition not part of the every-release process
28
#. Download the pqm plugin and install it into your ``~/.bazaar/plugins``::
29
30
     bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm
31
6011.3.1 by Vincent Ladeuil
releasing notes refresh
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``
6011.3.6 by Vincent Ladeuil
Fix typos caught by Martin.
51
   starts at 1 and is incremented. These releases are targeted to beta
6011.3.1 by Vincent Ladeuil
releasing notes refresh
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``
6581.1.3 by Vincent Ladeuil
Release 2.6.0
56
   starts at 0 and is incremented. These releases are targeted at people
6011.3.1 by Vincent Ladeuil
releasing notes refresh
57
   that want bugfixes only and no new features.
58
59
6011.3.7 by Vincent Ladeuil
More spelling fixes.
60
Differences in the release process between beta and stable release will be
6011.3.1 by Vincent Ladeuil
releasing notes refresh
61
mentioned when needed.
5447.2.2 by Vincent Ladeuil
More updates following list discussion.
62
63
When do we relase ?
64
===================
65
6011.3.8 by Vincent Ladeuil
Add a step-by-step for x.y.0 to minimize the window where trunk is "closed".
66
As of July 2011, we maintain four series (and one that is about to be EOLed).
6011.3.1 by Vincent Ladeuil
releasing notes refresh
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).
5447.2.1 by Vincent Ladeuil
Fix some typos and propose a release planning.
71
72
In order to continue to do time-based releases, we need to plan the
5447.2.2 by Vincent Ladeuil
More updates following list discussion.
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.
5447.2.1 by Vincent Ladeuil
Fix some typos and propose a release planning.
76
6011.3.1 by Vincent Ladeuil
releasing notes refresh
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
6011.3.6 by Vincent Ladeuil
Fix typos caught by Martin.
90
#. previous series should release on a regular basis without interfering
6011.3.1 by Vincent Ladeuil
releasing notes refresh
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
6011.3.13 by Vincent Ladeuil
Get rid of the open question.
109
   stable series via the stable PPA but that the SRU processs allow us to
110
   reach a wider audience.
6011.3.1 by Vincent Ladeuil
releasing notes refresh
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
6011.3.6 by Vincent Ladeuil
Fix typos caught by Martin.
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.
6011.3.1 by Vincent Ladeuil
releasing notes refresh
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
5447.2.1 by Vincent Ladeuil
Fix some typos and propose a release planning.
140
6474.2.3 by Vincent Ladeuil
Update the top doc index as part of starting a new series.
141
#. Update ``doc/en/index.txt`` to point to the new whats-new file.
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
142
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
143
At the start of a release cycle
144
===============================
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
145
146
To start a new release cycle:
147
148
#. Send mail to the list with the key dates, who will be the release
149
   manager, and the main themes or targeted bugs.  Ask people to nominate
150
   objectives, or point out any high-risk things that are best done early,
4634.13.2 by Vincent Ladeuil
Fixed as per Martin's review.
151
   or that interact with other changes. This is called the metronome mail
4634.13.4 by Vincent Ladeuil
More tweaks.
152
   and is described in `Development cycles <cycle.html>`_.
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
153
6011.3.1 by Vincent Ladeuil
releasing notes refresh
154
#. Make a local branch to prepare the release::
155
156
        bzr branch lp:bzr/x.y x.y-dev
157
158
   If you're doing your first beta release, branch from trunk::
159
160
       bzr branch lp:bzr x.y-dev
161
162
   Note that you will generally reuse the same branch for all releases in a
163
   given series.
4104.7.1 by Robert J. Tanner
Updated the releasing.html document, adding some documentation on things I had
164
4675.2.2 by Robert Collins
Replace bazaar-vcs.org/bzr/ references with launchpad hosting urls in developer docs.
165
#. Configure pqm-submit for this branch, with a section like this (where
6011.3.1 by Vincent Ladeuil
releasing notes refresh
166
   ``x.y`` is the series for your release). **Or use hydrazine for easier
167
   setup** ``~/.bazaar/locations.conf``::
3464.3.6 by Martin Pool
Release process updates
168
6011.3.1 by Vincent Ladeuil
releasing notes refresh
169
	[/home/mbp/bzr/x.y-dev]
3464.3.6 by Martin Pool
Release process updates
170
	pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
4675.2.2 by Robert Collins
Replace bazaar-vcs.org/bzr/ references with launchpad hosting urls in developer docs.
171
	submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
4820.1.1 by Vincent Ladeuil
Further clarifications on building releases
172
	parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
6011.3.1 by Vincent Ladeuil
releasing notes refresh
173
	public_branch = http://bazaar.example.com/x.y-dev
3464.3.6 by Martin Pool
Release process updates
174
	submit_to = bazaar@lists.canonical.com
4634.13.2 by Vincent Ladeuil
Fixed as per Martin's review.
175
	smtp_server = mail.example.com:25
4104.7.1 by Robert J. Tanner
Updated the releasing.html document, adding some documentation on things I had
176
5370.1.2 by John Arbash Meinel
Small tweaks to releasing urls.
177
    Please see <http://doc.bazaar.canonical.com/developers/HACKING.html#an-overview-of-pqm>
4070.10.13 by Martin Pool
Remove or correct broken links
178
    for more details on PQM
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
179
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
180
#. Update the version number in the ``bzr`` script, and the
181
   ``bzrlib/__init__.py`` file::
182
   
183
       version_info = (x, y, z, 'dev', 0)
184
   
5462.5.7 by Andrew Bennetts
Update 'Releasing Bazaar' doc.
185
#. Add a new section at the top of the current release notes (in
186
   ``doc/en/release-notes``) about the new release, including its version
187
   number and the headings from ``release-template.txt``.
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
188
5050.19.1 by Martin Pool
Mention the need to maintain the 'what's new' document
189
#. Update the "What's New" documents in ``doc/en/whats-new``.
190
6011.3.4 by Vincent Ladeuil
More tweaks and typo fixes.
191
#. Make sure a milestone exists for your release and that it is active,
192
   <https://launchpad.net/bzr/x.y> lists the existing milestones,
193
   <https://launchpad.net/bzr/x.y/x.y.z/+edit> allows you to toggle the
6011.3.1 by Vincent Ladeuil
releasing notes refresh
194
   active flag.
195
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
196
#. Commit this and send it to PQM.
197
198
199
Doing a particular release
200
==========================
201
202
Update the source code
203
----------------------
204
205
#. Check that there is a milestone for the release you're doing. If there
206
   is no milestone it indicates a process problem - make the milestone but
207
   also mail the list to raise this issue in our process. Milestones are
208
   found at <https://launchpad.net/bzr/+milestone/x.y.z>.
209
6060.8.5 by Vincent Ladeuil
Mention some more cheks to be done before freezing a release.
210
#. Merge into your branch all previous stable series fixes that haven't been
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
211
   merged yet. For example, if you're releasing 2.6.x, make sure the fixes
212
   on 2.5, 2.4, 2.3, etc have already been merged up::
6060.8.5 by Vincent Ladeuil
Mention some more cheks to be done before freezing a release.
213
214
     bzr merge lp:bzr/2.4
215
216
   and commit that merge in its own commit. This should happen only if the
217
   devs landing changes in previous releases forgot to merge them up. Since
218
   this can slow down the freeze, feel free to gently remind them about
219
   their duties ;) If you feel unsafe resolving the conflicts or it's too
220
   time consuming, contact the related devs and skip this merge.
221
 
4152.2.7 by Robert J. Tanner
Added explicit instructions to check ./bzr _script_version ./bzrlib/__init__.py
222
#. In the release branch, update  ``version_info`` in ``./bzrlib/__init__.py``.
4634.13.4 by Vincent Ladeuil
More tweaks.
223
   Make sure the corresponding milestone exists.
4152.2.7 by Robert J. Tanner
Added explicit instructions to check ./bzr _script_version ./bzrlib/__init__.py
224
   Double check that ./bzr ``_script_version`` matches ``version_info``. Check
6011.3.1 by Vincent Ladeuil
releasing notes refresh
225
   the output of ``./bzr --version``.
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
226
5609.1.1 by Vincent Ladeuil
Release 2.3b5
227
   For beta releases use::
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
228
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
229
       version_info = (2, 6, 0, 'beta', SERIAL)
230
231
   For instance 2.6b1::
232
233
       version_info = (2, 6, 0, 'beta', 1)
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
234
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
235
   For stable releases use::
236
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
237
       version_info = (2, 6, 0, 'final', 0)
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
238
5462.5.7 by Andrew Bennetts
Update 'Releasing Bazaar' doc.
239
#. Update the ``./doc/en/release-notes/`` section for this release.
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
240
6060.8.5 by Vincent Ladeuil
Mention some more cheks to be done before freezing a release.
241
   Check that all news entries related to this release have been added in
6524.3.1 by Vincent Ladeuil
Minor RM tweaks
242
   the right section. For example, if you're releasing 2.6b2, the following
243
   command should display a a single chuk diff for the 2.6b2 release::
6060.8.5 by Vincent Ladeuil
Mention some more cheks to be done before freezing a release.
244
6524.3.1 by Vincent Ladeuil
Minor RM tweaks
245
     bzr diff -rbzr-2.6b2.. doc/en/release-notes/bzr-2.6.txt
6060.8.5 by Vincent Ladeuil
Mention some more cheks to be done before freezing a release.
246
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
247
   Fill out the date and a description of the release under the existing
6060.8.5 by Vincent Ladeuil
Mention some more cheks to be done before freezing a release.
248
   header (the diff above will help you summarizing). If there isn't one,
249
   follow the instructions above for using the ``release-template.txt`` file
250
   and remind people that they should document their changes there ;)
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
251
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
252
   See *2.6b1* or similar for an example of what this looks like.
4634.13.4 by Vincent Ladeuil
More tweaks.
253
6011.3.1 by Vincent Ladeuil
releasing notes refresh
254
#. Add or check the summary of the release into the "What's New" document.
5050.19.1 by Martin Pool
Mention the need to maintain the 'what's new' document
255
6474.2.6 by Vincent Ladeuil
Review feedback.
256
  If this is the first release in a new series make sure to update the
257
  introduction mentioning:
258
259
  * the date of this first release,
260
  * until when the series is expected to be supported.
261
262
  Looking at ``bzr annotate`` for previous series should give you the right
263
  hints. The ``doc/en/_templates/index.html`` file should also be updated.
6474.2.4 by Vincent Ladeuil
The what's new file should be updated to mention the release and expected
264
5462.5.7 by Andrew Bennetts
Update 'Releasing Bazaar' doc.
265
#. To check that all bugs mentioned in the release notes are actually
266
   marked as closed in Launchpad, you can run
267
   ``tools/check-newsbugs.py``::
3966.2.6 by Jelmer Vernooij
Mention check-newsbugs.py in the release document.
268
5462.5.7 by Andrew Bennetts
Update 'Releasing Bazaar' doc.
269
     ./tools/check-newsbugs.py doc/en/release-notes/bzr-x.y.txt
3966.2.6 by Jelmer Vernooij
Mention check-newsbugs.py in the release document.
270
6011.3.7 by Vincent Ladeuil
More spelling fixes.
271
   As of 2011-07-18, all bugs mentioned in the output of the script requires
6011.3.6 by Vincent Ladeuil
Fix typos caught by Martin.
272
   some sort of intervention (either changing the status if it's not 'Fix
6011.3.1 by Vincent Ladeuil
releasing notes refresh
273
   Released' or setting a different milestone if the bug hasn't been
274
   fixed). A few false positives may remain in the older series, don't let
275
   this slow you down too much. This script accepts options you may find
6060.8.4 by Vincent Ladeuil
Mentions Canonical as the lead sponsor and other tweaks.
276
   useful, use ``./tools/check-newsbugs.py`` to display its usage (``-w``
277
   will open each bug in your browser for example).
4595.6.2 by Martin Pool
Guidance on using check-newsbugs when releasing
278
6133.2.1 by Jonathan Riddell
add translations to release process
279
#. For beta releases update the translation template::
280
6234.4.1 by Vincent Ladeuil
Updated the instructions to prepare the translations template, freshmeat became freecode, freeze announces should be sent to bzr-packagers too.
281
     BZR_PLUGIN_PATH=-site make po/bzr.pot
6133.2.1 by Jonathan Riddell
add translations to release process
282
6439.1.1 by Vincent Ladeuil
Mentioning the milestone URL in annoucements gives an easy access to the detailed description of the release
283
   This is especially important for the final beta release which is when
284
   translations are frozen and translators are requested (see `The final
285
   beta - branching and translations`_) to make the translations.
6133.2.1 by Jonathan Riddell
add translations to release process
286
287
#. For stable releases update the translations::
288
289
     bzr merge lp:~bzr-core/bzr/bzr-translations-export-x.y
290
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
291
#. Commit these changes to the release branch, using a command like::
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
292
5712.1.1 by Vincent Ladeuil
Tweak release instructions.
293
     bzr commit -m "Release 2.3.1"
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
294
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
295
   The diff before you commit will be something like::
296
5712.1.1 by Vincent Ladeuil
Tweak release instructions.
297
      === modified file 'bzrlib/__init__.py'
298
      --- bzrlib/__init__.py	2011-02-09 06:35:00 +0000
299
      +++ bzrlib/__init__.py	2011-03-10 10:24:47 +0000
300
      @@ -52,7 +52,7 @@
301
       # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
302
       # releaselevel of 'dev' for unreleased under-development code.
303
       
304
      -version_info = (2, 3, 1, 'dev', 0)
305
      +version_info = (2, 3, 1, 'final', 0)
306
       
307
       # API compatibility version
308
       api_minimum_version = (2, 3, 0)
309
      
310
      === modified file 'doc/en/release-notes/bzr-2.3.txt'
311
      --- doc/en/release-notes/bzr-2.3.txt	2011-03-09 08:30:16 +0000
312
      +++ doc/en/release-notes/bzr-2.3.txt	2011-03-10 10:40:47 +0000
313
      @@ -8,23 +8,10 @@
314
       bzr 2.3.1
315
       #########
316
       
317
      -:2.3.1: NOT RELEASED YET
318
      -
319
      -External Compatibility Breaks
320
      -*****************************
321
      -
322
      -.. These may require users to change the way they use Bazaar.
323
      -
324
      -New Features
325
      -************
326
      -
327
      -.. New commands, options, etc that users may wish to try out.
328
      -
329
      -Improvements
330
      -************
331
      -
332
      -.. Improvements to existing commands, especially improved performance 
333
      -   or memory usage, or better results.
334
      +:2.3.1: 2011-03-10
335
      +
336
      +This is a bugfix release. Upgrading is recommended for all users of earlier
337
      +2.3 releases.
338
       
339
       Bug Fixes
340
       *********
341
      
342
      === modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
343
      --- doc/en/whats-new/whats-new-in-2.3.txt	2011-02-03 16:29:18 +0000
344
      +++ doc/en/whats-new/whats-new-in-2.3.txt	2011-03-10 11:10:36 +0000
345
      @@ -17,8 +17,13 @@
346
       improvements made to the core product, it highlights enhancements within the
347
       broader Bazaar world of potential interest to those upgrading.
348
       
349
      -Bazaar 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
350
      -and 2.2, and can read and write repositories generated by all previous
351
      +Bazaar 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
352
      +versions that weren't included in 2.3.0 and fixes some bugs on its own.
353
      +
354
      +See the :doc:`../release-notes/index` for details.
355
      +
356
      +Bazaar 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
357
      +and 2.2. It can read and write repositories generated by all previous
358
       versions.
359
       
360
       Changed Behaviour
361
      
5447.2.1 by Vincent Ladeuil
Fix some typos and propose a release planning.
362
4634.13.3 by Vincent Ladeuil
Fix rst formatting issues.
363
#. Tag the new release::
3997.2.1 by Jelmer Vernooij
Add tagging to the release process.
364
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
365
     bzr tag bzr-2.6.0
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
366
6011.3.1 by Vincent Ladeuil
releasing notes refresh
367
#. Push those changes to a bzr branch that is public and accessible on the
368
   Internet. PQM will pull from this branch when it attempts to merge your
369
   changes. Then submit those changes to PQM for merge into the appropriate
370
   release branch::
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
371
3464.3.6 by Martin Pool
Release process updates
372
     bzr push
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
373
     bzr pqm-submit -m "(vila) Release 2.6.0 (Vincent Ladeuil)"
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
374
6234.4.1 by Vincent Ladeuil
Updated the instructions to prepare the translations template, freshmeat became freecode, freeze announces should be sent to bzr-packagers too.
375
   Note that ``bzr push`` should mention updating one tag (which you just
6234.4.2 by Vincent Ladeuil
Fix typo.
376
   created). If it doesn't, double-check that you created (and pushed) this
6234.4.1 by Vincent Ladeuil
Updated the instructions to prepare the translations template, freshmeat became freecode, freeze announces should be sent to bzr-packagers too.
377
   tag.
378
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
379
   Or with hydrazine::
380
381
     bzr lp-propose -m "Release 1.14" --approve lp:bzr/1.14
382
     feed-pqm bzr
383
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
384
#. When PQM succeeds, pull down the master release branch.
385
3464.3.6 by Martin Pool
Release process updates
386
3383.2.4 by Martin Pool
Trim from the release instructions things that are now automated or unnecessary
387
Making the source tarball
388
-------------------------
389
3408.1.3 by Martin Pool
More release process updates
390
#. Change into the source directory and run ::
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
391
3383.2.4 by Martin Pool
Trim from the release instructions things that are now automated or unnecessary
392
     make dist
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
393
3408.1.3 by Martin Pool
More release process updates
394
#. Now we'll try expanding this tarball and running the test suite
395
   to check for packaging problems::
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
396
5555.2.1 by Vincent Ladeuil
Mention some tricks about running check-dist-tarball.
397
     make check-dist-tarball | subunit2pyunit
3383.2.5 by Martin Pool
merge trunk
398
5555.2.1 by Vincent Ladeuil
Mention some tricks about running check-dist-tarball.
399
   You may encounter failures while running the test suite caused by your
400
   locally installed plugins. Use your own judgment to decide if you can
401
   release with these failures. When in doubt, disable the faulty plugins
402
   one by one until you get no more failures. Alternatively, you can use
403
   ``BZR_DISABLE_PLUGINS`` or ``BZR_PLUGIN_PATH=-site`` to disable one or
404
   all plugins.
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
405
6060.8.1 by Vincent Ladeuil
Mention bug #839461 and clarify the GNU reference.
406
   Until <http://pad.lv/839461> is fixed, you may encounter issues if you
407
   cut a release for old stable branches (<= 2.2) and use a more recent
408
   OS/distro. If that's the case, check the bug status and use the following
409
   workaround if no fix is available::
410
411
     export TTPATH=<local branch of lp:testtools -r 0.9.2>
412
     export SUPATH=<local branch of lp:subunit -r 0.0.6>
413
     PYTHONPATH=$TTPATH:$SUPATH/python PATH=$SUPATH/filters:${PATH} BZR_PLUGIN_PATH=-site make check-dist-tarball PYTHON=python2.6 | subunit2pyunit
414
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
415
   Remember that PQM has just tested everything too, this step is
416
   particularly testing that the pyrex extensions, which are updated
417
   by your local pyrex version when you run make dist, are in good
418
   shape.
419
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
420
4676.6.1 by mbp at sourcefrog
Updates to release process docs.
421
Publishing the source tarball
422
-----------------------------
423
6011.3.12 by Vincent Ladeuil
Fix typo
424
#. Go to the relevant <https://launchpad.net/bzr/x.y> series page in Launchpad.
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
425
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
426
#. Create a release of the milestone, and upload the source tarball and
427
   the GPG signature.  Or, if you prefer, use the
428
   ``tools/packaging/lp-upload-release`` script to do this. Note that
429
   this changes what the download widget on the Launchpad bzr home
430
   page shows, so don't stop the release process yet, or platform binary
431
   installers won't be made and the download list will stay very small!
5447.2.1 by Vincent Ladeuil
Fix some typos and propose a release planning.
432
   <https://bugs.launchpad.net/launchpad/+bug/586445>
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
433
4676.6.1 by mbp at sourcefrog
Updates to release process docs.
434
6011.3.1 by Vincent Ladeuil
releasing notes refresh
435
Kick off the next cycle
436
-----------------------
437
438
From that point, there is no possible return, the tarball has been uploaded
439
so you can relax a bit.
440
441
You're still holding a "social" lock on the launchpad branch though. Until
442
your start the next cycle, nobody should land anything on this branch. If
443
they do, they either targeted the wrong branch or didn't update the news
444
file correctly, so the sooner the branch is opened again, the better.
445
6011.3.4 by Vincent Ladeuil
More tweaks and typo fixes.
446
This matters more for ``lp:bzr`` than for ``lp:bzr/x.y``, ``lp:bzr`` should
6011.3.1 by Vincent Ladeuil
releasing notes refresh
447
always be open for landing, so you should do `At the start of a release
6011.3.7 by Vincent Ladeuil
More spelling fixes.
448
cycle`_ as soon as possible (i.e. update the version number in ``bzr`` and
6011.3.4 by Vincent Ladeuil
More tweaks and typo fixes.
449
``bzrlib/__init__``, create/update the news files and create/update the
6011.3.1 by Vincent Ladeuil
releasing notes refresh
450
milestone for the next relase).
451
452
You may also need to do `At the start of a series cycle`_ if you're starting
453
a new series.
454
6133.2.1 by Jonathan Riddell
add translations to release process
455
The final beta - branching and translations
456
-------------------------------------------
457
6011.3.1 by Vincent Ladeuil
releasing notes refresh
458
A word of caution: the instructions above works well for all releases but
459
there is one special case that requires a bit more care: when you release
460
the *last* beta for a given ``x.y`` series (from trunk aka lp:bzr), you need
461
to setup *two* branches for the next cycle:
462
6437.1.1 by Vincent Ladeuil
Open trunk as 2.6dev1
463
#. ``lp:bzr`` needs to be opened for the next *series* ``x.(y+1)``.
6011.3.1 by Vincent Ladeuil
releasing notes refresh
464
6011.3.4 by Vincent Ladeuil
More tweaks and typo fixes.
465
#. ``lp:bzr/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
466
   series. Since this is first real use of ``lp:bzr/x.y``, this is also the
467
   deadline for the PQM branch to be created.
6011.3.1 by Vincent Ladeuil
releasing notes refresh
468
469
Both are important as ``lp:bzr`` should remain open so any change can be
6011.3.4 by Vincent Ladeuil
More tweaks and typo fixes.
470
landed, ``lp:bzr/x.y`` on the other hand should be ready to receive bug
471
fixes.
6011.3.1 by Vincent Ladeuil
releasing notes refresh
472
473
``lp:bzr`` is generally more important as the bug fixes on ``lp:bzr/x.y``
474
won't be released sooner than a month from now whereas people may already
475
been waiting to land on ``lp:bzr``.
476
6011.3.8 by Vincent Ladeuil
Add a step-by-step for x.y.0 to minimize the window where trunk is "closed".
477
In a nutshell:
478
479
#. Open ``lp:bzr`` for ``x.(y+1)``
480
6437.1.1 by Vincent Ladeuil
Open trunk as 2.6dev1
481
#. Create or update the ``x.y`` PQM branch based on whatever revision you
482
   want to release. Since it takes time to create the PQM branch for the new
483
   series you should plan to get it created a few days before you need it
484
   and seed it with the revision from trunk you want to base your release of
485
   (ask a LOSA for pulling this revision from trunk and pushing it to the
486
   series branch (``lp:bzr/x.y``) when you're ready).
487
6011.3.8 by Vincent Ladeuil
Add a step-by-step for x.y.0 to minimize the window where trunk is "closed".
488
#. Release ``x.y.0`` from ``lp:bzr/x.y``
489
490
#. Open ``lp:bzr/x.y`` for bug fixes
491
6437.1.2 by Vincent Ladeuil
RM tweaks while freezing 2.5b5.
492
You also need to ensure Launchpad is set up to import/export translations
493
for the new branch and inform translators.
6133.2.1 by Jonathan Riddell
add translations to release process
494
6437.1.2 by Vincent Ladeuil
RM tweaks while freezing 2.5b5.
495
#. Push the last beta release to a new branch::
6133.2.1 by Jonathan Riddell
add translations to release process
496
497
     bzr push lp:~bzr-core/bzr/bzr-translations-export-x.y
498
499
#. On the translations series synchronization settings page
500
   <https://translations.launchpad.net/bzr/x.y/+translations-settings>
501
   turn on ``Import template files`` then for exports click ``Choose a
502
   target branch`` and point it at the branch you just pushed.
503
6437.4.1 by Vincent Ladeuil
Open 2.5.0 for bug fixes
504
#. E-mail translators to announce that the forthcoming stable release of bzr
505
   is ready for translations.  Send to
506
   ``launchpad-translators@lists.launchpad.net`` and
6133.2.2 by Jonathan Riddell
fix formatting on e-mails
507
   ``ubuntu-translators@lists.ubuntu.com``.
6133.2.1 by Jonathan Riddell
add translations to release process
508
509
#. The series is now frozen for strings and API, see below for adding
510
   that to the announcement.
511
4676.6.1 by mbp at sourcefrog
Updates to release process docs.
512
Announcing the source freeze
513
----------------------------
514
6234.4.1 by Vincent Ladeuil
Updated the instructions to prepare the translations template, freshmeat became freecode, freeze announces should be sent to bzr-packagers too.
515
#. Post to the ``bazaar@lists.canonical.com`` and
6615.2.1 by Vincent Ladeuil
Ensure http://pad.lv/1323805 won't come back.
516
   ``bzr-packagers@lists.launchpad.net`` lists, saying that the source has
6260.1.1 by Vincent Ladeuil
No more gold for source freezes, too many people have wrong expectations otherwise.
517
   been frozen. Be extra clear that this is only a *source* release targeted
518
   at packagers and installer builders (see
6060.8.4 by Vincent Ladeuil
Mentions Canonical as the lead sponsor and other tweaks.
519
   <https://bugs.launchpad.net/launchpad/+bug/645084>).  This is the cue for
520
   platform maintainers and plugin authors to update their code.  This is
521
   done before the general public announcement of the release.
6060.8.2 by Vincent Ladeuil
Clarify SRUs handling for the RM.
522
523
   The freeze announcement generally guess the date of the official public
524
   announcement, for the most recent stable series (the one supported by the
525
   installers and most of the distributions) it's generally a few days after
526
   the freeze. For older series supported only via SRUs for Ubuntu, we don't
527
   control the process as tightly so guessing the date is not appropriate.
528
6133.2.1 by Jonathan Riddell
add translations to release process
529
   For the final beta release include in your announcement a notice of
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
530
   API and translation freezes noting that public methods should not
6133.2.1 by Jonathan Riddell
add translations to release process
531
   be removed or changed and strings should not be added or changed.
532
6060.8.2 by Vincent Ladeuil
Clarify SRUs handling for the RM.
533
#. Pause for a few days. 
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
534
535
4676.6.1 by mbp at sourcefrog
Updates to release process docs.
536
Publishing the release
537
----------------------
538
539
There is normally a delay of a few days after the source freeze to allow
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
540
for binaries to be built for various platforms. Once they have been built,
4676.6.1 by mbp at sourcefrog
Updates to release process docs.
541
we have a releasable product.  The next step is to make it generally
6011.3.5 by Vincent Ladeuil
Some more tweaks.
542
available to the world.
4676.6.1 by mbp at sourcefrog
Updates to release process docs.
543
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
544
#. Go to the release web page at <https://launchpad.net/bzr/x.y/x.y.z>
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
545
6583.3.1 by Vincent Ladeuil
bzr web site hosting has moved from escudero to zhongshan. freecode.com now uses https.
546
#. Announce on the `Bazaar website <http://bazaar.canonical.com/>`_.  This
547
   page is edited in ``build.py`` in the lp:bzr-website branch. (Changes
4634.67.1 by Ian Clatworthy
update release documentation to mention the new website
548
   pushed to this branch are refreshed by a cron job on escudero.)
549
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
550
#. Check that the documentation for this release is available in
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
551
   <http://doc.bazaar.canonical.com>.  It should be automatically build when
552
   the branch is created, by a cron script ``update-bzr-docs`` on
553
   ``escudero``. When the first release is created in a new series, a branch
6615.6.1 by Vincent Ladeuil
Open 2.7.1 for bug fixes
554
   needs to be created on ``escudero``::
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
555
6615.6.1 by Vincent Ladeuil
Open 2.7.1 for bug fixes
556
     ssh escudero.canonical.com
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
557
     sudo -u bzr-web -s
558
     cd /srv/doc.bazaar.canonical.com/
6615.6.1 by Vincent Ladeuil
Open 2.7.1 for bug fixes
559
     bzr branch lp:bzr/2.7 bzr/bzr.2.7
6474.2.1 by Vincent Ladeuil
Update releasing instructions including more details about doc.bazaar.canonical.com when doing the first stable release in a new series.
560
6524.3.2 by Vincent Ladeuil
Mention the path for update-bzr-docs for easier retrieval.
561
   And the ``bzr/bin/update-bzr-docs`` script needs to refer to it.
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
562
6474.2.2 by Vincent Ladeuil
Also mention lp:bzr-alldocs that needs to be updated for news series.
563
   The ``lp:bzr-alldocs`` branch also needs to be updated when a new series
564
   is introduced, see the ``README`` file there for more instructions
565
   (looking at the branch history is also a good way to understand what
566
   needs to be done and to document any policy changes).
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
567
568
Announcing the release
569
----------------------
570
571
Now that the release is publicly available, tell people about it.
572
3778.2.1 by Martin Pool
Updated release process documentation.
573
#. Make an announcement mail.
574
6060.8.4 by Vincent Ladeuil
Mentions Canonical as the lead sponsor and other tweaks.
575
   For beta releases, this is sent to the ``bazaar@lists.canonical.com`` and
576
   ``bazaar-announce@lists.canonical.com`` lists.
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
577
6060.8.2 by Vincent Ladeuil
Clarify SRUs handling for the RM.
578
   For stable releases (excluding SRUs which are for older stable releases),
579
   it should also be cc'd to ``info-gnu@gnu.org``,
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
580
   ``python-announce-list@python.org``, ``bug-directory@gnu.org``.
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
581
582
   In all cases, it is good to set ``Reply-To: bazaar@lists.canonical.com``,
583
   so that people who reply to the announcement don't spam other lists.
3778.2.1 by Martin Pool
Updated release process documentation.
584
4439.1.2 by Martin Pool
Change release message template to a preformatted block so you can more easily copy and paste it into a mail.
585
   The announce mail will look something like this::
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
586
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
587
      Subject: bzr x.y.z released!
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
588
589
      The Bazaar team is happy to announce availability of a new
4439.1.2 by Martin Pool
Change release message template to a preformatted block so you can more easily copy and paste it into a mail.
590
      release of the bzr adaptive version control system.
6060.8.1 by Vincent Ladeuil
Mention bug #839461 and clarify the GNU reference.
591
6060.8.4 by Vincent Ladeuil
Mentions Canonical as the lead sponsor and other tweaks.
592
      Bazaar <http://bazaar.canonical.com/> is a Canonical project and part
593
      of the GNU project <http://gnu.org/> to produce a free operating
594
      system.
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
595
5447.2.1 by Vincent Ladeuil
Fix some typos and propose a release planning.
596
      <<Summary paragraph from news>>
597
4439.1.2 by Martin Pool
Change release message template to a preformatted block so you can more easily copy and paste it into a mail.
598
      Thanks to everyone who contributed patches, suggestions, and
599
      feedback.
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
600
601
      Bazaar is now available for download from
5574.1.1 by Vincent Ladeuil
Tweak freshmeat announcements rules
602
      https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
4439.1.2 by Martin Pool
Change release message template to a preformatted block so you can more easily copy and paste it into a mail.
603
      for various systems will be available soon.
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
604
5462.5.7 by Andrew Bennetts
Update 'Releasing Bazaar' doc.
605
      <<release notes from this release back to the last major release>>
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
606
4439.1.1 by Martin Pool
Release mails should mention bzr's a GNU project
607
   Feel free to tweak this to your taste.
608
3815.1.1 by Martin Pool
Add Launchpad announcement to the release process
609
#. Make an announcement through <https://launchpad.net/bzr/+announce>
6439.1.1 by Vincent Ladeuil
Mentioning the milestone URL in annoucements gives an easy access to the detailed description of the release
610
   mentioning the milestone URL <https://launchpad.net/bzr/+milestone/x.y.z>
611
   so people get an easy access to details.
3815.1.1 by Martin Pool
Add Launchpad announcement to the release process
612
6583.3.1 by Vincent Ladeuil
bzr web site hosting has moved from escudero to zhongshan. freecode.com now uses https.
613
#. Announce on https://freecode.com/projects/bazaar-vcs
4853.1.1 by Patrick Regan
Removed trailing whitespace from files in doc directory
614
6011.3.3 by Vincent Ladeuil
Some more tweaks and a news entry.
615
   This should be done for beta releases and stable releases. If you do not
6234.4.1 by Vincent Ladeuil
Updated the instructions to prepare the translations template, freshmeat became freecode, freeze announces should be sent to bzr-packagers too.
616
   have a Freecode account yet, ask one of the existing admins.
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
617
6060.8.2 by Vincent Ladeuil
Clarify SRUs handling for the RM.
618
   The purpose here is to point users to the latest stable release
619
   (i.e. SRUs are excluded) while still publishing announcements for beta
620
   releases.
5574.1.1 by Vincent Ladeuil
Tweak freshmeat announcements rules
621
622
   There are several kinds of modifications that could be done there via the
623
   ``Administration`` box in the lower right area of the page:
624
625
   * Edit the project: This is where most of the URLs proposed in the
626
     ``Links`` box are edited. This should rarely change except for the URLs
627
     related to the latest stable release.
628
6011.3.3 by Vincent Ladeuil
Some more tweaks and a news entry.
629
   * New announcement: When doing a release, put the summary of the release
630
     (you can't embed URLs there, the moderation staff remove them). Users
631
     can still access the releases notes via the ``Release Notes`` URL in
632
     the ``Links`` box in the upper right area of the page. When doing the
633
     first stable release in a series, delete the ``Unstable installers``
634
     <https://launchpad.net/bzr/x.y/x.ybn> and ``Unstable source tarball``
5712.1.1 by Vincent Ladeuil
Tweak release instructions.
635
     <http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
6011.3.3 by Vincent Ladeuil
Some more tweaks and a news entry.
636
     links. Conversely, when creating the first beta in a development
637
     series, create these links again. Check all links when doing other
638
     kinds of release.
5574.1.1 by Vincent Ladeuil
Tweak freshmeat announcements rules
639
4634.13.1 by Vincent Ladeuil
Feedback on the 2.0rc1 release.
640
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
6011.3.5 by Vincent Ladeuil
Some more tweaks.
641
   be done for the stable and beta releases.
3497.3.1 by Martin Pool
Add note to update GNU directory
642
6615.2.1 by Vincent Ladeuil
Ensure http://pad.lv/1323805 won't come back.
643
#. Update the python package index: <http://pypi.python.org/pypi/bzr>
644
645
   From the tarball created and tested earlier ::
646
647
     twine upload -s ../bzr-2.7.0.tar.gz
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
648
6011.3.7 by Vincent Ladeuil
More spelling fixes.
649
   Remember to check the results afterward -- this should be done for
6060.8.2 by Vincent Ladeuil
Clarify SRUs handling for the RM.
650
   stable releases but not for beta releases nor SRUs.
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
651
6615.6.1 by Vincent Ladeuil
Open 2.7.1 for bug fixes
652
   The ``twine`` command is provided by the ``twine`` package on Debian and
653
   Ubuntu.
654
6615.2.1 by Vincent Ladeuil
Ensure http://pad.lv/1323805 won't come back.
655
   If in doubt, you can test with <https://testpypi.python.org/pypi> where
656
   you can register yourself, register the bzr project and upload (and then
657
   remove the upload and delete the project so a new release manager can
658
   enjoy the same facilities). If the project already exists, have one of
659
   the existing owners of the project add you to the group.
660
661
   To use the pypi test site, you need to record your credentials for an
662
   existing user (the registration process is manual and starts at
663
   <https://testpypi.python.org/pypi?%3Aaction=register_form>.
664
665
   Once registered, you can record your crdentials in your ``~/pypirc`` file
666
   with ::
667
668
     [testpypi]
669
     username:<login on testpypi>
670
     password:<password on testpypi>
671
     repository = https://testpypi.python.org/pypi
672
673
   Registering the bzr project if doesn't exist is achieved with::
674
675
     python setup.py -r https://testpypi.python.org/pypi register
676
677
  Uploading is done with::
678
679
    twine upload -r testpypi -s ../bzr-2.7.0.tar.gz
680
681
   To be able to upload the release you must create an account on
682
   <http://pypi.python.org/pypi> and have one of the existing owners of the
683
   project add you to the group and update your ``[pypi]`` section in your
684
   ``~/pypirc`` file.
3408.1.3 by Martin Pool
More release process updates
685
3383.2.3 by Martin Pool
Separate out and update the release manager instructions
686
3383.2.5 by Martin Pool
merge trunk
687
Merging the released code back to trunk
688
---------------------------------------
689
6011.3.3 by Vincent Ladeuil
Some more tweaks and a news entry.
690
Merge the release branch back into the trunk.  The ``doc/en/release-notes``
691
changes should be merged into the right place because each release series
692
has its own release-notes file, but double-check.
5264.2.1 by Robert Collins
Improved our release checklist to have a bit less churn and leave things
693
5462.5.7 by Andrew Bennetts
Update 'Releasing Bazaar' doc.
694
If it's not already done, advance the version number in ``bzr`` and
695
``bzrlib/__init__.py``.  Submit this back into pqm for bzr.dev.
3383.2.5 by Martin Pool
merge trunk
696
4634.13.4 by Vincent Ladeuil
More tweaks.
697
As soon as you change the version number in trunk, make sure you have
698
created the corresponding milestone to ensure the continuity in bug
4634.13.5 by Vincent Ladeuil
Mention creating the news series when changing the major or minor part of
699
targeting or nominating. Depending on the change, you may even have to
700
create a new series (if your change the major or minor release number), in
6011.3.3 by Vincent Ladeuil
Some more tweaks and a news entry.
701
that case go to `At the start of a series cycle`_ and follow the
702
instructions from there.
4634.13.4 by Vincent Ladeuil
More tweaks.
703
4070.10.2 by Martin Pool
doc to maintain bzr/current branch
704
4634.13.4 by Vincent Ladeuil
More tweaks.
705
Releases until the final one
706
----------------------------
707
6011.3.1 by Vincent Ladeuil
releasing notes refresh
708
Congratulations - you have made your first release.  Have a beer or fruit
709
juice - it's on the house! If it was a beta, you're not finished
710
yet. Another beta or hopefully a stable release is still to come.
4634.13.6 by Vincent Ladeuil
Fixed as per Ian's review.
711
6011.3.1 by Vincent Ladeuil
releasing notes refresh
712
The process is the same as for the first release. Goto `Doing a particular
713
release`_ and follow the instructions again. Some details change between
714
beta and stable releases, but they should be documented. If the instructions
715
aren't clear enough, please fix them.
4634.13.4 by Vincent Ladeuil
More tweaks.
716
3383.2.5 by Martin Pool
merge trunk
717
5430.5.1 by Martin Pool
Developer docs about SRUs of stable releases
718
Getting the release into Ubuntu
719
-------------------------------
720
721
(Feel free to propose or add new sections here about what we should do to
722
get bzr into other places.)
723
724
For the currently-under-development release of Ubuntu, no special action
725
is needed: the release should be picked by Debian and synced from there into
726
Ubuntu.
727
728
Releases off stable bzr branches should go in to the ``-updates`` of the
729
Ubuntu release that originally contained that branch.  (Ubuntu Lucid had
730
bzr 2.2.0, so should get every 2.2.x update.)  This means going through
731
the `SRU (Stable Release Updates)
732
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.   
733
6011.3.12 by Vincent Ladeuil
Fix typo
734
Since September 2010, bzr has received approval by the technical
6011.3.9 by Vincent Ladeuil
Mention the SRU wiki page.
735
board for the `MicroReleaseExceptions
5430.5.1 by Martin Pool
Developer docs about SRUs of stable releases
736
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
6011.3.9 by Vincent Ladeuil
Mention the SRU wiki page.
737
category so that whole bugfix releases can more easily be
738
approved.
739
6011.3.11 by Vincent Ladeuil
Fix typo.
740
Progress on these realeases is tracked on the `SRU wiki
6011.3.9 by Vincent Ladeuil
Mention the SRU wiki page.
741
<http://wiki.bazaar.canonical.com/UbuntuStableReleaseUpdates>`_
742
page.
5430.5.1 by Martin Pool
Developer docs about SRUs of stable releases
743
744
**After making a bzr stable-release release, nominate the most serious bug
745
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
746
5430.4.5 by Vincent Ladeuil
Clarify SRU bug nomination.
747
This requires a couple of tricks (please reconsider and tweak as things
748
evolves from one release to the other):
749
750
 * create a distro task with the ``Also affects distribution`` button and
751
   select ``bzr (Ubuntu)``.
752
753
 * change the *URL* to point to ``ubuntu/+source/bzr`` instead of ``bzr``
754
   (this is needed if you create the distro task but not if it exists
755
   already). You should now be able to click the ``Nominate for release``
756
   button and select the right Ubuntu release. As of September 2010, this
757
   means:
758
6524.3.1 by Vincent Ladeuil
Minor RM tweaks
759
  * ``quantal`` for the 2.6 series,
760
  * ``precise`` for the 2.5 series,
6011.3.10 by Vincent Ladeuil
Mention oneiric.
761
  * ``oneiric`` for the 2.4 series,
6011.3.5 by Vincent Ladeuil
Some more tweaks.
762
  * ``natty`` for the 2.3 series,
5430.4.5 by Vincent Ladeuil
Clarify SRU bug nomination.
763
  * ``maverick`` for the 2.2 series,
764
  * ``lucid`` for the 2.1 series,
765
766
 * Subscribe the ``~ubuntu-sru`` team to the bug.
767
768
 * Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
769
   (we are targeting running the test suite during the build which, as of
770
   September 2010, fails for known reasons that are currently addressed).
771
   Search for bugs tagged with ``sru`` for examples and don't forget to tag
772
   the bug you selected.
773
5430.5.1 by Martin Pool
Developer docs about SRUs of stable releases
774
3549.3.1 by Martin Pool
Updated instructions in packaging into the PPA
775
See also
776
--------
777
4070.10.3 by Martin Pool
Small ReST syntax fix
778
* `Packaging into the bzr PPA <ppa.html>`_ to make and publish Ubuntu
779
  packages.
780
* `Bazaar Developer Document Catalog <index.html>`_
781
* `Development cycles <cycle.html>`_: things that happen during the cycle
782
  before the actual release.
3464.3.6 by Martin Pool
Release process updates
783
784
..
3464.3.8 by Martin Pool
Doc updates re PPAs
785
   vim: filetype=rst textwidth=74 ai shiftwidth=4