4
This document describes the processes for making and announcing a Breezy
5
release, and managing the release process. This is just one phase of the
6
`overall development cycle
7
<https://www.breezy-vcs.org/developers/cycle.html>`_, (go re-read this
8
document to ensure it hasn't been updated since you last read it) but it's
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
16
If you're helping the Release Manager (RM) for one reason or another, you
17
may notice that he didn't follow that document scrupulously. He may have
18
good reasons to do that but he may also have missed some parts.
26
#. Be a member of https://launchpad.net/~brz (or you won't be able to land
32
In this document, we're talking about source releases only, packages and
33
installers are built from this but we won't talk about them here.
35
Every release is part of a series, ``brz-3.0.0`` is part of series ``3.0``.
37
We do two different kind of releases: the betas releases and the stable
38
releases for a given series.
40
For a given series, releases will be done to deliver new versions of brz to
41
different kinds of users:
43
#. beta releases: named ``x.ybn`` where ``x.y`` is the series and ``n``
44
starts at 1 and is incremented. These releases are targeted to beta
45
testers who don't want to run from source but are interested in features
48
#. stable releases: name ``x.y.z`` where ``x.y.`` is the series and ``z``
49
starts at 0 and is incremented. These releases are targeted at people
50
that want bugfixes only and no new features.
53
Differences in the release process between beta and stable release will be
54
mentioned when needed.
59
As of September 2018, we maintain a single series: 3.0.
61
#. as much as possible releases should not disturb development, and
62
ongoing development should not disturb releases,
64
#. the most recent development series should release once a month during
65
the beta period (see `Development cycles <cycle.html>`_ for more
68
#. the most recent stable series should release every other month (based
69
on the amount of bug fixes, this can be shorter or longer depending on
72
#. previous series should release on a regular basis without interfering
73
with the most recent series with a decreasing order of priority (again
74
this should be based on bugs importance and user feedback),
76
#. the death of a series should be planned ahead of time. 6 months should
77
give enough time to our users to migrate to a more recent series. This
78
doesn't mean we will make a release at the end of the series, just that
79
before the end date we *could* possibly put out another release if
80
there was a sufficiently important fix. Beyond that date, we won't
81
even land changes on that branch (unless something causes a miraculous
84
#. there should not be more than 2 releases in the same week (but the
85
Release Manager is free to ignore this (get in touch with packagers
88
At the start of a series cycle
89
==============================
91
To start a new series cycle:
93
#. Create a new series ``x.y`` at <https://launchpad.net/brz/+addseries>.
95
#. Add milestones at <https://launchpad.net/brz/x.y/+addmilestone> to that
96
series for the beta releases and the stable series mentioning their
97
expected dates. Only the milestone associated to the next release in
98
this series should be left active to avoid clutter when targeting bugs.
100
#. If you made a new series, you will need to create a new branch for this
101
release series. This branch will be used only from the first non-beta
102
release onwards. It needs to be created by a https://launchpad.net/~brz
103
member (ask the core devs for instructions or to do it for you).
105
#. Start a new release-notes file::
107
cd doc/en/release-notes
108
cp series-template.txt brz-x.y.txt # e.g. brz-3.1.txt
111
#. Start a new whats-new file::
114
cp template.txt brz-x.y.txt # e.g. brz-3.1.txt
117
#. Update ``doc/en/index.txt`` to point to the new whats-new file.
119
At the start of a release cycle
120
===============================
122
To start a new release cycle:
124
#. Send mail to the list with the key dates, who will be the release
125
manager, and the main themes or targeted bugs. Ask people to nominate
126
objectives, or point out any high-risk things that are best done early,
127
or that interact with other changes. This is called the metronome mail
128
and is described in `Development cycles <cycle.html>`_.
130
#. Make a local branch to prepare the release::
132
brz branch lp:brz/x.y x.y-dev
134
If you're doing your first beta release, branch from trunk::
136
brz branch lp:brz x.y-dev
138
Note that you will generally reuse the same branch for all releases in a
141
#. Add a landing job for the release branch at https://ci.breezy-vcs.org/
143
#. Update the version number in the ``brz`` script, and the
144
``breezy/__init__.py`` file::
146
version_info = (x, y, z, 'dev', 0)
148
#. Add a new section at the top of the current release notes (in
149
``doc/en/release-notes``) about the new release, including its version
150
number and the headings from ``release-template.txt``.
152
#. Update the "What's New" documents in ``doc/en/whats-new``.
154
#. Make sure a milestone exists for your release and that it is active,
155
<https://launchpad.net/brz/x.y> lists the existing milestones,
156
<https://launchpad.net/brz/x.y/x.y.z/+edit> allows you to toggle the
159
#. Commit this and make a proposal against the release branch. Self approve
160
it (you're the release manager).
163
Doing a particular release
164
==========================
169
3.0.0 will start to be released as alpha as integrating plugins and porting
170
to python3 (while maintaining python2 compatiblity) desserve to be testing
171
in the wild by people understanding the risks.
173
That being said, the whole test suite has been preserved and enriched in the
176
Alpha releases will happen as source only (tarballs) and the process is
179
Note that the intent is to come back to beta releases as soon as possible so
180
the alpha releases won't happen again.
182
The process for releasing an alpha release is therefore:
183
- upload a tarball to launchpad,
184
- upload a tarball to pypi,
185
- mail bazaar@lists.ubuntu.com,
186
- post an announcement on the home page.
188
Uploading tarballs are described below, just use alpha versions (3, 0, 0,
189
'alpha', 1) in ``./breezy/__init__.py``
191
Update the source code
192
----------------------
194
#. Check that there is a milestone for the release you're doing. If there
195
is no milestone it indicates a process problem - make the milestone but
196
also mail the list to raise this issue in our process. Milestones are
197
found at <https://launchpad.net/brz/+milestone/x.y.z>.
199
#. Merge into your branch all previous stable series fixes that haven't been
200
merged yet. For example, if you're releasing 3.2.x, make sure the fixes
201
on 3.1, 3.0 have already been merged up::
205
and commit that merge in its own commit. This should happen only if the
206
devs landing changes in previous releases forgot to merge them up. Since
207
this can slow down the freeze, feel free to gently remind them about
208
their duties ;) If you feel unsafe resolving the conflicts or it's too
209
time consuming, contact the related devs and skip this merge.
211
Alternatively, think about automating these merges.
213
#. In the release branch, update ``version_info`` in ``./breezy/__init__.py``.
214
Make sure the corresponding milestone exists.
215
Double check that ./brz ``_script_version`` matches ``version_info``. Check
216
the output of ``./brz --version``.
218
For beta releases use::
220
version_info = (3, 0, 0, 'beta', SERIAL)
224
version_info = (3, 0, 0, 'beta', 1)
226
For stable releases use::
228
version_info = (3, 0, 0, 'final', 0)
230
#. Update the ``./doc/en/release-notes/`` section for this release.
232
Check that all news entries related to this release have been added in
233
the right section. For example, if you're releasing 3.0b3, the following
234
command should display a a single chuk diff for the 3.0b3 release::
236
brz diff -rbrz-3.0b2.. doc/en/release-notes/brz-3.0.txt
238
Fill out the date and a description of the release under the existing
239
header (the diff above will help you summarizing). If there isn't one,
240
follow the instructions above for using the ``release-template.txt`` file
241
and remind people that they should document their changes there ;)
243
See *3.0b1* or similar for an example of what this looks like.
245
#. Add or check the summary of the release into the "What's New" document.
247
If this is the first release in a new series make sure to update the
248
introduction mentioning:
250
* the date of this first release,
251
* until when the series is expected to be supported.
253
Looking at ``brz annotate`` for previous series should give you the right
254
hints. The ``doc/en/_templates/index.html`` file should also be updated.
256
#. To check that all bugs mentioned in the release notes are actually
257
marked as closed in Launchpad, you can run
258
``tools/check-newsbugs.py``::
260
./tools/check-newsbugs.py doc/en/release-notes/brz-x.y.txt
262
As of 2011-07-18, all bugs mentioned in the output of the script requires
263
some sort of intervention (either changing the status if it's not 'Fix
264
Released' or setting a different milestone if the bug hasn't been
265
fixed). A few false positives may remain in the older series, don't let
266
this slow you down too much. This script accepts options you may find
267
useful, use ``./tools/check-newsbugs.py`` to display its usage (``-w``
268
will open each bug in your browser for example).
270
#. For beta releases update the translation template::
272
BRZ_PLUGIN_PATH=-site make po/brz.pot
274
This is especially important for the final beta release which is when
275
translations are frozen and translators are requested (see `The final
276
beta - branching and translations`_) to make the translations.
278
#. For stable releases update the translations::
280
brz merge lp:~brz-core/brz/brz-translations-export-x.y
282
#. Commit these changes to the release branch, using a command like::
284
brz commit -m "Release 3.0.0"
286
The diff before you commit will be something like::
288
=== modified file 'breezy/__init__.py'
289
--- breezy/__init__.py 2011-02-09 06:35:00 +0000
290
+++ breezy/__init__.py 2011-03-10 10:24:47 +0000
292
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
293
# releaselevel of 'dev' for unreleased under-development code.
295
-version_info = (2, 3, 1, 'dev', 0)
296
+version_info = (2, 3, 1, 'final', 0)
298
# API compatibility version
299
api_minimum_version = (2, 3, 0)
301
=== modified file 'doc/en/release-notes/brz-2.3.txt'
302
--- doc/en/release-notes/brz-2.3.txt 2011-03-09 08:30:16 +0000
303
+++ doc/en/release-notes/brz-2.3.txt 2011-03-10 10:40:47 +0000
308
-:2.3.1: NOT RELEASED YET
310
-External Compatibility Breaks
311
-*****************************
313
-.. These may require users to change the way they use Breezy.
318
-.. New commands, options, etc that users may wish to try out.
323
-.. Improvements to existing commands, especially improved performance
324
- or memory usage, or better results.
327
+This is a bugfix release. Upgrading is recommended for all users of earlier
333
=== modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
334
--- doc/en/whats-new/whats-new-in-2.3.txt 2011-02-03 16:29:18 +0000
335
+++ doc/en/whats-new/whats-new-in-2.3.txt 2011-03-10 11:10:36 +0000
337
improvements made to the core product, it highlights enhancements within the
338
broader Breezy world of potential interest to those upgrading.
340
-Breezy 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
341
-and 2.2, and can read and write repositories generated by all previous
342
+Breezy 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
343
+versions that weren't included in 2.3.0 and fixes some bugs on its own.
345
+See the :doc:`../release-notes/index` for details.
347
+Breezy 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
348
+and 2.2. It can read and write repositories generated by all previous
354
#. Tag the new release::
358
#. Push those changes to a brz branch and make a merge proposal::
362
Use a commit message formatted like::
366
Note that ``brz push`` should mention updating one tag (which you just
367
created). If it doesn't, double-check that you created (and pushed) this
370
#. Once the merge proposal has landed, pull down the master release branch.
373
Making the source tarball
374
-------------------------
376
#. Change into the source directory and run ::
380
#. Now we'll try expanding this tarball and running the test suite
381
to check for packaging problems::
383
make check-dist-tarball | subunit2pyunit
385
You may encounter failures while running the test suite caused by your
386
locally installed plugins. Use your own judgment to decide if you can
387
release with these failures. When in doubt, disable the faulty plugins
388
one by one until you get no more failures. Alternatively, you can use
389
``BRZ_DISABLE_PLUGINS`` or ``BRZ_PLUGIN_PATH=-site`` to disable one or
392
Remember that this branch has already been tested on
393
https://ci.breezy-vcs.org, this step is particularly testing that the
394
cython extensions, which are updated by your local cython version when
395
you run make dist, are in good shape.
398
Publishing the source tarball
399
-----------------------------
401
#. Go to the relevant <https://launchpad.net/brz/x.y> series page in Launchpad.
403
#. Create a release of the milestone, and upload the source tarball and
404
the GPG signature. Or, if you prefer, use the
405
``tools/packaging/lp-upload-release`` script to do this. Note that
406
this changes what the download widget on the Launchpad brz home
407
page shows, so don't stop the release process yet, or platform binary
408
installers won't be made and the download list will stay very small!
409
<https://bugs.launchpad.net/launchpad/+bug/586445>
412
Kick off the next cycle
413
-----------------------
415
From that point, there is no possible return, the tarball has been uploaded
416
so you can relax a bit.
418
You're still holding a "social" lock on the launchpad branch though. Until
419
your start the next cycle, nobody should land anything on this branch. If
420
they do, they either targeted the wrong branch or didn't update the news
421
file correctly, so the sooner the branch is opened again, the better.
423
This matters more for ``lp:brz`` than for ``lp:brz/x.y``, ``lp:brz`` should
424
always be open for landing, so you should do `At the start of a release
425
cycle`_ as soon as possible (i.e. update the version number in ``brz`` and
426
``breezy/__init__``, create/update the news files and create/update the
427
milestone for the next relase).
429
You may also need to do `At the start of a series cycle`_ if you're starting
432
The final beta - branching and translations
433
-------------------------------------------
435
A word of caution: the instructions above works well for all releases but
436
there is one special case that requires a bit more care: when you release
437
the *last* beta for a given ``x.y`` series (from trunk aka lp:brz), you need
438
to setup *two* branches for the next cycle:
440
#. ``lp:brz`` needs to be opened for the next *series* ``x.(y+1)``.
442
#. ``lp:brz/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
443
series. Since this is first real use of ``lp:brz/x.y``, this is also the
444
deadline for the https://ci.breezy-vcs.org/ landing job to be created.
446
Both are important as ``lp:brz`` should remain open so any change can be
447
landed, ``lp:brz/x.y`` on the other hand should be ready to receive bug
450
``lp:brz`` is generally more important as the bug fixes on ``lp:brz/x.y``
451
won't be released sooner than a month from now whereas people may already
452
been waiting to land on ``lp:brz``.
456
#. Open ``lp:brz`` for ``x.(y+1)``
458
#. Create https://ci.breezy-vcs.org/ landing job and/or update the
459
``lp:brz/x.y`` branch based on whatever revision you want to release.
461
#. Release ``x.y.0`` from ``lp:brz/x.y``
463
#. Open ``lp:brz/x.y`` for bug fixes
465
You also need to ensure Launchpad is set up to import/export translations
466
for the new branch and inform translators.
468
#. Push the last beta release to a new branch::
470
brz push lp:~brz-core/brz/brz-translations-export-x.y
472
#. On the translations series synchronization settings page
473
<https://translations.launchpad.net/brz/x.y/+translations-settings>
474
turn on ``Import template files`` then for exports click ``Choose a
475
target branch`` and point it at the branch you just pushed.
477
#. E-mail translators to announce that the forthcoming stable release of brz
478
is ready for translations. Send to
479
``launchpad-translators@lists.launchpad.net`` and
480
``ubuntu-translators@lists.ubuntu.com``.
482
#. The series is now frozen for strings and API, see below for adding
483
that to the announcement.
485
Announcing the source freeze
486
----------------------------
488
#. Post to the ``bazaar@lists.ubuntu.com`` list and
489
``breezy-vcs@googlegroups.com`` , saying that the source has been
490
frozen. Be extra clear that this is only a *source* release targeted at
491
packagers and installer builders (see
492
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue for
493
platform maintainers and plugin authors to update their code. This is
494
done before the general public announcement of the release.
496
The freeze announcement generally guess the date of the official public
497
announcement, for the most recent stable series (the one supported by the
498
installers and most of the distributions) it's generally a few days after
499
the freeze. For older series supported only via SRUs for Ubuntu, we don't
500
control the process as tightly so guessing the date is not appropriate.
502
For the final beta release include in your announcement a notice of
503
API and translation freezes noting that public methods should not
504
be removed or changed and strings should not be added or changed.
506
#. Pause for a few days.
509
Publishing the release
510
----------------------
512
There is normally a delay of a few days after the source freeze to allow
513
for binaries to be built for various platforms. Once they have been built,
514
we have a releasable product. The next step is to make it generally
515
available to the world.
517
#. Go to the release web page at <https://launchpad.net/brz/x.y/x.y.z>
519
#. Announce on the Breezy website.
521
#. Check that the documentation for this release is available in
522
<https://www.breezy-vcs.org/doc/en/>. It should be automatically build when
523
the branch is created, by a cron script ``update-brz-docs`` on
524
``escudero``. When the first release is created in a new series, a branch
525
needs to be created on ``escudero``::
527
ssh escudero.canonical.com
529
cd /srv/doc.bazaar.canonical.com/
530
brz branch lp:brz/2.7 brz/brz.2.7
532
And the ``brz/bin/update-brz-docs`` script needs to refer to it.
534
The ``lp:brz-alldocs`` branch also needs to be updated when a new series
535
is introduced, see the ``README`` file there for more instructions
536
(looking at the branch history is also a good way to understand what
537
needs to be done and to document any policy changes).
539
Announcing the release
540
----------------------
542
Now that the release is publicly available, tell people about it.
544
#. Make an announcement mail.
546
For beta releases, this is sent to the ``bazaar@lists.ubuntu.com`` and
547
``bazaar-announce@lists.ubuntu.com`` lists.
549
For stable releases (excluding SRUs which are for older stable releases),
550
it should also be cc'd to ``info-gnu@gnu.org``,
551
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
553
In all cases, it is good to set ``Reply-To: bazaar@lists.ubuntu.com``,
554
so that people who reply to the announcement don't spam other lists.
556
The announce mail will look something like this::
558
Subject: brz x.y.z released!
560
The Breezy team is happy to announce availability of a new
561
release of the brz adaptive version control system.
563
Breezy is a fork of the Bazaar version control system.
565
<<Summary paragraph from news>>
567
Thanks to everyone who contributed patches, suggestions, and
570
Breezy is now available for download from
571
https://launchpad.net/brz/x.y/x.y.z/ as a source tarball; packages
572
for various systems will be available soon.
574
<<release notes from this release back to the last major release>>
576
Feel free to tweak this to your taste.
578
#. Make an announcement through <https://launchpad.net/brz/+announce>
579
mentioning the milestone URL <https://launchpad.net/brz/+milestone/x.y.z>
580
so people get an easy access to details.
582
#. Update `<http://en.wikipedia.org/wiki/Breezy_(software)>`_ -- this should
583
be done for the stable and beta releases.
585
#. Update the python package index: <http://pypi.python.org/pypi/breezy>
587
From the tarball created and tested earlier ::
589
twine upload ../breezy-3.0.0.tar.gz ../breezy-3.0.0.tar.gz.asc
591
Remember to check the results afterward -- this should be done for
592
stable releases but not for beta releases nor SRUs.
594
The ``twine`` command is provided by the ``twine`` package on Debian and
595
Ubuntu. Beware that you need at least ``twine-1.10``.
597
If in doubt, you can test with <https://testpypi.python.org/pypi> where
598
you can register yourself, register the brz project and upload (and then
599
remove the upload and delete the project so a new release manager can
600
enjoy the same facilities). If the project already exists, have one of
601
the existing owners of the project add you to the group.
603
To use the pypi test site, you need to record your credentials for an
604
existing user (the registration process is manual and starts at
605
<https://testpypi.python.org/pypi?%3Aaction=register_form>.
607
Once registered, you can record your crdentials in your ``~/pypirc`` file
611
username:<login on testpypi>
612
password:<password on testpypi>
613
repository = https://testpypi.python.org/pypi
615
Registering the breezy project if doesn't exist is achieved with::
617
python setup.py -r https://testpypi.python.org/pypi register
619
Uploading is done with::
621
twine upload -r testpypi ../breezy-3.0.0.tar.gz ../breezy-3.0.0.tar.gz.asc
623
To be able to upload the release you must create an account on
624
<http://pypi.python.org/pypi> and have one of the existing owners of the
625
project add you to the group and update your ``[pypi]`` section in your
629
Merging the released code back to trunk
630
---------------------------------------
632
Merge the release branch back into the trunk. The ``doc/en/release-notes``
633
changes should be merged into the right place because each release series
634
has its own release-notes file, but double-check.
636
If it's not already done, advance the version number in ``brz`` and
637
``breezy/__init__.py``. File a merge proposal against ``lp:brz``.
639
As soon as you change the version number in trunk, make sure you have
640
created the corresponding milestone to ensure the continuity in bug
641
targeting or nominating. Depending on the change, you may even have to
642
create a new series (if your change the major or minor release number), in
643
that case go to `At the start of a series cycle`_ and follow the
644
instructions from there.
647
Releases until the final one
648
----------------------------
650
Congratulations - you have made your first release. Have a beer or fruit
651
juice - it's on the house! If it was a beta, you're not finished
652
yet. Another beta or hopefully a stable release is still to come.
654
The process is the same as for the first release. Goto `Doing a particular
655
release`_ and follow the instructions again. Some details change between
656
beta and stable releases, but they should be documented. If the instructions
657
aren't clear enough, please fix them.
660
Getting the release into Ubuntu
661
-------------------------------
663
/!\ Nothing in this section has been validated for breezy yet.
665
(Feel free to propose or add new sections here about what we should do to
666
get brz into other places.)
668
For the currently-under-development release of Ubuntu, no special action
669
is needed: the release should be picked by Debian and synced from there into
672
Releases off stable brz branches should go in to the ``-updates`` of the
673
Ubuntu release that originally contained that branch. (Ubuntu Lucid had
674
brz 2.2.0, so should get every 2.2.x update.) This means going through
675
the `SRU (Stable Release Updates)
676
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.
678
Since September 2010, brz has received approval by the technical
679
board for the `MicroReleaseExceptions
680
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
681
category so that whole bugfix releases can more easily be
684
Progress on these realeases is tracked on the `SRU wiki
685
<http://wiki.bazaar.canonical.com/UbuntuStableReleaseUpdates>`_
688
**After making a brz stable-release release, nominate the most serious bug
689
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
691
This requires a couple of tricks (please reconsider and tweak as things
692
evolves from one release to the other):
694
* create a distro task with the ``Also affects distribution`` button and
695
select ``brz (Ubuntu)``.
697
* change the *URL* to point to ``ubuntu/+source/brz`` instead of ``brz``
698
(this is needed if you create the distro task but not if it exists
699
already). You should now be able to click the ``Nominate for release``
700
button and select the right Ubuntu release. As of September 2010, this
703
* ``quantal`` for the 2.6 series,
704
* ``precise`` for the 2.5 series,
705
* ``oneiric`` for the 2.4 series,
706
* ``natty`` for the 2.3 series,
707
* ``maverick`` for the 2.2 series,
708
* ``lucid`` for the 2.1 series,
710
* Subscribe the ``~ubuntu-sru`` team to the bug.
712
* Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
713
(we are targeting running the test suite during the build which, as of
714
September 2010, fails for known reasons that are currently addressed).
715
Search for bugs tagged with ``sru`` for examples and don't forget to tag
716
the bug you selected.
722
* `Packaging into the brz PPA <ppa.html>`_ to make and publish Ubuntu
724
* `Breezy Developer Document Catalog <index.html>`_
725
* `Development cycles <cycle.html>`_: things that happen during the cycle
726
before the actual release.
729
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
