~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/releasing.txt

  • Committer: Martin
  • Date: 2011-04-15 21:22:57 UTC
  • mto: This revision was merged to the branch mainline in revision 5797.
  • Revision ID: gzlist@googlemail.com-20110415212257-jgtovwwp4be7egd9
Add release notes

Show diffs side-by-side

added added

removed removed

Lines of Context:
93
93
   the release branch.
94
94
 
95
95
#. If you made a new series, add milestones at
96
 
   <https://edge.launchpad.net/bzr/x.y/+addmilestone> to that series for
 
96
   <https://launchpad.net/bzr/x.y/+addmilestone> to that series for
97
97
   the beta release, release candidate and the final release, and their
98
98
   expected dates.
99
99
 
100
 
#. Create a new milestone <https://edge.launchpad.net/bzr/x.y/+addmilestone>
 
100
#. Create a new milestone <https://launchpad.net/bzr/x.y/+addmilestone>
101
101
   and add information about this release.  We will not use it yet, but it
102
102
   will be available for targeting or nominating bugs.
103
103
 
195
195
 
196
196
     ./tools/check-newsbugs.py doc/en/release-notes/bzr-x.y.txt
197
197
 
198
 
   (But note there will be many false positives, and this script may be
199
 
   flaky <https://bugs.edge.launchpad.net/bzr/+bug/354985>.  Don't let
200
 
   this slow you down too much.)
 
198
   (As of 2011-03-10, only a few false positives remain. Don't let this slow
 
199
   you down too much.)
201
200
 
202
201
#. Commit these changes to the release branch, using a command like::
203
202
 
204
 
     bzr commit -m "Release 1.14."
 
203
     bzr commit -m "Release 2.3.1"
205
204
 
206
205
   The diff before you commit will be something like::
207
206
 
208
 
     === modified file 'NEWS'
209
 
     --- NEWS        2008-09-17 23:09:18 +0000
210
 
     +++ NEWS        2008-09-23 16:14:54 +0000
211
 
     @@ -4,6 +4,23 @@
212
 
 
213
 
      .. contents::
214
 
 
215
 
     +bzr 1.7 2008-09-23
216
 
     +------------------
217
 
     +
218
 
     +This release includes many bug fixes and a few performance and feature
219
 
     +improvements.  ``bzr rm`` will now scan for missing files and remove them,
220
 
     +like how ``bzr add`` scans for unknown files and adds them. A bit more
221
 
     +polish has been applied to the stacking code. The b-tree indexing code has
222
 
     +been brought in, with an eye on using it in a future repository format.
223
 
     +There are only minor installer changes since bzr-1.7rc2.
224
 
     +
225
 
      bzr 1.7rc2 2008-09-17
226
 
      ---------------------
227
 
 
228
 
 
229
 
     === modified file 'bzrlib/__init__.py'
230
 
     --- bzrlib/__init__.py  2008-09-16 21:39:28 +0000
231
 
     +++ bzrlib/__init__.py  2008-09-23 16:14:54 +0000
232
 
     @@ -41,7 +41,7 @@
233
 
      # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
234
 
      # releaselevel of 'dev' for unreleased under-development code.
235
 
 
236
 
     -version_info = (1, 7, 0, 'candidate', 2)
237
 
     +version_info = (1, 7, 0, 'final', 0)
238
 
 
239
 
 
240
 
      # API compatibility version: bzrlib is currently API compatible with 1.7.
241
 
 
242
 
   Note that the NEWS file formatting has evolved, this example needs to
243
 
   be updated.
 
207
      === modified file 'bzrlib/__init__.py'
 
208
      --- bzrlib/__init__.py    2011-02-09 06:35:00 +0000
 
209
      +++ bzrlib/__init__.py    2011-03-10 10:24:47 +0000
 
210
      @@ -52,7 +52,7 @@
 
211
       # Python version 2.0 is (2, 0, 0, 'final', 0)."  Additionally we use a
 
212
       # releaselevel of 'dev' for unreleased under-development code.
 
213
       
 
214
      -version_info = (2, 3, 1, 'dev', 0)
 
215
      +version_info = (2, 3, 1, 'final', 0)
 
216
       
 
217
       # API compatibility version
 
218
       api_minimum_version = (2, 3, 0)
 
219
      
 
220
      === modified file 'doc/en/release-notes/bzr-2.3.txt'
 
221
      --- doc/en/release-notes/bzr-2.3.txt      2011-03-09 08:30:16 +0000
 
222
      +++ doc/en/release-notes/bzr-2.3.txt      2011-03-10 10:40:47 +0000
 
223
      @@ -8,23 +8,10 @@
 
224
       bzr 2.3.1
 
225
       #########
 
226
       
 
227
      -:2.3.1: NOT RELEASED YET
 
228
      -
 
229
      -External Compatibility Breaks
 
230
      -*****************************
 
231
      -
 
232
      -.. These may require users to change the way they use Bazaar.
 
233
      -
 
234
      -New Features
 
235
      -************
 
236
      -
 
237
      -.. New commands, options, etc that users may wish to try out.
 
238
      -
 
239
      -Improvements
 
240
      -************
 
241
      -
 
242
      -.. Improvements to existing commands, especially improved performance 
 
243
      -   or memory usage, or better results.
 
244
      +:2.3.1: 2011-03-10
 
245
      +
 
246
      +This is a bugfix release. Upgrading is recommended for all users of earlier
 
247
      +2.3 releases.
 
248
       
 
249
       Bug Fixes
 
250
       *********
 
251
      
 
252
      === modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
 
253
      --- doc/en/whats-new/whats-new-in-2.3.txt 2011-02-03 16:29:18 +0000
 
254
      +++ doc/en/whats-new/whats-new-in-2.3.txt 2011-03-10 11:10:36 +0000
 
255
      @@ -17,8 +17,13 @@
 
256
       improvements made to the core product, it highlights enhancements within the
 
257
       broader Bazaar world of potential interest to those upgrading.
 
258
       
 
259
      -Bazaar 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
 
260
      -and 2.2, and can read and write repositories generated by all previous
 
261
      +Bazaar 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
 
262
      +versions that weren't included in 2.3.0 and fixes some bugs on its own.
 
263
      +
 
264
      +See the :doc:`../release-notes/index` for details.
 
265
      +
 
266
      +Bazaar 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
 
267
      +and 2.2. It can read and write repositories generated by all previous
 
268
       versions.
 
269
       
 
270
       Changed Behaviour
 
271
      
244
272
 
245
273
#. Tag the new release::
246
274
 
247
 
     bzr tag bzr-1.14
 
275
     bzr tag bzr-2.3.1
248
276
 
249
277
#. Push those changes to a bzr repository that is public and accessible on
250
278
   the Internet. PQM will pull from this repository when it attempts to merge
252
280
   appropriate release branch::
253
281
 
254
282
     bzr push
255
 
     bzr pqm-submit -m "(mbp) prepare 1.14"
 
283
     bzr pqm-submit -m "(vila) Release 2.3.1 (Vincent Ladeuil)"
256
284
 
257
285
   Or with hydrazine::
258
286
 
272
300
#. Now we'll try expanding this tarball and running the test suite
273
301
   to check for packaging problems::
274
302
 
275
 
     make check-dist-tarball
 
303
     make check-dist-tarball | subunit2pyunit
276
304
 
277
 
   You may encounter failures while running the test suite caused
278
 
   by your locally installed plugins. Use your own judgment to
279
 
   decide if you can release with these failures. When in doubt,
280
 
   disable the faulty plugins one by one until you get no more
281
 
   failures.
 
305
   You may encounter failures while running the test suite caused by your
 
306
   locally installed plugins. Use your own judgment to decide if you can
 
307
   release with these failures. When in doubt, disable the faulty plugins
 
308
   one by one until you get no more failures. Alternatively, you can use
 
309
   ``BZR_DISABLE_PLUGINS`` or ``BZR_PLUGIN_PATH=-site`` to disable one or
 
310
   all plugins.
282
311
 
283
312
   Remember that PQM has just tested everything too, this step is
284
313
   particularly testing that the pyrex extensions, which are updated
337
366
#. Check that the documentation for this release is available in
338
367
   <http://doc.bazaar.canonical.com>.  It should be automatically build when the
339
368
   branch is created, by a cron script ``update-bzr-docs`` on
340
 
   ``escudero``. As of today (2009-08-27) ``igc`` manually updates the
341
 
   pretty version of it.
 
369
   ``escudero``.
342
370
 
343
371
 
344
372
Announcing the release
374
402
      feedback.
375
403
 
376
404
      Bazaar is now available for download from
377
 
      https://launchpad.net/bzr/2.x/2.x/ as a source tarball; packages
 
405
      https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
378
406
      for various systems will be available soon.
379
407
 
380
408
      <<release notes from this release back to the last major release>>
392
420
   releases. If you do not have a Freshmeat account yet, ask one of the
393
421
   existing admins.
394
422
 
 
423
   The purpose here is to point users to the latest stable release while still
 
424
   publishing announcements for development releases.
 
425
 
 
426
   There are several kinds of modifications that could be done there via the
 
427
   ``Administration`` box in the lower right area of the page:
 
428
 
 
429
   * Edit the project: This is where most of the URLs proposed in the
 
430
     ``Links`` box are edited. This should rarely change except for the URLs
 
431
     related to the latest stable release.
 
432
 
 
433
   * New announcement: When doing a release (beta, candidates, final), put the
 
434
     summary of the release (you can't embed URLs there, the moderation staff
 
435
     remove them). Users can still access the releases notes via the ``Release
 
436
     Notes`` URL in the ``Links`` box in the upper right area of the
 
437
     page. When doing the first stable release in a series, delete the
 
438
     ``Unstable installers`` <https://launchpad.net/bzr/x.y/x.ybn> and
 
439
     ``Unstable source tarball``
 
440
     <http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz>
 
441
     links. Conversely, when creating the first beta in a development series,
 
442
     create these links again. Check all links when doing other kinds of
 
443
     release.
 
444
 
 
445
   * Set direct download: When releasing a new stable release, this should
 
446
     point to the corresponding launchpad page:
 
447
     <https://launchpad.net/bzr/x.y/x.y.z/>
 
448
 
395
449
#. Update `<http://en.wikipedia.org/wiki/Bazaar_(software)>`_ -- this should
396
450
   be done for final releases but not for beta releases or Release Candidates.
397
451