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 May 2020, we maintain a two series: 3.1 and trunk (3.2).
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
brz cp series-template.txt brz-x.y.txt # e.g. brz-3.1.txt
110
#. Start a new whats-new file::
113
brz cp template.txt brz-x.y.txt # e.g. brz-3.1.txt
115
#. Update ``doc/en/index.txt`` to point to the new whats-new file.
117
At the start of a release cycle
118
===============================
120
To start a new release cycle:
122
#. Send mail to the list with the key dates, who will be the release
123
manager, and the main themes or targeted bugs. Ask people to nominate
124
objectives, or point out any high-risk things that are best done early,
125
or that interact with other changes. This is called the metronome mail
126
and is described in `Development cycles <cycle.html>`_.
128
#. Make a local branch to prepare the release::
130
brz branch lp:brz/x.y x.y-dev
132
If you're doing your first beta release, branch from trunk::
134
brz branch lp:brz x.y-dev
136
Note that you will generally reuse the same branch for all releases in a
139
#. Add a landing job for the release branch at https://ci.breezy-vcs.org/
141
#. Update the version number in the ``brz`` script, and the
142
``breezy/__init__.py`` file::
144
version_info = (x, y, z, 'dev', 0)
146
#. Add a new section at the top of the current release notes (in
147
``doc/en/release-notes``) about the new release, including its version
148
number and the headings from ``release-template.txt``.
150
#. Update the "What's New" documents in ``doc/en/whats-new``.
152
#. Make sure a milestone exists for your release and that it is active,
153
<https://launchpad.net/brz/x.y> lists the existing milestones,
154
<https://launchpad.net/brz/x.y/x.y.z/+edit> allows you to toggle the
157
#. Commit this and make a proposal against the release branch. Self approve
158
it (you're the release manager).
161
Doing a particular release
162
==========================
167
3.0.0 will start to be released as alpha as integrating plugins and porting
168
to python3 (while maintaining python2 compatiblity) desserve to be testing
169
in the wild by people understanding the risks.
171
That being said, the whole test suite has been preserved and enriched in the
174
Alpha releases will happen as source only (tarballs) and the process is
177
Note that the intent is to come back to beta releases as soon as possible so
178
the alpha releases won't happen again.
180
The process for releasing an alpha release is therefore:
181
- upload a tarball to launchpad,
182
- upload a tarball to pypi,
183
- mail bazaar@lists.ubuntu.com,breezy-vcs@googlegroups.com
184
- post an announcement on the home page.
186
Uploading tarballs are described below, just use alpha versions (3, 0, 0,
187
'alpha', 1) in ``./breezy/__init__.py``
189
Update the source code
190
----------------------
192
#. Check that there is a milestone for the release you're doing. If there
193
is no milestone it indicates a process problem - make the milestone but
194
also mail the list to raise this issue in our process. Milestones are
195
found at <https://launchpad.net/brz/+milestone/x.y.z>.
197
#. Merge into your branch all previous stable series fixes that haven't been
198
merged yet. For example, if you're releasing 3.2.x, make sure the fixes
199
on 3.1, 3.0 have already been merged up::
203
and commit that merge in its own commit. This should happen only if the
204
devs landing changes in previous releases forgot to merge them up. Since
205
this can slow down the freeze, feel free to gently remind them about
206
their duties ;) If you feel unsafe resolving the conflicts or it's too
207
time consuming, contact the related devs and skip this merge.
209
Alternatively, think about automating these merges.
211
#. In the release branch, update ``version_info`` in ``./breezy/__init__.py``.
212
Make sure the corresponding milestone exists.
213
Double check that ./brz ``_script_version`` matches ``version_info``. Check
214
the output of ``./brz --version``.
216
For beta releases use::
218
version_info = (3, 0, 0, 'beta', SERIAL)
222
version_info = (3, 0, 0, 'beta', 1)
224
For stable releases use::
226
version_info = (3, 0, 0, 'final', 0)
228
#. Update the ``./doc/en/release-notes/`` section for this release.
230
Check that all news entries related to this release have been added in
231
the right section. For example, if you're releasing 3.0b3, the following
232
command should display a a single chuk diff for the 3.0b3 release::
234
brz diff -rbrz-3.0b2.. doc/en/release-notes/brz-3.0.txt
236
Fill out the date and a description of the release under the existing
237
header (the diff above will help you summarizing). If there isn't one,
238
follow the instructions above for using the ``release-template.txt`` file
239
and remind people that they should document their changes there ;)
241
See *3.0b1* or similar for an example of what this looks like.
243
#. Add or check the summary of the release into the "What's New" document.
245
If this is the first release in a new series make sure to update the
246
introduction mentioning:
248
* the date of this first release,
249
* until when the series is expected to be supported.
251
Looking at ``brz annotate`` for previous series should give you the right
252
hints. The ``doc/en/_templates/index.html`` file should also be updated.
254
#. To check that all bugs mentioned in the release notes are actually
255
marked as closed in Launchpad, you can run
256
``tools/check-newsbugs.py``::
258
./tools/check-newsbugs.py doc/en/release-notes/brz-x.y.txt
260
As of 2011-07-18, all bugs mentioned in the output of the script requires
261
some sort of intervention (either changing the status if it's not 'Fix
262
Released' or setting a different milestone if the bug hasn't been
263
fixed). A few false positives may remain in the older series, don't let
264
this slow you down too much. This script accepts options you may find
265
useful, use ``./tools/check-newsbugs.py`` to display its usage (``-w``
266
will open each bug in your browser for example).
268
#. For beta releases update the translation template::
270
BRZ_PLUGIN_PATH=-site make po/brz.pot
272
This is especially important for the final beta release which is when
273
translations are frozen and translators are requested (see `The final
274
beta - branching and translations`_) to make the translations.
276
#. For stable releases update the translations::
278
brz merge lp:~brz-core/brz/brz-translations-export-x.y
280
#. Commit these changes to the release branch, using a command like::
282
brz commit -m "Release 3.0.0"
284
The diff before you commit will be something like::
286
=== modified file 'breezy/__init__.py'
287
--- breezy/__init__.py 2011-02-09 06:35:00 +0000
288
+++ breezy/__init__.py 2011-03-10 10:24:47 +0000
290
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
291
# releaselevel of 'dev' for unreleased under-development code.
293
-version_info = (2, 3, 1, 'dev', 0)
294
+version_info = (2, 3, 1, 'final', 0)
296
# API compatibility version
297
api_minimum_version = (2, 3, 0)
299
=== modified file 'doc/en/release-notes/brz-2.3.txt'
300
--- doc/en/release-notes/brz-2.3.txt 2011-03-09 08:30:16 +0000
301
+++ doc/en/release-notes/brz-2.3.txt 2011-03-10 10:40:47 +0000
306
-:2.3.1: NOT RELEASED YET
308
-External Compatibility Breaks
309
-*****************************
311
-.. These may require users to change the way they use Breezy.
316
-.. New commands, options, etc that users may wish to try out.
321
-.. Improvements to existing commands, especially improved performance
322
- or memory usage, or better results.
325
+This is a bugfix release. Upgrading is recommended for all users of earlier
331
=== modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
332
--- doc/en/whats-new/whats-new-in-2.3.txt 2011-02-03 16:29:18 +0000
333
+++ doc/en/whats-new/whats-new-in-2.3.txt 2011-03-10 11:10:36 +0000
335
improvements made to the core product, it highlights enhancements within the
336
broader Breezy world of potential interest to those upgrading.
338
-Breezy 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
339
-and 2.2, and can read and write repositories generated by all previous
340
+Breezy 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
341
+versions that weren't included in 2.3.0 and fixes some bugs on its own.
343
+See the :doc:`../release-notes/index` for details.
345
+Breezy 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
346
+and 2.2. It can read and write repositories generated by all previous
352
#. Tag the new release::
356
#. Push those changes to a brz branch and make a merge proposal::
360
Use a commit message formatted like::
364
Note that ``brz push`` should mention updating one tag (which you just
365
created). If it doesn't, double-check that you created (and pushed) this
368
#. Once the merge proposal has landed, pull down the master release branch.
371
Making the source tarball
372
-------------------------
374
#. Change into the source directory and run ::
378
#. Now we'll try expanding this tarball and running the test suite
379
to check for packaging problems::
381
make check-dist-tarball | subunit2pyunit
383
You may encounter failures while running the test suite caused by your
384
locally installed plugins. Use your own judgment to decide if you can
385
release with these failures. When in doubt, disable the faulty plugins
386
one by one until you get no more failures. Alternatively, you can use
387
``BRZ_DISABLE_PLUGINS`` or ``BRZ_PLUGIN_PATH=-site`` to disable one or
390
Remember that this branch has already been tested on
391
https://ci.breezy-vcs.org, this step is particularly testing that the
392
cython extensions, which are updated by your local cython version when
393
you run make dist, are in good shape.
396
Publishing the source tarball
397
-----------------------------
399
#. Go to the relevant <https://launchpad.net/brz/x.y> series page in Launchpad.
401
#. Create a release of the milestone, and upload the source tarball and
402
the GPG signature. Or, if you prefer, use the
403
``tools/packaging/lp-upload-release`` script to do this. Note that
404
this changes what the download widget on the Launchpad brz home
405
page shows, so don't stop the release process yet, or platform binary
406
installers won't be made and the download list will stay very small!
407
<https://bugs.launchpad.net/launchpad/+bug/586445>
410
Kick off the next cycle
411
-----------------------
413
From that point, there is no possible return, the tarball has been uploaded
414
so you can relax a bit.
416
You're still holding a "social" lock on the launchpad branch though. Until
417
your start the next cycle, nobody should land anything on this branch. If
418
they do, they either targeted the wrong branch or didn't update the news
419
file correctly, so the sooner the branch is opened again, the better.
421
This matters more for ``lp:brz`` than for ``lp:brz/x.y``, ``lp:brz`` should
422
always be open for landing, so you should do `At the start of a release
423
cycle`_ as soon as possible (i.e. update the version number in ``brz`` and
424
``breezy/__init__``, create/update the news files and create/update the
425
milestone for the next relase).
427
You may also need to do `At the start of a series cycle`_ if you're starting
430
The final beta - branching and translations
431
-------------------------------------------
433
A word of caution: the instructions above works well for all releases but
434
there is one special case that requires a bit more care: when you release
435
the *last* beta for a given ``x.y`` series (from trunk aka lp:brz), you need
436
to setup *two* branches for the next cycle:
438
#. ``lp:brz`` needs to be opened for the next *series* ``x.(y+1)``.
440
#. ``lp:brz/x.y`` needs to be opened for the next *release* ``x.y.0`` in the
441
series. Since this is first real use of ``lp:brz/x.y``, this is also the
442
deadline for the https://ci.breezy-vcs.org/ landing job to be created.
444
Both are important as ``lp:brz`` should remain open so any change can be
445
landed, ``lp:brz/x.y`` on the other hand should be ready to receive bug
448
``lp:brz`` is generally more important as the bug fixes on ``lp:brz/x.y``
449
won't be released sooner than a month from now whereas people may already
450
been waiting to land on ``lp:brz``.
454
#. Open ``lp:brz`` for ``x.(y+1)``
456
#. Create https://ci.breezy-vcs.org/ landing job and/or update the
457
``lp:brz/x.y`` branch based on whatever revision you want to release.
459
#. Release ``x.y.0`` from ``lp:brz/x.y``
461
#. Open ``lp:brz/x.y`` for bug fixes
463
You also need to ensure Launchpad is set up to import/export translations
464
for the new branch and inform translators.
466
#. Push the last beta release to a new branch::
468
brz push lp:~brz-core/brz/brz-translations-export-x.y
470
#. On the translations series synchronization settings page
471
<https://translations.launchpad.net/brz/x.y/+translations-settings>
472
turn on ``Import template files`` then for exports click ``Choose a
473
target branch`` and point it at the branch you just pushed.
475
#. E-mail translators to announce that the forthcoming stable release of brz
476
is ready for translations. Send to
477
``launchpad-translators@lists.launchpad.net`` and
478
``ubuntu-translators@lists.ubuntu.com``.
480
#. The series is now frozen for strings and API, see below for adding
481
that to the announcement.
483
Announcing the source freeze
484
----------------------------
486
#. Post to the ``bazaar@lists.ubuntu.com`` list and
487
``breezy-vcs@googlegroups.com`` , saying that the source has been
488
frozen. Be extra clear that this is only a *source* release targeted at
489
packagers and installer builders (see
490
<https://bugs.launchpad.net/launchpad/+bug/645084>). This is the cue for
491
platform maintainers and plugin authors to update their code. This is
492
done before the general public announcement of the release.
494
The freeze announcement generally guess the date of the official public
495
announcement, for the most recent stable series (the one supported by the
496
installers and most of the distributions) it's generally a few days after
497
the freeze. For older series supported only via SRUs for Ubuntu, we don't
498
control the process as tightly so guessing the date is not appropriate.
500
For the final beta release include in your announcement a notice of
501
API and translation freezes noting that public methods should not
502
be removed or changed and strings should not be added or changed.
504
#. Pause for a few days.
507
Publishing the release
508
----------------------
510
There is normally a delay of a few days after the source freeze to allow
511
for binaries to be built for various platforms. Once they have been built,
512
we have a releasable product. The next step is to make it generally
513
available to the world.
515
#. Go to the release web page at <https://launchpad.net/brz/x.y/x.y.z>
517
#. Announce on the Breezy website.
519
#. Check that the documentation for this release is available in
520
<https://www.breezy-vcs.org/doc/en/>. It should be automatically build when
521
the branch is created, by a cron script ``update-brz-docs`` on
522
``escudero``. When the first release is created in a new series, a branch
523
needs to be created on ``escudero``::
525
ssh escudero.canonical.com
527
cd /srv/doc.bazaar.canonical.com/
528
brz branch lp:brz/2.7 brz/brz.2.7
530
And the ``brz/bin/update-brz-docs`` script needs to refer to it.
532
The ``lp:brz-alldocs`` branch also needs to be updated when a new series
533
is introduced, see the ``README`` file there for more instructions
534
(looking at the branch history is also a good way to understand what
535
needs to be done and to document any policy changes).
537
Announcing the release
538
----------------------
540
Now that the release is publicly available, tell people about it.
542
#. Make an announcement mail.
544
For beta releases, this is sent to the ``bazaar@lists.ubuntu.com`` and
545
``bazaar-announce@lists.ubuntu.com`` lists.
547
For stable releases (excluding SRUs which are for older stable releases),
548
it should also be cc'd to ``info-gnu@gnu.org``,
549
``python-announce-list@python.org``, ``bug-directory@gnu.org``.
551
In all cases, it is good to set ``Reply-To: bazaar@lists.ubuntu.com``,
552
so that people who reply to the announcement don't spam other lists.
554
The announce mail will look something like this::
556
Subject: brz x.y.z released!
558
The Breezy team is happy to announce availability of a new
559
release of the brz adaptive version control system.
561
Breezy is a fork of the Bazaar version control system.
563
<<Summary paragraph from news>>
565
Thanks to everyone who contributed patches, suggestions, and
568
Breezy is now available for download from
569
https://launchpad.net/brz/x.y/x.y.z/ as a source tarball; packages
570
for various systems will be available soon.
572
<<release notes from this release back to the last major release>>
574
Feel free to tweak this to your taste.
576
#. Make an announcement through <https://launchpad.net/brz/+announce>
577
mentioning the milestone URL <https://launchpad.net/brz/+milestone/x.y.z>
578
so people get an easy access to details.
580
#. Update `<http://en.wikipedia.org/wiki/Breezy_(software)>`_ -- this should
581
be done for the stable and beta releases.
583
#. Update the python package index: <http://pypi.python.org/pypi/breezy>
585
From the tarball created and tested earlier ::
587
twine upload ../breezy-3.0.0.tar.gz ../breezy-3.0.0.tar.gz.asc
589
Remember to check the results afterward -- this should be done for
590
stable releases but not for beta releases nor SRUs.
592
The ``twine`` command is provided by the ``twine`` package on Debian and
593
Ubuntu. Beware that you need at least ``twine-1.10``.
595
If in doubt, you can test with <https://testpypi.python.org/pypi> where
596
you can register yourself, register the brz project and upload (and then
597
remove the upload and delete the project so a new release manager can
598
enjoy the same facilities). If the project already exists, have one of
599
the existing owners of the project add you to the group.
601
To use the pypi test site, you need to record your credentials for an
602
existing user (the registration process is manual and starts at
603
<https://testpypi.python.org/pypi?%3Aaction=register_form>.
605
Once registered, you can record your crdentials in your ``~/pypirc`` file
609
username:<login on testpypi>
610
password:<password on testpypi>
611
repository = https://testpypi.python.org/pypi
613
Registering the breezy project if doesn't exist is achieved with::
615
python setup.py -r https://testpypi.python.org/pypi register
617
Uploading is done with::
619
twine upload -r testpypi ../breezy-3.0.0.tar.gz ../breezy-3.0.0.tar.gz.asc
621
To be able to upload the release you must create an account on
622
<http://pypi.python.org/pypi> and have one of the existing owners of the
623
project add you to the group and update your ``[pypi]`` section in your
627
Merging the released code back to trunk
628
---------------------------------------
630
Merge the release branch back into the trunk. The ``doc/en/release-notes``
631
changes should be merged into the right place because each release series
632
has its own release-notes file, but double-check.
634
If it's not already done, advance the version number in ``brz`` and
635
``breezy/__init__.py``. File a merge proposal against ``lp:brz``.
637
As soon as you change the version number in trunk, make sure you have
638
created the corresponding milestone to ensure the continuity in bug
639
targeting or nominating. Depending on the change, you may even have to
640
create a new series (if your change the major or minor release number), in
641
that case go to `At the start of a series cycle`_ and follow the
642
instructions from there.
645
Releases until the final one
646
----------------------------
648
Congratulations - you have made your first release. Have a beer or fruit
649
juice - it's on the house! If it was a beta, you're not finished
650
yet. Another beta or hopefully a stable release is still to come.
652
The process is the same as for the first release. Goto `Doing a particular
653
release`_ and follow the instructions again. Some details change between
654
beta and stable releases, but they should be documented. If the instructions
655
aren't clear enough, please fix them.
658
Getting the release into Ubuntu
659
-------------------------------
661
/!\ Nothing in this section has been validated for breezy yet.
663
(Feel free to propose or add new sections here about what we should do to
664
get brz into other places.)
666
For the currently-under-development release of Ubuntu, no special action
667
is needed: the release should be picked by Debian and synced from there into
670
Releases off stable brz branches should go in to the ``-updates`` of the
671
Ubuntu release that originally contained that branch. (Ubuntu Lucid had
672
brz 2.2.0, so should get every 2.2.x update.) This means going through
673
the `SRU (Stable Release Updates)
674
<https://wiki.ubuntu.com/StableReleaseUpdates>`__ process.
676
Since September 2010, brz has received approval by the technical
677
board for the `MicroReleaseExceptions
678
<https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions>`__
679
category so that whole bugfix releases can more easily be
682
Progress on these realeases is tracked on the `SRU wiki
683
<http://wiki.bazaar.canonical.com/UbuntuStableReleaseUpdates>`_
686
**After making a brz stable-release release, nominate the most serious bug
687
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.**
689
This requires a couple of tricks (please reconsider and tweak as things
690
evolves from one release to the other):
692
* create a distro task with the ``Also affects distribution`` button and
693
select ``brz (Ubuntu)``.
695
* change the *URL* to point to ``ubuntu/+source/brz`` instead of ``brz``
696
(this is needed if you create the distro task but not if it exists
697
already). You should now be able to click the ``Nominate for release``
698
button and select the right Ubuntu release. As of September 2010, this
701
* ``quantal`` for the 2.6 series,
702
* ``precise`` for the 2.5 series,
703
* ``oneiric`` for the 2.4 series,
704
* ``natty`` for the 2.3 series,
705
* ``maverick`` for the 2.2 series,
706
* ``lucid`` for the 2.1 series,
708
* Subscribe the ``~ubuntu-sru`` team to the bug.
710
* Add a comment targeted to ``~ubuntu-sru`` explaining the expectations
711
(we are targeting running the test suite during the build which, as of
712
September 2010, fails for known reasons that are currently addressed).
713
Search for bugs tagged with ``sru`` for examples and don't forget to tag
714
the bug you selected.
720
* `Packaging into the brz PPA <ppa.html>`_ to make and publish Ubuntu
722
* `Breezy Developer Document Catalog <index.html>`_
723
* `Development cycles <cycle.html>`_: things that happen during the cycle
724
before the actual release.
727
vim: filetype=rst textwidth=74 ai shiftwidth=4
added
removed
doc/developers/releasing.txt
