Site updated at 2017-10-22 00:19:47 UTC

This commit is contained in:
Travis CI 2017-10-22 00:19:47 +00:00
parent a6fbc15960
commit 978618bdaa
207 changed files with 301 additions and 296 deletions

View file

@ -74,36 +74,41 @@
</h1>
</header>
<hr class="divider">
<p>This page describes the steps for publishing a new Home Assistant release. Those steps requires that you dont use forks but work with the repositories themself.</p>
<h3><a class="title-link" name="github-3-days-before-release" href="#github-3-days-before-release"></a> GitHub (3 days before release)</h3>
<ol>
<li>Merge <code class="highlighter-rouge">master</code> into <code class="highlighter-rouge">dev</code> to make the PR mergeable.</li>
<li>Cut a release branch from <code class="highlighter-rouge">dev</code>. Example name <code class="highlighter-rouge">release-0-49</code>.</li>
<li>Create a pull request from the release branch to <code class="highlighter-rouge">master</code> with the upcoming release number as the title. PR message contains intro, highlighting major changes, and an overview of all changes tagging each author. Use <a href="https://github.com/home-assistant/hass-release">hass-release</a> to collect the details.</li>
<li>Update <code class="highlighter-rouge">homeassistant/const.py</code> with the correct version number (remove the <code class="highlighter-rouge">dev</code> tag) and push that commit to release branch.</li>
<li>From now until the release branch has been merged, we tag bugfixes with the milestone for the release (create if doesnt exist).</li>
<li>Update <code class="highlighter-rouge">homeassistant/const.py</code> with the upcoming version number (including the <code class="highlighter-rouge">dev</code> tag) and push that commit to the <code class="highlighter-rouge">dev</code> branch.</li>
</ol>
<h3><a class="title-link" name="website-3-days-before-release" href="#website-3-days-before-release"></a> Website (3 days before release)</h3>
<ol>
<li>Merge <code class="highlighter-rouge">current</code> into <code class="highlighter-rouge">next</code></li>
<li>Cut release branch of <code class="highlighter-rouge">next</code>. For example <code class="highlighter-rouge">release-0-49</code>.</li>
<li>Open a PR from release branch to <code class="highlighter-rouge">current</code> with the upcoming release number as the title.</li>
</ol>
<p>This page describes the steps for publishing a new Home Assistant release. Those steps requires that you dont use forks but work with the repositories themself. The <a href="https://github.com/home-assistant/hass-release">hass-release</a> script is a helper to do a release.</p>
<h3><a class="title-link" name="release-preparation-3-days-before-release" href="#release-preparation-3-days-before-release"></a> Release preparation (3 days before release)</h3>
<h3><a class="title-link" name="github" href="#github"></a> GitHub</h3>
<ol>
<li>Merge pull request (DO NOT SQUASH!).</li>
<li>Go to <a href="https://github.com/home-assistant/home-assistant/releases">releases</a> and tag a new release on the <code class="highlighter-rouge">master</code> branch. “Tag version” and “Release title” are the version number (<code class="highlighter-rouge">O.x</code> for major version, <code class="highlighter-rouge">0.x.y</code> for minor and bug fix releases). Release description is the text from PR. Press “Publish release” to finish the process.</li>
<li>Merge <code class="highlighter-rouge">master</code> into <code class="highlighter-rouge">dev</code> to make the PR mergeable.</li>
<li>Cut a release branch from <code class="highlighter-rouge">dev</code>. Example name <code class="highlighter-rouge">release-0-57</code>.</li>
<li>Create a pull request from the release branch to <code class="highlighter-rouge">master</code> with the upcoming release number as the title.</li>
<li>Update <code class="highlighter-rouge">homeassistant/const.py</code> with the correct version number (remove the <code class="highlighter-rouge">dev</code> tag) and push that commit to release branch.</li>
</ol>
<h3><a class="title-link" name="website" href="#website"></a> Website</h3>
<ol>
<li>Merge <code class="highlighter-rouge">current</code> into <code class="highlighter-rouge">next</code></li>
<li>Cut release branch of <code class="highlighter-rouge">next</code>. For example <code class="highlighter-rouge">release-0-57</code>.</li>
<li>Open a PR from release branch to <code class="highlighter-rouge">current</code> with the upcoming release number as the title.</li>
</ol>
<h2><a class="title-link" name="release-day" href="#release-day"></a> Release day</h2>
<p>From creating the release branch till it has been merged, we tag bugfixes with the milestone for the release (create if doesnt exist).</p>
<h3><a class="title-link" name="github" href="#github"></a> GitHub</h3>
<ol>
<li>Cherry-pick the milestoned PRs that need to get into the release <code class="highlighter-rouge">python3 -m hassrelease milestone_cherry_pick 0.57</code></li>
<li>Run <code class="highlighter-rouge">python3 -m hassrelease release_notes 0.56</code> for the release notes.</li>
<li>Once the release notes has been generated, issue <code class="highlighter-rouge">python3 -m hassrelease milestone_close 0.56</code></li>
<li>Merge pull request (DO NOT SQUASH!). Use <code class="highlighter-rouge">Merge pull request</code>.</li>
<li>Go to <a href="https://github.com/home-assistant/home-assistant/releases">releases</a>, click <code class="highlighter-rouge">Draft a new release</code> and tag a new release on the <code class="highlighter-rouge">master</code> branch. “Tag version” and “Release title” are the version number (<code class="highlighter-rouge">O.x</code> for major version, <code class="highlighter-rouge">0.x.y</code> for minor and bug fix releases). Release description is the text from PR. Press “Publish release” to finish the process.</li>
<li>Merge <code class="highlighter-rouge">master</code> into <code class="highlighter-rouge">dev</code>.</li>
<li>Update <code class="highlighter-rouge">homeassistant/const.py</code> with the upcoming version number (including the <code class="highlighter-rouge">dev</code> tag) and push that commit to the <code class="highlighter-rouge">dev</code> branch.</li>
</ol>
<h3><a class="title-link" name="website" href="#website"></a> Website</h3>
<ol>
<li>Create a blog post in the release branch and base it on the text of the PR in the main repository. Add images, additional text, links, etc. if it adds value. Tag each platform/component in a message to documentation.</li>
<li>Create missing documentation as stubs.</li>
<li>Update <code class="highlighter-rouge">_config.yml</code> with link to the new release blog post and version number (at the bottom of the file).</li>
<li>Run <code class="highlighter-rouge">credits_generator</code>.</li>
<li>Update <code class="highlighter-rouge">_config.yml</code> with a link to the new release blog post and version number (at the bottom of the file).</li>
<li>Merge <code class="highlighter-rouge">current</code> into release branch (<code class="highlighter-rouge">$ git checkout release-0-40 &amp;&amp; git merge current</code>) to make the PR mergeable.</li>
<li>Merge pull request (blog post, updated frontpage, and all new documentation) to <code class="highlighter-rouge">current</code>. DO NOT SQUASH!</li>
<li>Run <code class="highlighter-rouge">credits_generator</code>.</li>
<li>Merge <code class="highlighter-rouge">current</code> into <code class="highlighter-rouge">next</code>.</li>
</ol>
<h3><a class="title-link" name="docker-hub" href="#docker-hub"></a> Docker Hub</h3>