Releasing
This page describes the steps for publishing a new Home Assistant release. Those steps requires that you don’t use forks but work with the repositories themself.
GitHub (3 days before release)
- Merge
master
intodev
to make the PR mergeable. - Cut a release branch from
dev
. Example namerelease-0-49
. - Create a pull request from the release branch to
master
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 hass-release to collect the details. - Update
homeassistant/const.py
with the correct version number (remove thedev
tag) and push that commit to release branch. - From now until the release branch has been merged, we tag bugfixes with the milestone for the release (create if doesn’t exist).
- Update
homeassistant/const.py
with the upcoming version number (including thedev
tag) and push that commit to thedev
branch.
Website (3 days before release)
- Merge
current
intonext
- Cut release branch of
next
. For examplerelease-0-49
. - Open a PR from release branch to
current
with the upcoming release number as the title.
GitHub
- Merge pull request (DO NOT SQUASH!).
- Go to releases and tag a new release on the
master
branch. “Tag version” and “Release title” are the version number (O.x
for major version,0.x.y
for minor and bug fix releases). Release description is the text from PR. Press “Publish release” to finish the process. - Merge
master
intodev
.
Website
- 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.
- Create missing documentation as stubs.
- Update
config.yml
with link to the new release blog post and version number (at the bottom of the file). - Merge
current
into release branch ($ git checkout release-0-40 && git merge current
) to make the PR mergeable. - Merge pull request (blog post, updated frontpage, and all new documentation) to
current
. DO NOT SQUASH! - Run
credits_generator
. - Merge
current
intonext
.
Docker Hub
Tags on Docker hub are automatically created when a release has been created on GitHub.
Python Package Index
Checkout the master
branch and run script/release
to publish the new release on Python Package Index.
Social media
- Use hootsuite to publish a link to the release post on social media.