Skip to content

Commit 90d07e2

Browse files
committed
Update instructions
1 parent 0f280c1 commit 90d07e2

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

source/developers/releasing.markdown

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,37 +9,45 @@ sharing: true
99
footer: true
1010
---
1111

12-
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.
12+
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. The [hass-release](https://github.com/home-assistant/hass-release) script is a helper to do a release.
1313

14-
### {% linkable_title GitHub (3 days before release) %}
14+
### {% linkable_title Release preparation (3 days before release) %}
15+
16+
### {% linkable_title GitHub %}
1517

1618
1. Merge `master` into `dev` to make the PR mergeable.
17-
2. Cut a release branch from `dev`. Example name `release-0-49`.
18-
3. 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](https://github.com/home-assistant/hass-release) to collect the details.
19+
2. Cut a release branch from `dev`. Example name `release-0-57`.
20+
3. Create a pull request from the release branch to `master` with the upcoming release number as the title.
1921
4. Update `homeassistant/const.py` with the correct version number (remove the `dev` tag) and push that commit to release branch.
20-
5. From now until the release branch has been merged, we tag bugfixes with the milestone for the release (create if doesn't exist).
21-
4. Update `homeassistant/const.py` with the upcoming version number (including the `dev` tag) and push that commit to the `dev` branch.
2222

23-
### {% linkable_title Website (3 days before release) %}
23+
### {% linkable_title Website %}
2424

2525
1. Merge `current` into `next`
26-
2. Cut release branch of `next`. For example `release-0-49`.
26+
2. Cut release branch of `next`. For example `release-0-57`.
2727
3. Open a PR from release branch to `current` with the upcoming release number as the title.
2828

29+
## {% linkable_title Release day %}
30+
31+
From creating the release branch till it has been merged, we tag bugfixes with the milestone for the release (create if doesn't exist).
32+
2933
### {% linkable_title GitHub %}
3034

31-
1. Merge pull request (DO NOT SQUASH!).
32-
2. Go to [releases](https://github.com/home-assistant/home-assistant/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.
33-
3. Merge `master` into `dev`.
35+
1. Cherry-pick the milestoned PRs that need to get into the release `python3 -m hassrelease milestone_cherry_pick 0.57`
36+
2. Run `python3 -m hassrelease release_notes 0.56` for the release notes.
37+
3. Once the release notes has been generated, issue `python3 -m hassrelease milestone_close 0.56`
38+
4. Merge pull request (DO NOT SQUASH!). Use `Merge pull request`.
39+
5. Go to [releases](https://github.com/home-assistant/home-assistant/releases), click `Draft a new release` 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.
40+
6. Merge `master` into `dev`.
41+
7. Update `homeassistant/const.py` with the upcoming version number (including the `dev` tag) and push that commit to the `dev` branch.
3442

3543
### {% linkable_title Website %}
3644

3745
1. 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.
3846
2. Create missing documentation as stubs.
39-
3. Update `_config.yml` with link to the new release blog post and version number (at the bottom of the file).
40-
4. Merge `current` into release branch (`$ git checkout release-0-40 && git merge current`) to make the PR mergeable.
41-
5. Merge pull request (blog post, updated frontpage, and all new documentation) to `current`. DO NOT SQUASH!
42-
6. Run `credits_generator`.
47+
3. Run `credits_generator`.
48+
4. Update `_config.yml` with a link to the new release blog post and version number (at the bottom of the file).
49+
5. Merge `current` into release branch (`$ git checkout release-0-40 && git merge current`) to make the PR mergeable.
50+
6. Merge pull request (blog post, updated frontpage, and all new documentation) to `current`. DO NOT SQUASH!
4351
7. Merge `current` into `next`.
4452

4553
### {% linkable_title Docker Hub %}

0 commit comments

Comments
 (0)