<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Releasing Bazaar — Bazaar 2.7.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="shortcut icon" href="_static/bzr.ico"/>
<link rel="search" title="Search" href="search.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" role="navigation" aria-label="related navigation">
<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 class="nav-item nav-item-0"><a href="index.html">Developer Document Catalog (2.7.0)</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="releasing-bazaar">
<h1><a class="toc-backref" href="#id3">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 since you last read it) but it’s
the most complex part.</p>
<p>If you’re doing your first release you can follow this document and read
each step explanation. It’s also a good practice to read it for any release
to ensure you don’t miss a step and to update it as the release process
evolves.</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>
<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="id3">Releasing Bazaar</a><ul>
<li><a class="reference internal" href="#preconditions" id="id4">Preconditions</a></li>
<li><a class="reference internal" href="#what-do-we-release" id="id5">What do we release</a></li>
<li><a class="reference internal" href="#when-do-we-relase" id="id6">When do we relase ?</a></li>
<li><a class="reference internal" href="#at-the-start-of-a-series-cycle" id="id7">At the start of a series cycle</a></li>
<li><a class="reference internal" href="#at-the-start-of-a-release-cycle" id="id8">At the start of a release cycle</a></li>
<li><a class="reference internal" href="#doing-a-particular-release" id="id9">Doing a particular release</a><ul>
<li><a class="reference internal" href="#update-the-source-code" id="id10">Update the source code</a></li>
<li><a class="reference internal" href="#making-the-source-tarball" id="id11">Making the source tarball</a></li>
<li><a class="reference internal" href="#publishing-the-source-tarball" id="id12">Publishing the source tarball</a></li>
<li><a class="reference internal" href="#kick-off-the-next-cycle" id="id13">Kick off the next cycle</a></li>
<li><a class="reference internal" href="#the-final-beta-branching-and-translations" id="id14">The final beta - branching and translations</a></li>
<li><a class="reference internal" href="#announcing-the-source-freeze" id="id15">Announcing the source freeze</a></li>
<li><a class="reference internal" href="#publishing-the-release" id="id16">Publishing the release</a></li>
<li><a class="reference internal" href="#announcing-the-release" id="id17">Announcing the release</a></li>
<li><a class="reference internal" href="#merging-the-released-code-back-to-trunk" id="id18">Merging the released code back to trunk</a></li>
<li><a class="reference internal" href="#releases-until-the-final-one" id="id19">Releases until the final one</a></li>
<li><a class="reference internal" href="#getting-the-release-into-ubuntu" id="id20">Getting the release into Ubuntu</a></li>
<li><a class="reference internal" href="#see-also" id="id21">See also</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="preconditions">
<h2><a class="toc-backref" href="#id4">Preconditions</a><a class="headerlink" href="#preconditions" title="Permalink to this headline">¶</a></h2>
<ol class="arabic">
<li><p class="first">PQM access rights (or you won’t be able to land any change)</p>
</li>
<li><p class="first">Download the pqm plugin and install it into your <code class="docutils literal notranslate"><span class="pre">~/.bazaar/plugins</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">branch</span> <span class="n">lp</span><span class="p">:</span><span class="n">bzr</span><span class="o">-</span><span class="n">pqm</span> <span class="o">~/.</span><span class="n">bazaar</span><span class="o">/</span><span class="n">plugins</span><span class="o">/</span><span class="n">pqm</span>
</pre></div>
</div>
</li>
<li><p class="first">Alternatively, you can download and install <code class="docutils literal notranslate"><span class="pre">lp:hydrazine</span></code> (the main
difference is that hydrazine requires the branch to land to be hosted on
launchpad).</p>
</li>
</ol>
</div>
<div class="section" id="what-do-we-release">
<h2><a class="toc-backref" href="#id5">What do we release</a><a class="headerlink" href="#what-do-we-release" title="Permalink to this headline">¶</a></h2>
<p>In this document, we’re talking about source releases only, packages and
installers are built from this but we won’t talk about them here.</p>
<p>Every release is part of a series, <code class="docutils literal notranslate"><span class="pre">bzr-2.4.1</span></code> is part of series <code class="docutils literal notranslate"><span class="pre">2.4</span></code>.</p>
<p>We do two different kind of releases: the betas releases and the stable
releases for a given series.</p>
<p>For a given series, releases will be done to deliver new versions of bzr to
different kinds of users:</p>
<ol class="arabic simple">
<li>beta releases: named <code class="docutils literal notranslate"><span class="pre">x.ybn</span></code> where <code class="docutils literal notranslate"><span class="pre">x.y</span></code> is the series and <code class="docutils literal notranslate"><span class="pre">n</span></code>
starts at 1 and is incremented. These releases are targeted to beta
testers who don’t want to run from source but are interested in features
or improvements.</li>
<li>stable releases: name <code class="docutils literal notranslate"><span class="pre">x.y.z</span></code> where <code class="docutils literal notranslate"><span class="pre">x.y.</span></code> is the series and <code class="docutils literal notranslate"><span class="pre">z</span></code>
starts at 0 and is incremented. These releases are targeted at people
that want bugfixes only and no new features.</li>
</ol>
<p>Differences in the release process between beta and stable release will be
mentioned when needed.</p>
</div>
<div class="section" id="when-do-we-relase">
<h2><a class="toc-backref" href="#id6">When do we relase ?</a><a class="headerlink" href="#when-do-we-relase" title="Permalink to this headline">¶</a></h2>
<p>As of July 2011, we maintain four series (and one that is about to be EOLed).
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>
<ol class="arabic simple">
<li>as much as possible releases should not disturb development, and
ongoing development should not disturb releases,</li>
<li>the most recent development series should release once a month during
the beta period (see <a class="reference external" href="cycle.html">Development cycles</a> for more
details),</li>
<li>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),</li>
<li>previous series should release 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),</li>
<li>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 <em>could</em> 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.)</li>
<li>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),</li>
<li>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 stable PPA but that the SRU processs allow us to
reach a wider audience.</li>
</ol>
</div>
<div class="section" id="at-the-start-of-a-series-cycle">
<h2><a class="toc-backref" href="#id7">At the start of a series cycle</a><a class="headerlink" href="#at-the-start-of-a-series-cycle" title="Permalink to this headline">¶</a></h2>
<p>To start a new series cycle:</p>
<ol class="arabic">
<li><p class="first">Create a new series <code class="docutils literal notranslate"><span class="pre">x.y</span></code> at <<a class="reference external" href="https://launchpad.net/bzr/+addseries">https://launchpad.net/bzr/+addseries</a>>.</p>
</li>
<li><p class="first">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 releases and the stable series mentioning their
expected dates. Only the milestone associated to the next release in
this series should be left active to avoid clutter when targeting bugs.</p>
</li>
<li><p class="first">If you made a new series, you will need to create a new pqm-controlled
branch for this release series. This branch will be used only from the
first non-beta release onwards. It needs to be created by a Canonical
sysadmin (ask the core devs for instructions or to do it for you).</p>
</li>
<li><p class="first">Start a new release-notes file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">doc</span><span class="o">/</span><span class="n">en</span><span class="o">/</span><span class="n">release</span><span class="o">-</span><span class="n">notes</span>
<span class="n">cp</span> <span class="n">series</span><span class="o">-</span><span class="n">template</span><span class="o">.</span><span class="n">txt</span> <span class="n">bzr</span><span class="o">-</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">txt</span> <span class="c1"># e.g. bzr-2.3.txt</span>
<span class="n">bzr</span> <span class="n">add</span> <span class="n">bzr</span><span class="o">-</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
</li>
<li><p class="first">Start a new whats-new file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">doc</span><span class="o">/</span><span class="n">en</span><span class="o">/</span><span class="n">whats</span><span class="o">-</span><span class="n">new</span>
<span class="n">cp</span> <span class="n">template</span><span class="o">.</span><span class="n">txt</span> <span class="n">bzr</span><span class="o">-</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">txt</span> <span class="c1"># e.g. bzr-2.6.txt</span>
<span class="n">bzr</span> <span class="n">add</span> <span class="n">bzr</span><span class="o">-</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
</li>
<li><p class="first">Update <code class="docutils literal notranslate"><span class="pre">doc/en/index.txt</span></code> to point to the new whats-new file.</p>
</li>
</ol>
</div>
<div class="section" id="at-the-start-of-a-release-cycle">
<h2><a class="toc-backref" href="#id8">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">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 to prepare the release:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">branch</span> <span class="n">lp</span><span class="p">:</span><span class="n">bzr</span><span class="o">/</span><span class="n">x</span><span class="o">.</span><span class="n">y</span> <span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">-</span><span class="n">dev</span>
</pre></div>
</div>
<p>If you’re doing your first beta release, branch from trunk:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">branch</span> <span class="n">lp</span><span class="p">:</span><span class="n">bzr</span> <span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">-</span><span class="n">dev</span>
</pre></div>
</div>
<p>Note that you will generally reuse the same branch for all releases in a
given series.</p>
</li>
<li><p class="first">Configure pqm-submit for this branch, with a section like this (where
<code class="docutils literal notranslate"><span class="pre">x.y</span></code> is the series for your release). <strong>Or use hydrazine for easier
setup</strong> <code class="docutils literal notranslate"><span class="pre">~/.bazaar/locations.conf</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="p">[</span><span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">mbp</span><span class="o">/</span><span class="n">bzr</span><span class="o">/</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">-</span><span class="n">dev</span><span class="p">]</span>
<span class="n">pqm_email</span> <span class="o">=</span> <span class="n">Canonical</span> <span class="n">PQM</span> <span class="o"><</span><span class="n">pqm</span><span class="nd">@bazaar</span><span class="o">-</span><span class="n">vcs</span><span class="o">.</span><span class="n">org</span><span class="o">></span>
<span class="n">submit_branch</span> <span class="o">=</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">bazaar</span><span class="o">.</span><span class="n">launchpad</span><span class="o">.</span><span class="n">net</span><span class="o">/~</span><span class="n">bzr</span><span class="o">-</span><span class="n">pqm</span><span class="o">/</span><span class="n">bzr</span><span class="o">/</span><span class="n">x</span><span class="o">.</span><span class="n">y</span>
<span class="n">parent_branch</span> <span class="o">=</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">bazaar</span><span class="o">.</span><span class="n">launchpad</span><span class="o">.</span><span class="n">net</span><span class="o">/~</span><span class="n">bzr</span><span class="o">-</span><span class="n">pqm</span><span class="o">/</span><span class="n">bzr</span><span class="o">/</span><span class="n">x</span><span class="o">.</span><span class="n">y</span>
<span class="n">public_branch</span> <span class="o">=</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">bazaar</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">-</span><span class="n">dev</span>
<span class="n">submit_to</span> <span class="o">=</span> <span class="n">bazaar</span><span class="nd">@lists</span><span class="o">.</span><span class="n">canonical</span><span class="o">.</span><span class="n">com</span>
<span class="n">smtp_server</span> <span class="o">=</span> <span class="n">mail</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="p">:</span><span class="mi">25</span>
<span class="n">Please</span> <span class="n">see</span> <span class="o"><</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">doc</span><span class="o">.</span><span class="n">bazaar</span><span class="o">.</span><span class="n">canonical</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">developers</span><span class="o">/</span><span class="n">HACKING</span><span class="o">.</span><span class="n">html</span><span class="c1">#an-overview-of-pqm></span>
<span class="k">for</span> <span class="n">more</span> <span class="n">details</span> <span class="n">on</span> <span class="n">PQM</span>
</pre></div>
</div>
</li>
<li><p class="first">Update the version number in the <code class="docutils literal notranslate"><span class="pre">bzr</span></code> script, and the
<code class="docutils literal notranslate"><span class="pre">bzrlib/__init__.py</span></code> file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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="s1">'dev'</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">Add a new section at the top of the current release notes (in
<code class="docutils literal notranslate"><span class="pre">doc/en/release-notes</span></code>) about the new release, including its version
number and the headings from <code class="docutils literal notranslate"><span class="pre">release-template.txt</span></code>.</p>
</li>
<li><p class="first">Update the “What’s New” documents in <code class="docutils literal notranslate"><span class="pre">doc/en/whats-new</span></code>.</p>
</li>
<li><p class="first">Make sure a milestone exists for your release and that it is active,
<<a class="reference external" href="https://launchpad.net/bzr/x.y">https://launchpad.net/bzr/x.y</a>> lists the existing milestones,
<<a class="reference external" href="https://launchpad.net/bzr/x.y/x.y.z/+edit">https://launchpad.net/bzr/x.y/x.y.z/+edit</a>> allows you to toggle the
active flag.</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="#id9">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="#id10">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">Merge into your branch all previous stable series fixes that haven’t been
merged yet. For example, if you’re releasing 2.6.x, make sure the fixes
on 2.5, 2.4, 2.3, etc have already been merged up:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">merge</span> <span class="n">lp</span><span class="p">:</span><span class="n">bzr</span><span class="o">/</span><span class="mf">2.4</span>
</pre></div>
</div>
<p>and commit that merge in its own commit. This should happen only if the
devs landing changes in previous releases forgot to merge them up. Since
this can slow down the freeze, feel free to gently remind them about
their duties ;) If you feel unsafe resolving the conflicts or it’s too
time consuming, contact the related devs and skip this merge.</p>
</li>
<li><p class="first">In the release branch, update <code class="docutils literal notranslate"><span class="pre">version_info</span></code> in <code class="docutils literal notranslate"><span class="pre">./bzrlib/__init__.py</span></code>.
Make sure the corresponding milestone exists.
Double check that ./bzr <code class="docutils literal notranslate"><span class="pre">_script_version</span></code> matches <code class="docutils literal notranslate"><span class="pre">version_info</span></code>. Check
the output of <code class="docutils literal notranslate"><span class="pre">./bzr</span> <span class="pre">--version</span></code>.</p>
<p>For beta releases use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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">6</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'beta'</span><span class="p">,</span> <span class="n">SERIAL</span><span class="p">)</span>
</pre></div>
</div>
<p>For instance 2.6b1:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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">6</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'beta'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
<p>For stable releases use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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">6</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'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 <code class="docutils literal notranslate"><span class="pre">./doc/en/release-notes/</span></code> section for this release.</p>
<p>Check that all news entries related to this release have been added in
the right section. For example, if you’re releasing 2.6b2, the following
command should display a a single chuk diff for the 2.6b2 release:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">diff</span> <span class="o">-</span><span class="n">rbzr</span><span class="o">-</span><span class="mf">2.6</span><span class="n">b2</span><span class="o">..</span> <span class="n">doc</span><span class="o">/</span><span class="n">en</span><span class="o">/</span><span class="n">release</span><span class="o">-</span><span class="n">notes</span><span class="o">/</span><span class="n">bzr</span><span class="o">-</span><span class="mf">2.6</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
<p>Fill out the date and a description of the release under the existing
header (the diff above will help you summarizing). If there isn’t one,
follow the instructions above for using the <code class="docutils literal notranslate"><span class="pre">release-template.txt</span></code> file
and remind people that they should document their changes there ;)</p>
<p>See <em>2.6b1</em> or similar for an example of what this looks like.</p>
</li>
<li><p class="first">Add or check the summary of the release into the “What’s New” document.</p>
</li>
</ol>
<blockquote>
<div><p>If this is the first release in a new series make sure to update the
introduction mentioning:</p>
<ul class="simple">
<li>the date of this first release,</li>
<li>until when the series is expected to be supported.</li>
</ul>
<p>Looking at <code class="docutils literal notranslate"><span class="pre">bzr</span> <span class="pre">annotate</span></code> for previous series should give you the right
hints. The <code class="docutils literal notranslate"><span class="pre">doc/en/_templates/index.html</span></code> file should also be updated.</p>
</div></blockquote>
<ol class="arabic">
<li><p class="first">To check that all bugs mentioned in the release notes are actually
marked as closed in Launchpad, you can run
<code class="docutils literal notranslate"><span class="pre">tools/check-newsbugs.py</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">tools</span><span class="o">/</span><span class="n">check</span><span class="o">-</span><span class="n">newsbugs</span><span class="o">.</span><span class="n">py</span> <span class="n">doc</span><span class="o">/</span><span class="n">en</span><span class="o">/</span><span class="n">release</span><span class="o">-</span><span class="n">notes</span><span class="o">/</span><span class="n">bzr</span><span class="o">-</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
<p>As of 2011-07-18, all bugs mentioned in the output of the script requires
some sort of intervention (either changing the status if it’s not ‘Fix
Released’ or setting a different milestone if the bug hasn’t been
fixed). A few false positives may remain in the older series, don’t let
this slow you down too much. This script accepts options you may find
useful, use <code class="docutils literal notranslate"><span class="pre">./tools/check-newsbugs.py</span></code> to display its usage (<code class="docutils literal notranslate"><span class="pre">-w</span></code>
will open each bug in your browser for example).</p>
</li>
<li><p class="first">For beta releases update the translation template:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">BZR_PLUGIN_PATH</span><span class="o">=-</span><span class="n">site</span> <span class="n">make</span> <span class="n">po</span><span class="o">/</span><span class="n">bzr</span><span class="o">.</span><span class="n">pot</span>
</pre></div>
</div>
<p>This is especially important for the final beta release which is when
translations are frozen and translators are requested (see <a class="reference internal" href="#the-final-beta-branching-and-translations">The final
beta - branching and translations</a>) to make the translations.</p>
</li>
<li><p class="first">For stable releases update the translations:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">merge</span> <span class="n">lp</span><span class="p">:</span><span class="o">~</span><span class="n">bzr</span><span class="o">-</span><span class="n">core</span><span class="o">/</span><span class="n">bzr</span><span class="o">/</span><span class="n">bzr</span><span class="o">-</span><span class="n">translations</span><span class="o">-</span><span class="n">export</span><span class="o">-</span><span class="n">x</span><span class="o">.</span><span class="n">y</span>
</pre></div>
</div>
</li>
<li><p class="first">Commit these changes to the release branch, using a command like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">commit</span> <span class="o">-</span><span class="n">m</span> <span class="s2">"Release 2.3.1"</span>
</pre></div>
</div>
<p>The diff before you commit will be something like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>=== 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>
</div>
</li>
<li><p class="first">Tag the new release:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">tag</span> <span class="n">bzr</span><span class="o">-</span><span class="mf">2.6</span><span class="o">.</span><span class="mi">0</span>
</pre></div>
</div>
</li>
<li><p class="first">Push those changes to a bzr branch that is public and accessible on the
Internet. PQM will pull from this branch when it attempts to merge your
changes. Then submit those changes to PQM for merge into the appropriate
release branch:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">push</span>
<span class="n">bzr</span> <span class="n">pqm</span><span class="o">-</span><span class="n">submit</span> <span class="o">-</span><span class="n">m</span> <span class="s2">"(vila) Release 2.6.0 (Vincent Ladeuil)"</span>
</pre></div>
</div>
<p>Note that <code class="docutils literal notranslate"><span class="pre">bzr</span> <span class="pre">push</span></code> should mention updating one tag (which you just
created). If it doesn’t, double-check that you created (and pushed) this
tag.</p>
<p>Or with hydrazine:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">lp</span><span class="o">-</span><span class="n">propose</span> <span class="o">-</span><span class="n">m</span> <span class="s2">"Release 1.14"</span> <span class="o">--</span><span class="n">approve</span> <span class="n">lp</span><span class="p">:</span><span class="n">bzr</span><span class="o">/</span><span class="mf">1.14</span>
<span class="n">feed</span><span class="o">-</span><span class="n">pqm</span> <span class="n">bzr</span>
</pre></div>
</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="#id11">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-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">dist</span>
</pre></div>
</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-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">check</span><span class="o">-</span><span class="n">dist</span><span class="o">-</span><span class="n">tarball</span> <span class="o">|</span> <span class="n">subunit2pyunit</span>
</pre></div>
</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
<code class="docutils literal notranslate"><span class="pre">BZR_DISABLE_PLUGINS</span></code> or <code class="docutils literal notranslate"><span class="pre">BZR_PLUGIN_PATH=-site</span></code> to disable one or
all plugins.</p>
<p>Until <<a class="reference external" href="http://pad.lv/839461">http://pad.lv/839461</a>> is fixed, you may encounter issues if you
cut a release for old stable branches (<= 2.2) and use a more recent
OS/distro. If that’s the case, check the bug status and use the following
workaround if no fix is available:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>export TTPATH=<local branch of lp:testtools -r 0.9.2>
export SUPATH=<local branch of lp:subunit -r 0.0.6>
PYTHONPATH=$TTPATH:$SUPATH/python PATH=$SUPATH/filters:${PATH} BZR_PLUGIN_PATH=-site make check-dist-tarball PYTHON=python2.6 | subunit2pyunit
</pre></div>
</div>
<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="#id12">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 <<a class="reference external" href="https://launchpad.net/bzr/x.y">https://launchpad.net/bzr/x.y</a>> 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
<code class="docutils literal notranslate"><span class="pre">tools/packaging/lp-upload-release</span></code> 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="kick-off-the-next-cycle">
<h3><a class="toc-backref" href="#id13">Kick off the next cycle</a><a class="headerlink" href="#kick-off-the-next-cycle" title="Permalink to this headline">¶</a></h3>
<p>From that point, there is no possible return, the tarball has been uploaded
so you can relax a bit.</p>
<p>You’re still holding a “social” lock on the launchpad branch though. Until
your start the next cycle, nobody should land anything on this branch. If
they do, they either targeted the wrong branch or didn’t update the news
file correctly, so the sooner the branch is opened again, the better.</p>
<p>This matters more for <code class="docutils literal notranslate"><span class="pre">lp:bzr</span></code> than for <code class="docutils literal notranslate"><span class="pre">lp:bzr/x.y</span></code>, <code class="docutils literal notranslate"><span class="pre">lp:bzr</span></code> should
always be open for landing, so you should do <a class="reference internal" href="#at-the-start-of-a-release-cycle">At the start of a release
cycle</a> as soon as possible (i.e. update the version number in <code class="docutils literal notranslate"><span class="pre">bzr</span></code> and
<code class="docutils literal notranslate"><span class="pre">bzrlib/__init__</span></code>, create/update the news files and create/update the
milestone for the next relase).</p>
<p>You may also need to do <a class="reference internal" href="#at-the-start-of-a-series-cycle">At the start of a series cycle</a> if you’re starting
a new series.</p>
</div>
<div class="section" id="the-final-beta-branching-and-translations">
<h3><a class="toc-backref" href="#id14">The final beta - branching and translations</a><a class="headerlink" href="#the-final-beta-branching-and-translations" title="Permalink to this headline">¶</a></h3>
<p>A word of caution: the instructions above works well for all releases but
there is one special case that requires a bit more care: when you release
the <em>last</em> beta for a given <code class="docutils literal notranslate"><span class="pre">x.y</span></code> series (from trunk aka lp:bzr), you need
to setup <em>two</em> branches for the next cycle:</p>
<ol class="arabic simple">
<li><code class="docutils literal notranslate"><span class="pre">lp:bzr</span></code> needs to be opened for the next <em>series</em> <code class="docutils literal notranslate"><span class="pre">x.(y+1)</span></code>.</li>
<li><code class="docutils literal notranslate"><span class="pre">lp:bzr/x.y</span></code> needs to be opened for the next <em>release</em> <code class="docutils literal notranslate"><span class="pre">x.y.0</span></code> in the
series. Since this is first real use of <code class="docutils literal notranslate"><span class="pre">lp:bzr/x.y</span></code>, this is also the
deadline for the PQM branch to be created.</li>
</ol>
<p>Both are important as <code class="docutils literal notranslate"><span class="pre">lp:bzr</span></code> should remain open so any change can be
landed, <code class="docutils literal notranslate"><span class="pre">lp:bzr/x.y</span></code> on the other hand should be ready to receive bug
fixes.</p>
<p><code class="docutils literal notranslate"><span class="pre">lp:bzr</span></code> is generally more important as the bug fixes on <code class="docutils literal notranslate"><span class="pre">lp:bzr/x.y</span></code>
won’t be released sooner than a month from now whereas people may already
been waiting to land on <code class="docutils literal notranslate"><span class="pre">lp:bzr</span></code>.</p>
<p>In a nutshell:</p>
<ol class="arabic simple">
<li>Open <code class="docutils literal notranslate"><span class="pre">lp:bzr</span></code> for <code class="docutils literal notranslate"><span class="pre">x.(y+1)</span></code></li>
<li>Create or update the <code class="docutils literal notranslate"><span class="pre">x.y</span></code> PQM branch based on whatever revision you
want to release. Since it takes time to create the PQM branch for the new
series you should plan to get it created a few days before you need it
and seed it with the revision from trunk you want to base your release of
(ask a LOSA for pulling this revision from trunk and pushing it to the
series branch (<code class="docutils literal notranslate"><span class="pre">lp:bzr/x.y</span></code>) when you’re ready).</li>
<li>Release <code class="docutils literal notranslate"><span class="pre">x.y.0</span></code> from <code class="docutils literal notranslate"><span class="pre">lp:bzr/x.y</span></code></li>
<li>Open <code class="docutils literal notranslate"><span class="pre">lp:bzr/x.y</span></code> for bug fixes</li>
</ol>
<p>You also need to ensure Launchpad is set up to import/export translations
for the new branch and inform translators.</p>
<ol class="arabic">
<li><p class="first">Push the last beta release to a new branch:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">push</span> <span class="n">lp</span><span class="p">:</span><span class="o">~</span><span class="n">bzr</span><span class="o">-</span><span class="n">core</span><span class="o">/</span><span class="n">bzr</span><span class="o">/</span><span class="n">bzr</span><span class="o">-</span><span class="n">translations</span><span class="o">-</span><span class="n">export</span><span class="o">-</span><span class="n">x</span><span class="o">.</span><span class="n">y</span>
</pre></div>
</div>
</li>
<li><p class="first">On the translations series synchronization settings page
<<a class="reference external" href="https://translations.launchpad.net/bzr/x.y/+translations-settings">https://translations.launchpad.net/bzr/x.y/+translations-settings</a>>
turn on <code class="docutils literal notranslate"><span class="pre">Import</span> <span class="pre">template</span> <span class="pre">files</span></code> then for exports click <code class="docutils literal notranslate"><span class="pre">Choose</span> <span class="pre">a</span>
<span class="pre">target</span> <span class="pre">branch</span></code> and point it at the branch you just pushed.</p>
</li>
<li><p class="first">E-mail translators to announce that the forthcoming stable release of bzr
is ready for translations. Send to
<code class="docutils literal notranslate"><span class="pre">launchpad-translators@lists.launchpad.net</span></code> and
<code class="docutils literal notranslate"><span class="pre">ubuntu-translators@lists.ubuntu.com</span></code>.</p>
</li>
<li><p class="first">The series is now frozen for strings and API, see below for adding
that to the announcement.</p>
</li>
</ol>
</div>
<div class="section" id="announcing-the-source-freeze">
<h3><a class="toc-backref" href="#id15">Announcing the source freeze</a><a class="headerlink" href="#announcing-the-source-freeze" title="Permalink to this headline">¶</a></h3>
<ol class="arabic">
<li><p class="first">Post to the <code class="docutils literal notranslate"><span class="pre">bazaar@lists.canonical.com</span></code> and
<code class="docutils literal notranslate"><span class="pre">bzr-packagers@list.launchpad.net</span></code> lists, saying that the source has
been frozen. 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.</p>
<p>The freeze announcement generally guess the date of the official public
announcement, for the most recent stable series (the one supported by the
installers and most of the distributions) it’s generally a few days after
the freeze. For older series supported only via SRUs for Ubuntu, we don’t
control the process as tightly so guessing the date is not appropriate.</p>
<p>For the final beta release include in your announcement a notice of
API and translation freezes noting that public methods should not
be removed or changed and strings should not be added or changed.</p>
</li>
<li><p class="first">Pause for a few days.</p>
</li>
</ol>
</div>
<div class="section" id="publishing-the-release">
<h3><a class="toc-backref" href="#id16">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 for 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">
<li><p class="first">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>></p>
</li>
<li><p class="first">Announce on the <a class="reference external" href="http://bazaar.canonical.com/">Bazaar website</a>. This
page is edited in <code class="docutils literal notranslate"><span class="pre">build.py</span></code> in the lp:bzr-website branch. (Changes
pushed to this branch are refreshed by a cron job on escudero.)</p>
</li>
<li><p class="first">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 <code class="docutils literal notranslate"><span class="pre">update-bzr-docs</span></code> on
<code class="docutils literal notranslate"><span class="pre">escudero</span></code>. When the first release is created in a new series, a branch
needs to be created on zhongshan:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ssh</span> <span class="n">zhongshan</span><span class="o">.</span><span class="n">canonical</span><span class="o">.</span><span class="n">com</span>
<span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">bzr</span><span class="o">-</span><span class="n">web</span> <span class="o">-</span><span class="n">s</span>
<span class="n">cd</span> <span class="o">/</span><span class="n">srv</span><span class="o">/</span><span class="n">doc</span><span class="o">.</span><span class="n">bazaar</span><span class="o">.</span><span class="n">canonical</span><span class="o">.</span><span class="n">com</span><span class="o">/</span>
<span class="n">bzr</span> <span class="n">branch</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">bazaar</span><span class="o">.</span><span class="n">launchpad</span><span class="o">.</span><span class="n">net</span><span class="o">/~</span><span class="n">bzr</span><span class="o">-</span><span class="n">pqm</span><span class="o">/</span><span class="n">bzr</span><span class="o">/</span><span class="mf">2.6</span> <span class="n">bzr</span><span class="o">/</span><span class="n">bzr</span><span class="o">.</span><span class="mf">2.6</span>
</pre></div>
</div>
<p>And the <code class="docutils literal notranslate"><span class="pre">bzr/bin/update-bzr-docs</span></code> script needs to refer to it.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">lp:bzr-alldocs</span></code> branch also needs to be updated when a new series
is introduced, see the <code class="docutils literal notranslate"><span class="pre">README</span></code> file there for more instructions
(looking at the branch history is also a good way to understand what
needs to be done and to document any policy changes).</p>
</li>
</ol>
</div>
<div class="section" id="announcing-the-release">
<h3><a class="toc-backref" href="#id17">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 beta releases, this is sent to the <code class="docutils literal notranslate"><span class="pre">bazaar@lists.canonical.com</span></code> and
<code class="docutils literal notranslate"><span class="pre">bazaar-announce@lists.canonical.com</span></code> lists.</p>
<p>For stable releases (excluding SRUs which are for older stable releases),
it should also be cc’d to <code class="docutils literal notranslate"><span class="pre">info-gnu@gnu.org</span></code>,
<code class="docutils literal notranslate"><span class="pre">python-announce-list@python.org</span></code>, <code class="docutils literal notranslate"><span class="pre">bug-directory@gnu.org</span></code>.</p>
<p>In all cases, it is good to set <code class="docutils literal notranslate"><span class="pre">Reply-To:</span> <span class="pre">bazaar@lists.canonical.com</span></code>,
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-default notranslate"><div class="highlight"><pre><span></span>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 <http://bazaar.canonical.com/> is a Canonical project and part
of the GNU project <http://gnu.org/> to produce a free operating
system.
<<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>
</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>>
mentioning the milestone URL <<a class="reference external" href="https://launchpad.net/bzr/+milestone/x.y.z">https://launchpad.net/bzr/+milestone/x.y.z</a>>
so people get an easy access to details.</p>
</li>
<li><p class="first">Announce on <a class="reference external" href="https://freecode.com/projects/bazaar-vcs">https://freecode.com/projects/bazaar-vcs</a></p>
<p>This should be done for beta releases and stable releases. If you do not
have a Freecode account yet, ask one of the existing admins.</p>
<p>The purpose here is to point users to the latest stable release
(i.e. SRUs are excluded) while still publishing announcements for beta
releases.</p>
<p>There are several kinds of modifications that could be done there via the
<code class="docutils literal notranslate"><span class="pre">Administration</span></code> 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
<code class="docutils literal notranslate"><span class="pre">Links</span></code> 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, 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 <code class="docutils literal notranslate"><span class="pre">Release</span> <span class="pre">Notes</span></code> URL in
the <code class="docutils literal notranslate"><span class="pre">Links</span></code> box in the upper right area of the page. When doing the
first stable release in a series, delete the <code class="docutils literal notranslate"><span class="pre">Unstable</span> <span class="pre">installers</span></code>
<<a class="reference external" href="https://launchpad.net/bzr/x.y/x.ybn">https://launchpad.net/bzr/x.y/x.ybn</a>> and <code class="docutils literal notranslate"><span class="pre">Unstable</span> <span class="pre">source</span> <span class="pre">tarball</span></code>
<<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>
</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 the stable and beta releases.</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-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="n">setup</span><span class="o">.</span><span class="n">py</span> <span class="n">register</span>
</pre></div>
</div>
<p>Remember to check the results afterward – this should be done for
stable releases but not for beta releases nor SRUs.</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="#id18">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 <code class="docutils literal notranslate"><span class="pre">doc/en/release-notes</span></code>
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 <code class="docutils literal notranslate"><span class="pre">bzr</span></code> and
<code class="docutils literal notranslate"><span class="pre">bzrlib/__init__.py</span></code>. 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 <a class="reference internal" href="#at-the-start-of-a-series-cycle">At the start of a series cycle</a> and follow the
instructions from there.</p>
</div>
<div class="section" id="releases-until-the-final-one">
<h3><a class="toc-backref" href="#id19">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, you’re not finished
yet. Another beta or hopefully a stable 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 and stable 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="#id20">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 <code class="docutils literal notranslate"><span class="pre">-updates</span></code> 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>Since September 2010, bzr has received approval by the technical
board for 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>Progress on these realeases is tracked on the <a class="reference external" href="http://wiki.bazaar.canonical.com/UbuntuStableReleaseUpdates">SRU wiki</a>
page.</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 <code class="docutils literal notranslate"><span class="pre">Also</span> <span class="pre">affects</span> <span class="pre">distribution</span></code> button and
select <code class="docutils literal notranslate"><span class="pre">bzr</span> <span class="pre">(Ubuntu)</span></code>.</li>
<li>change the <em>URL</em> to point to <code class="docutils literal notranslate"><span class="pre">ubuntu/+source/bzr</span></code> instead of <code class="docutils literal notranslate"><span class="pre">bzr</span></code>
(this is needed if you create the distro task but not if it exists
already). You should now be able to click the <code class="docutils literal notranslate"><span class="pre">Nominate</span> <span class="pre">for</span> <span class="pre">release</span></code>
button and select the right Ubuntu release. As of September 2010, this
means:</li>
</ul>
<blockquote>
<div><ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">quantal</span></code> for the 2.6 series,</li>
<li><code class="docutils literal notranslate"><span class="pre">precise</span></code> for the 2.5 series,</li>
<li><code class="docutils literal notranslate"><span class="pre">oneiric</span></code> for the 2.4 series,</li>
<li><code class="docutils literal notranslate"><span class="pre">natty</span></code> for the 2.3 series,</li>
<li><code class="docutils literal notranslate"><span class="pre">maverick</span></code> for the 2.2 series,</li>
<li><code class="docutils literal notranslate"><span class="pre">lucid</span></code> for the 2.1 series,</li>
</ul>
</div></blockquote>
<ul class="simple">
<li>Subscribe the <code class="docutils literal notranslate"><span class="pre">~ubuntu-sru</span></code> team to the bug.</li>
<li>Add a comment targeted to <code class="docutils literal notranslate"><span class="pre">~ubuntu-sru</span></code> 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 <code class="docutils literal notranslate"><span class="pre">sru</span></code> 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="#id21">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" role="navigation" aria-label="main navigation">
<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="#what-do-we-release">What do we release</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-series-cycle">At the start of a series cycle</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="#kick-off-the-next-cycle">Kick off the next cycle</a></li>
<li><a class="reference internal" href="#the-final-beta-branching-and-translations">The final beta - branching and translations</a></li>
<li><a class="reference internal" href="#announcing-the-source-freeze">Announcing the source freeze</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>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/releasing.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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 class="nav-item nav-item-0"><a href="index.html">Developer Document Catalog (2.7.0)</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2011 Canonical Ltd.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
</div>
</body>
</html>
