<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Releasing Bazaar — Bazaar v2.4.2 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '2.4.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/bzr.ico"/>
<link rel="top" title="Bazaar v2.4.2 documentation" href="index.html" />
<link rel="next" title="Managing the Bazaar PPA" href="ppa.html" />
<link rel="prev" title="Interacting with the user" href="ui.html" />
<link rel="stylesheet" href="_static/bzr-doc.css" type="text/css" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="ppa.html" title="Managing the Bazaar PPA"
accesskey="N">next</a></li>
<li class="right" >
<a href="ui.html" title="Interacting with the user"
accesskey="P">previous</a> |</li>
<li><a href="http://bazaar.canonical.com/">
<img src="_static/bzr icon 16.png" /> Home</a> | </li>
<a href="http://doc.bazaar.canonical.com/en/">Documentation</a> | </li>
<li><a href="index.html">Developer Document Catalog (2.4.2)</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="releasing-bazaar">
<h1><a class="toc-backref" href="#id2">Releasing Bazaar</a><a class="headerlink" href="#releasing-bazaar" title="Permalink to this headline">¶</a></h1>
<p>This document describes the processes for making and announcing a Bazaar
release, and managing the release process. This is just one phase of
the <a class="reference external" href="http://doc.bazaar.canonical.com/developers/cycle.html">overall development cycle</a>, (go re-read
this document to ensure it hasn’t been updated) but it’s the most
complex part. This document gives a checklist you can follow from start
to end in one go.</p>
<p>If you’re helping the Release Manager (RM) for one reason or another, you
may notice that he didn’t follow that document scrupulously. He may have
good reasons to do that but he may also have missed some parts.</p>
<p>Follow the document yourself and don’t hesitate to create the missing
milestones for example (we tend to forget these ones a lot).</p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#releasing-bazaar" id="id2">Releasing Bazaar</a><ul>
<li><a class="reference internal" href="#preconditions" id="id3">Preconditions</a></li>
<li><a class="reference internal" href="#when-do-we-relase" id="id4">When do we relase ?</a></li>
<li><a class="reference internal" href="#at-the-start-of-a-release-cycle" id="id5">At the start of a release cycle</a></li>
<li><a class="reference internal" href="#doing-a-particular-release" id="id6">Doing a particular release</a><ul>
<li><a class="reference internal" href="#update-the-source-code" id="id7">Update the source code</a></li>
<li><a class="reference internal" href="#making-the-source-tarball" id="id8">Making the source tarball</a></li>
<li><a class="reference internal" href="#publishing-the-source-tarball" id="id9">Publishing the source tarball</a></li>
<li><a class="reference internal" href="#announcing-the-source-freeze" id="id10">Announcing the source freeze</a></li>
<li><a class="reference internal" href="#kick-off-the-next-cycle" id="id11">Kick off the next cycle</a></li>
<li><a class="reference internal" href="#publishing-the-release" id="id12">Publishing the release</a></li>
<li><a class="reference internal" href="#announcing-the-release" id="id13">Announcing the release</a></li>
<li><a class="reference internal" href="#merging-the-released-code-back-to-trunk" id="id14">Merging the released code back to trunk</a></li>
<li><a class="reference internal" href="#releases-until-the-final-one" id="id15">Releases until the final one</a></li>
<li><a class="reference internal" href="#getting-the-release-into-ubuntu" id="id16">Getting the release into Ubuntu</a></li>
<li><a class="reference internal" href="#see-also" id="id17">See also</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="preconditions">
<h2><a class="toc-backref" href="#id3">Preconditions</a><a class="headerlink" href="#preconditions" title="Permalink to this headline">¶</a></h2>
<ol class="arabic">
<li><p class="first">Download the pqm plugin and install it into your <tt class="docutils literal"><span class="pre">~/.bazaar/plugins</span></tt>:</p>
<div class="highlight-python"><pre>bzr branch lp:bzr-pqm ~/.bazaar/plugins/pqm</pre>
</div>
</li>
</ol>
</div>
<div class="section" id="when-do-we-relase">
<h2><a class="toc-backref" href="#id4">When do we relase ?</a><a class="headerlink" href="#when-do-we-relase" title="Permalink to this headline">¶</a></h2>
<p>As of October 2010, we mantain four series. Concurrently releasing them
all at the same time makes it harder to shorten the delay between the
source availability and the package building longer than necessary (we
delay the official announcement until most of our users can install the new
release).</p>
<p>In order to continue to do time-based releases, we need to plan the
releases by series to minimize the collisions. In the end, it’s the Release
Manager call to decide whether he prefers to do all releases at once
though, so the rules presented here are a conservative approach.</p>
<p>We want to respect the following rules:</p>
<div class="highlight-python"><pre>#. as much as possible releases should not disturb development, and
ongoing development should not disturb releases,
#. the most recent development series should release once a month during
the beta period (see `Development cycles <cycle.html>`_ for more
details),
#. the most recent stable series should release every other month (based
on the amount of bug fixes, this can be shorter or longer depending on
the bugs importance),
#. previous series should relesase on a regular basis without interfering
with the most recent series with a decreasing order of priority (again
this should be based on bugs importance and user feedback),
#. the death of a series should be planned ahead of time. 6 months should
give enough time to our users to migrate to a more recent series. This
doesn't mean we will make a release at the end of the series, just that
before the end date we _could_ possibly put out another release if
there was a sufficiently important fix. Beyond that date, we won't
even land changes on that branch (unless something causes a miraculous
resurrection.)
#. there should not be more than 2 releases in the same week (but the
Release Manager is free to ignore this (get in touch with packagers
though),
#. the series are aligned with Ubuntu releases for convenience since we
create a new series every 6 months. This means that we support the
stable series for 18 months. Note that we also propose the most recent
stable series via the ppa, so whether we keep supporting LTS directly
or via the ppa is still an open question.</pre>
</div>
</div>
<div class="section" id="at-the-start-of-a-release-cycle">
<h2><a class="toc-backref" href="#id5">At the start of a release cycle</a><a class="headerlink" href="#at-the-start-of-a-release-cycle" title="Permalink to this headline">¶</a></h2>
<p>To start a new release cycle:</p>
<ol class="arabic">
<li><p class="first">If this is the first release for a given <em>x.y</em> then create a new
series at <<a class="reference external" href="https://launchpad.net/bzr/+addseries">https://launchpad.net/bzr/+addseries</a>>. There is one series
for every <em>x.y</em> release.</p>
</li>
<li><p class="first">If you made a new series, create a new pqm-controlled branch for this
release series, by asking a Canonical sysadmin. This branch means that
from the first release beta or candidate onwards, general development
continues on the trunk, and only specifically-targeted fixes go into
the release branch.</p>
</li>
<li><p class="first">If you made a new series, add milestones at
<<a class="reference external" href="https://launchpad.net/bzr/x.y/+addmilestone">https://launchpad.net/bzr/x.y/+addmilestone</a>> to that series for
the beta release, release candidate and the final release, and their
expected dates.</p>
</li>
<li><p class="first">Create a new milestone <<a class="reference external" href="https://launchpad.net/bzr/x.y/+addmilestone">https://launchpad.net/bzr/x.y/+addmilestone</a>>
and add information about this release. We will not use it yet, but it
will be available for targeting or nominating bugs.</p>
</li>
<li><p class="first">Send mail to the list with the key dates, who will be the release
manager, and the main themes or targeted bugs. Ask people to nominate
objectives, or point out any high-risk things that are best done early,
or that interact with other changes. This is called the metronome mail
and is described in <a class="reference external" href="cycle.html">Development cycles</a>.</p>
</li>
<li><p class="first">Make a local branch for preparing this release. (Only for the first
release in a series, otherwise you should already have a branch.)</p>
<div class="highlight-python"><pre>bzr branch trunk prepare-1.14</pre>
</div>
</li>
<li><p class="first">Configure pqm-submit for this branch, with a section like this (where
x.y is the version to release). <strong>Or use hydrazine for easy use</strong>
<tt class="docutils literal"><span class="pre">~/.bazaar/locations.conf</span></tt>:</p>
<div class="highlight-python"><pre> [/home/mbp/bzr/prepare-x.y]
pqm_email = Canonical PQM <pqm@bazaar-vcs.org>
submit_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
parent_branch = http://bazaar.launchpad.net/~bzr-pqm/bzr/x.y
public_branch = http://bazaar.example.com/prepare-x.y
submit_to = bazaar@lists.canonical.com
smtp_server = mail.example.com:25
Please see <http://doc.bazaar.canonical.com/developers/HACKING.html#an-overview-of-pqm>
for more details on PQM</pre>
</div>
</li>
<li><p class="first">Update the version number in the <tt class="docutils literal"><span class="pre">bzr</span></tt> script, and the
<tt class="docutils literal"><span class="pre">bzrlib/__init__.py</span></tt> file:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">version_info</span> <span class="o">=</span> <span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">z</span><span class="p">,</span> <span class="s">'dev'</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">If you made a new series, then start a new release-notes file:</p>
<div class="highlight-python"><pre>cd doc/en/release-notes
cp series-template.txt bzr-x.y.txt # e.g. bzr-2.3.txt
bzr add bzr-x.y.txt</pre>
</div>
</li>
<li><p class="first">Add a new section at the top of the current release notes (in
<tt class="docutils literal"><span class="pre">doc/en/release-notes</span></tt>) about the new release, including its version
number and the headings from <tt class="docutils literal"><span class="pre">release-template.txt</span></tt>.</p>
</li>
<li><p class="first">Update the “What’s New” documents in <tt class="docutils literal"><span class="pre">doc/en/whats-new</span></tt>.</p>
</li>
<li><p class="first">Commit this and send it to PQM.</p>
</li>
</ol>
</div>
<div class="section" id="doing-a-particular-release">
<h2><a class="toc-backref" href="#id6">Doing a particular release</a><a class="headerlink" href="#doing-a-particular-release" title="Permalink to this headline">¶</a></h2>
<div class="section" id="update-the-source-code">
<h3><a class="toc-backref" href="#id7">Update the source code</a><a class="headerlink" href="#update-the-source-code" title="Permalink to this headline">¶</a></h3>
<ol class="arabic">
<li><p class="first">Check that there is a milestone for the release you’re doing. If there
is no milestone it indicates a process problem - make the milestone but
also mail the list to raise this issue in our process. Milestones are
found at <<a class="reference external" href="https://launchpad.net/bzr/+milestone/x.y.z">https://launchpad.net/bzr/+milestone/x.y.z</a>>.</p>
</li>
<li><p class="first">In the release branch, update <tt class="docutils literal"><span class="pre">version_info</span></tt> in <tt class="docutils literal"><span class="pre">./bzrlib/__init__.py</span></tt>.
Make sure the corresponding milestone exists.
Double check that ./bzr <tt class="docutils literal"><span class="pre">_script_version</span></tt> matches <tt class="docutils literal"><span class="pre">version_info</span></tt>. Check
the output of <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">--version</span></tt>.</p>
<p>For beta releases use:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">version_info</span> <span class="o">=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="s">'beta'</span><span class="p">,</span> <span class="n">SERIAL</span><span class="p">)</span>
</pre></div>
</div>
<p>For instance 2.1b1:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">version_info</span> <span class="o">=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="s">'beta'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<p>For release candidates use:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">version_info</span> <span class="o">=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="s">'candidate'</span><span class="p">,</span> <span class="n">SERIAL</span><span class="p">)</span>
</pre></div>
</div>
<p>For stable releases use:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">version_info</span> <span class="o">=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="s">'final'</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">Update the <tt class="docutils literal"><span class="pre">./doc/en/release-notes/</span></tt> section for this release.</p>
<p>Fill out the date and a description of the release under the existing
header. If there isn’t one, follow the instructions above for using the
<tt class="docutils literal"><span class="pre">release-template.txt</span></tt> file.</p>
<p>See <em>2.1.1</em> or similar for an example of what this looks like.</p>
</li>
<li><p class="first">Add a summary of the release into the “What’s New” document.</p>
</li>
<li><p class="first">To check that all bugs mentioned in the release notes are actually
marked as closed in Launchpad, you can run
<tt class="docutils literal"><span class="pre">tools/check-newsbugs.py</span></tt>:</p>
<div class="highlight-python"><pre>./tools/check-newsbugs.py doc/en/release-notes/bzr-x.y.txt</pre>
</div>
<p>As of 2011-05-26, only a few false positives remain in the older
series. Don’t let this slow you down too much. This script accepts
options you may find useful, use <tt class="docutils literal"><span class="pre">./tools/check-newsbugs.py</span></tt> to display
its usage.</p>
</li>
<li><p class="first">Commit these changes to the release branch, using a command like:</p>
<div class="highlight-python"><pre>bzr commit -m "Release 2.3.1"</pre>
</div>
<p>The diff before you commit will be something like:</p>
<div class="highlight-python"><pre>=== modified file 'bzrlib/__init__.py'
--- bzrlib/__init__.py 2011-02-09 06:35:00 +0000
+++ bzrlib/__init__.py 2011-03-10 10:24:47 +0000
@@ -52,7 +52,7 @@
# Python version 2.0 is (2, 0, 0, 'final', 0)." Additionally we use a
# releaselevel of 'dev' for unreleased under-development code.
-version_info = (2, 3, 1, 'dev', 0)
+version_info = (2, 3, 1, 'final', 0)
# API compatibility version
api_minimum_version = (2, 3, 0)
=== modified file 'doc/en/release-notes/bzr-2.3.txt'
--- doc/en/release-notes/bzr-2.3.txt 2011-03-09 08:30:16 +0000
+++ doc/en/release-notes/bzr-2.3.txt 2011-03-10 10:40:47 +0000
@@ -8,23 +8,10 @@
bzr 2.3.1
#########
-:2.3.1: NOT RELEASED YET
-
-External Compatibility Breaks
-*****************************
-
-.. These may require users to change the way they use Bazaar.
-
-New Features
-************
-
-.. New commands, options, etc that users may wish to try out.
-
-Improvements
-************
-
-.. Improvements to existing commands, especially improved performance
- or memory usage, or better results.
+:2.3.1: 2011-03-10
+
+This is a bugfix release. Upgrading is recommended for all users of earlier
+2.3 releases.
Bug Fixes
*********
=== modified file 'doc/en/whats-new/whats-new-in-2.3.txt'
--- doc/en/whats-new/whats-new-in-2.3.txt 2011-02-03 16:29:18 +0000
+++ doc/en/whats-new/whats-new-in-2.3.txt 2011-03-10 11:10:36 +0000
@@ -17,8 +17,13 @@
improvements made to the core product, it highlights enhancements within the
broader Bazaar world of potential interest to those upgrading.
-Bazaar 2.3.0 is fully compatible both locally and on the network with 2.0 2.1,
-and 2.2, and can read and write repositories generated by all previous
+Bazaar 2.3.1 includes all the fixes in the un-released 2.0.7, 2.1.4 and 2.2.5
+versions that weren't included in 2.3.0 and fixes some bugs on its own.
+
+See the :doc:`../release-notes/index` for details.
+
+Bazaar 2.3 is fully compatible both locally and on the network with 2.0, 2.1,
+and 2.2. It can read and write repositories generated by all previous
versions.
Changed Behaviour</pre>
</div>
</li>
<li><p class="first">Tag the new release:</p>
<div class="highlight-python"><pre>bzr tag bzr-2.3.1</pre>
</div>
</li>
<li><p class="first">Push those changes to a bzr repository that is public and accessible on
the Internet. PQM will pull from this repository when it attempts to merge
your changes. Then submit those changes to PQM for merge into the
appropriate release branch:</p>
<div class="highlight-python"><pre>bzr push
bzr pqm-submit -m "(vila) Release 2.3.1 (Vincent Ladeuil)"</pre>
</div>
<p>Or with hydrazine:</p>
<div class="highlight-python"><pre>bzr lp-propose -m "Release 1.14" --approve lp:bzr/1.14
feed-pqm bzr</pre>
</div>
</li>
<li><p class="first">When PQM succeeds, pull down the master release branch.</p>
</li>
</ol>
</div>
<div class="section" id="making-the-source-tarball">
<h3><a class="toc-backref" href="#id8">Making the source tarball</a><a class="headerlink" href="#making-the-source-tarball" title="Permalink to this headline">¶</a></h3>
<ol class="arabic">
<li><p class="first">Change into the source directory and run</p>
<div class="highlight-python"><pre>make dist</pre>
</div>
</li>
<li><p class="first">Now we’ll try expanding this tarball and running the test suite
to check for packaging problems:</p>
<div class="highlight-python"><pre>make check-dist-tarball | subunit2pyunit</pre>
</div>
<p>You may encounter failures while running the test suite caused by your
locally installed plugins. Use your own judgment to decide if you can
release with these failures. When in doubt, disable the faulty plugins
one by one until you get no more failures. Alternatively, you can use
<tt class="docutils literal"><span class="pre">BZR_DISABLE_PLUGINS</span></tt> or <tt class="docutils literal"><span class="pre">BZR_PLUGIN_PATH=-site</span></tt> to disable one or
all plugins.</p>
<p>Remember that PQM has just tested everything too, this step is
particularly testing that the pyrex extensions, which are updated
by your local pyrex version when you run make dist, are in good
shape.</p>
</li>
</ol>
</div>
<div class="section" id="publishing-the-source-tarball">
<h3><a class="toc-backref" href="#id9">Publishing the source tarball</a><a class="headerlink" href="#publishing-the-source-tarball" title="Permalink to this headline">¶</a></h3>
<ol class="arabic simple">
<li>Go to the relevant series page in Launchpad.</li>
<li>Create a release of the milestone, and upload the source tarball and
the GPG signature. Or, if you prefer, use the
<tt class="docutils literal"><span class="pre">tools/packaging/lp-upload-release</span></tt> script to do this. Note that
this changes what the download widget on the Launchpad bzr home
page shows, so don’t stop the release process yet, or platform binary
installers won’t be made and the download list will stay very small!
<<a class="reference external" href="https://bugs.launchpad.net/launchpad/+bug/586445">https://bugs.launchpad.net/launchpad/+bug/586445</a>></li>
</ol>
</div>
<div class="section" id="announcing-the-source-freeze">
<h3><a class="toc-backref" href="#id10">Announcing the source freeze</a><a class="headerlink" href="#announcing-the-source-freeze" title="Permalink to this headline">¶</a></h3>
<ol class="arabic simple">
<li>Post to the <tt class="docutils literal"><span class="pre">bazaar</span></tt> list, saying that the source has been frozen
(gone gold). Be extra clear that this is only a <em>source</em> release
targeted at packagers and installer builders (see
<<a class="reference external" href="https://bugs.launchpad.net/launchpad/+bug/645084">https://bugs.launchpad.net/launchpad/+bug/645084</a>>). This is the cue
for platform maintainers and plugin authors to update their code. This
is done before the general public announcement of the release.</li>
</ol>
</div>
<div class="section" id="kick-off-the-next-cycle">
<h3><a class="toc-backref" href="#id11">Kick off the next cycle</a><a class="headerlink" href="#kick-off-the-next-cycle" title="Permalink to this headline">¶</a></h3>
<ol class="arabic simple">
<li>To let developers work on the next release, do
<cite>At the start of a release cycle</cite> now.</li>
<li>Pause for a few days.</li>
</ol>
</div>
<div class="section" id="publishing-the-release">
<h3><a class="toc-backref" href="#id12">Publishing the release</a><a class="headerlink" href="#publishing-the-release" title="Permalink to this headline">¶</a></h3>
<p>There is normally a delay of a few days after the source freeze to allow
for binaries to be built on various platforms. Once they have been built,
we have a releasable product. The next step is to make it generally
available to the world.</p>
<ol class="arabic simple">
<li>Go to the release web page at <<a class="reference external" href="https://launchpad.net/bzr/x.y/x.y.z">https://launchpad.net/bzr/x.y/x.y.z</a>></li>
<li>Announce on the <a class="reference external" href="http://bazaar.canonical.com/">Bazaar website</a>.
This page is edited via the lp:bzr-website branch. (Changes
pushed to this branch are refreshed by a cron job on escudero.)</li>
<li>Check that the documentation for this release is available in
<<a class="reference external" href="http://doc.bazaar.canonical.com">http://doc.bazaar.canonical.com</a>>. It should be automatically build when the
branch is created, by a cron script <tt class="docutils literal"><span class="pre">update-bzr-docs</span></tt> on
<tt class="docutils literal"><span class="pre">escudero</span></tt>.</li>
</ol>
</div>
<div class="section" id="announcing-the-release">
<h3><a class="toc-backref" href="#id13">Announcing the release</a><a class="headerlink" href="#announcing-the-release" title="Permalink to this headline">¶</a></h3>
<p>Now that the release is publicly available, tell people about it.</p>
<ol class="arabic">
<li><p class="first">Make an announcement mail.</p>
<p>For release candidates or beta releases, this is sent to the <tt class="docutils literal"><span class="pre">bazaar</span></tt>
list only to inform plugin authors and package or installer managers.</p>
<p>Once the installers are available, the mail can be sent to the
<tt class="docutils literal"><span class="pre">bazaar-announce</span></tt> list too.</p>
<p>For final releases, it should also be cc’d to <tt class="docutils literal"><span class="pre">info-gnu@gnu.org</span></tt>,
<tt class="docutils literal"><span class="pre">python-announce-list@python.org</span></tt>, <tt class="docutils literal"><span class="pre">bug-directory@gnu.org</span></tt>.</p>
<p>In all cases, it is good to set <tt class="docutils literal"><span class="pre">Reply-To:</span> <span class="pre">bazaar@lists.canonical.com</span></tt>,
so that people who reply to the announcement don’t spam other lists.</p>
<p>The announce mail will look something like this:</p>
<div class="highlight-python"><pre>Subject: bzr x.y.z released!
The Bazaar team is happy to announce availability of a new
release of the bzr adaptive version control system.
Bazaar is part of the GNU system <http://gnu.org/>.
<<Summary paragraph from news>>
Thanks to everyone who contributed patches, suggestions, and
feedback.
Bazaar is now available for download from
https://launchpad.net/bzr/x.y/x.y.z/ as a source tarball; packages
for various systems will be available soon.
<<release notes from this release back to the last major release>></pre>
</div>
<p>Feel free to tweak this to your taste.</p>
</li>
<li><p class="first">Make an announcement through <<a class="reference external" href="https://launchpad.net/bzr/+announce">https://launchpad.net/bzr/+announce</a>></p>
</li>
<li><p class="first">Update the IRC channel topic. Use the <tt class="docutils literal"><span class="pre">/topic</span></tt> command to do this,
ensuring the new topic text keeps the project name, web site link, etc.</p>
</li>
<li><p class="first">Announce on <a class="reference external" href="http://freshmeat.net/projects/bzr/">http://freshmeat.net/projects/bzr/</a></p>
<p>This should be done for beta releases, release candidates and final
releases. If you do not have a Freshmeat account yet, ask one of the
existing admins.</p>
<p>The purpose here is to point users to the latest stable release while still
publishing announcements for development releases.</p>
<p>There are several kinds of modifications that could be done there via the
<tt class="docutils literal"><span class="pre">Administration</span></tt> box in the lower right area of the page:</p>
<ul class="simple">
<li>Edit the project: This is where most of the URLs proposed in the
<tt class="docutils literal"><span class="pre">Links</span></tt> box are edited. This should rarely change except for the URLs
related to the latest stable release.</li>
<li>New announcement: When doing a release (beta, candidates, final), put the
summary of the release (you can’t embed URLs there, the moderation staff
remove them). Users can still access the releases notes via the <tt class="docutils literal"><span class="pre">Release</span>
<span class="pre">Notes</span></tt> URL in the <tt class="docutils literal"><span class="pre">Links</span></tt> box in the upper right area of the
page. When doing the first stable release in a series, delete the
<tt class="docutils literal"><span class="pre">Unstable</span> <span class="pre">installers</span></tt> <<a class="reference external" href="https://launchpad.net/bzr/x.y/x.ybn">https://launchpad.net/bzr/x.y/x.ybn</a>> and
<tt class="docutils literal"><span class="pre">Unstable</span> <span class="pre">source</span> <span class="pre">tarball</span></tt>
<<a class="reference external" href="http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz">http://launchpad.net/bzr/x.y/x.ybn/+download/bzr-x.ybn.tar.gz</a>>
links. Conversely, when creating the first beta in a development series,
create these links again. Check all links when doing other kinds of
release.</li>
<li>Set direct download: When releasing a new stable release, this should
point to the corresponding launchpad page:
<<a class="reference external" href="https://launchpad.net/bzr/x.y/x.y.z/">https://launchpad.net/bzr/x.y/x.y.z/</a>></li>
</ul>
</li>
<li><p class="first">Update <a class="reference external" href="http://en.wikipedia.org/wiki/Bazaar_(software)">http://en.wikipedia.org/wiki/Bazaar_(software)</a> – this should
be done for final releases but not for beta releases or Release Candidates.</p>
</li>
<li><p class="first">Update the python package index: <<a class="reference external" href="http://pypi.python.org/pypi/bzr">http://pypi.python.org/pypi/bzr</a>> - best
done by running</p>
<div class="highlight-python"><pre>python setup.py register</pre>
</div>
<p>Remember to check the results afterwards – this should be done for
final releases but not for beta releases or Release Candidates.</p>
<p>To be able to register the release you must create an account on
<<a class="reference external" href="http://pypi.python.org/pypi">http://pypi.python.org/pypi</a>> and have one of the existing owners of
the project add you to the group.</p>
</li>
</ol>
</div>
<div class="section" id="merging-the-released-code-back-to-trunk">
<h3><a class="toc-backref" href="#id14">Merging the released code back to trunk</a><a class="headerlink" href="#merging-the-released-code-back-to-trunk" title="Permalink to this headline">¶</a></h3>
<p>Merge the release branch back into the trunk. The
<tt class="docutils literal"><span class="pre">doc/en/release-notes</span></tt> changes should be merged into the right place
because each release series has its own release-notes file, but
double-check.</p>
<p>If it’s not already done, advance the version number in <tt class="docutils literal"><span class="pre">bzr</span></tt> and
<tt class="docutils literal"><span class="pre">bzrlib/__init__.py</span></tt>. Submit this back into pqm for bzr.dev.</p>
<p>As soon as you change the version number in trunk, make sure you have
created the corresponding milestone to ensure the continuity in bug
targeting or nominating. Depending on the change, you may even have to
create a new series (if your change the major or minor release number), in
that case go to <cite>At the start of a release cycle</cite> and follow the instructions from there.</p>
<p>You should also merge (not pull) the release branch into
<tt class="docutils literal"><span class="pre">lp:~bzr/bzr/current</span></tt>, so that branch contains the current released code
at any time.</p>
</div>
<div class="section" id="releases-until-the-final-one">
<h3><a class="toc-backref" href="#id15">Releases until the final one</a><a class="headerlink" href="#releases-until-the-final-one" title="Permalink to this headline">¶</a></h3>
<p>Congratulations - you have made your first release. Have a beer
or fruit juice - it’s on the house! If it was a beta, or
candidate, you’re not finished yet. Another beta or candidate or
hopefully a final release is still to come.</p>
<p>The process is the same as for the first release. Goto <a class="reference internal" href="#doing-a-particular-release">Doing a
particular release</a> and follow the instructions again. Some details change
between beta, candidate and final releases, but they should be
documented. If the instructions aren’t clear enough, please fix them.</p>
</div>
<div class="section" id="getting-the-release-into-ubuntu">
<h3><a class="toc-backref" href="#id16">Getting the release into Ubuntu</a><a class="headerlink" href="#getting-the-release-into-ubuntu" title="Permalink to this headline">¶</a></h3>
<p>(Feel free to propose or add new sections here about what we should do to
get bzr into other places.)</p>
<p>For the currently-under-development release of Ubuntu, no special action
is needed: the release should be picked by Debian and synced from there into
Ubuntu.</p>
<p>Releases off stable bzr branches should go in to the <tt class="docutils literal"><span class="pre">-updates</span></tt> of the
Ubuntu release that originally contained that branch. (Ubuntu Lucid had
bzr 2.2.0, so should get every 2.2.x update.) This means going through
the <a class="reference external" href="https://wiki.ubuntu.com/StableReleaseUpdates">SRU (Stable Release Updates)</a> process.</p>
<p>As of September 2010, bzr has applied to the technical board to be added
to the <a class="reference external" href="https://wiki.ubuntu.com/StableReleaseUpdates/MicroReleaseExceptions">MicroReleaseExceptions</a>
category so that whole bugfix releases can more easily be approved.</p>
<p><strong>After making a bzr stable-release release, nominate the most serious bug
for the appropriate Ubuntu release and subscribe the `ubuntu-sru` team.</strong></p>
<p>This requires a couple of tricks (please reconsider and tweak as things
evolves from one release to the other):</p>
<blockquote>
<div><ul class="simple">
<li>create a distro task with the <tt class="docutils literal"><span class="pre">Also</span> <span class="pre">affects</span> <span class="pre">distribution</span></tt> button and
select <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">(Ubuntu)</span></tt>.</li>
<li>change the <em>URL</em> to point to <tt class="docutils literal"><span class="pre">ubuntu/+source/bzr</span></tt> instead of <tt class="docutils literal"><span class="pre">bzr</span></tt>
(this is needed if you create the distro task but not if it exists
already). You should now be able to click the <tt class="docutils literal"><span class="pre">Nominate</span> <span class="pre">for</span> <span class="pre">release</span></tt>
button and select the right Ubuntu release. As of September 2010, this
means:</li>
</ul>
<blockquote>
<div><ul class="simple">
<li><tt class="docutils literal"><span class="pre">maverick</span></tt> for the 2.2 series,</li>
<li><tt class="docutils literal"><span class="pre">lucid</span></tt> for the 2.1 series,</li>
<li><tt class="docutils literal"><span class="pre">karmic</span></tt> for the 2.0 series.</li>
</ul>
</div></blockquote>
<ul class="simple">
<li>Subscribe the <tt class="docutils literal"><span class="pre">~ubuntu-sru</span></tt> team to the bug.</li>
<li>Add a comment targeted to <tt class="docutils literal"><span class="pre">~ubuntu-sru</span></tt> explaining the expectations
(we are targeting running the test suite during the build which, as of
September 2010, fails for known reasons that are currently addressed).
Search for bugs tagged with <tt class="docutils literal"><span class="pre">sru</span></tt> for examples and don’t forget to tag
the bug you selected.</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="see-also">
<h3><a class="toc-backref" href="#id17">See also</a><a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><a class="reference external" href="ppa.html">Packaging into the bzr PPA</a> to make and publish Ubuntu
packages.</li>
<li><a class="reference external" href="index.html">Bazaar Developer Document Catalog</a></li>
<li><a class="reference external" href="cycle.html">Development cycles</a>: things that happen during the cycle
before the actual release.</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Releasing Bazaar</a><ul>
<li><a class="reference internal" href="#preconditions">Preconditions</a></li>
<li><a class="reference internal" href="#when-do-we-relase">When do we relase ?</a></li>
<li><a class="reference internal" href="#at-the-start-of-a-release-cycle">At the start of a release cycle</a></li>
<li><a class="reference internal" href="#doing-a-particular-release">Doing a particular release</a><ul>
<li><a class="reference internal" href="#update-the-source-code">Update the source code</a></li>
<li><a class="reference internal" href="#making-the-source-tarball">Making the source tarball</a></li>
<li><a class="reference internal" href="#publishing-the-source-tarball">Publishing the source tarball</a></li>
<li><a class="reference internal" href="#announcing-the-source-freeze">Announcing the source freeze</a></li>
<li><a class="reference internal" href="#kick-off-the-next-cycle">Kick off the next cycle</a></li>
<li><a class="reference internal" href="#publishing-the-release">Publishing the release</a></li>
<li><a class="reference internal" href="#announcing-the-release">Announcing the release</a></li>
<li><a class="reference internal" href="#merging-the-released-code-back-to-trunk">Merging the released code back to trunk</a></li>
<li><a class="reference internal" href="#releases-until-the-final-one">Releases until the final one</a></li>
<li><a class="reference internal" href="#getting-the-release-into-ubuntu">Getting the release into Ubuntu</a></li>
<li><a class="reference internal" href="#see-also">See also</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="ui.html"
title="previous chapter">Interacting with the user</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ppa.html"
title="next chapter">Managing the Bazaar PPA</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/releasing.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="ppa.html" title="Managing the Bazaar PPA"
>next</a></li>
<li class="right" >
<a href="ui.html" title="Interacting with the user"
>previous</a> |</li>
<li><a href="http://bazaar.canonical.com/">
<img src="_static/bzr icon 16.png" /> Home</a> | </li>
<a href="http://doc.bazaar.canonical.com/en/">Documentation</a> | </li>
<li><a href="index.html">Developer Document Catalog (2.4.2)</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2011 Canonical Ltd.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
