You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

37 lines
1.0 KiB

  1. # Release plan
  2. All development is done in the `dev` branch. Once the development branch is
  3. ready for a new production release, the following steps are followed:
  4. **Update the CHANGELOG.md**
  5. Make sure all notable changes are recorded in the changelog.
  6. **Update ESPHome version information**
  7. The minimum ESPHome version requirement must be documented correctly in the following files:
  8. * doc/installation.md (at the start of the file)
  9. * README.md (at the start of the quick start guide)
  10. * CHANGELOG.md (at the start of the log for the released version)
  11. **Create version release branch**
  12. Branch `dev` to a `release/<version>` branch, e.g. `release/2021.10.0`.
  13. ```
  14. $ git checkout dev
  15. $ git checkout -b release/2021.10.0
  16. ```
  17. **Update project version information**
  18. The version of this project (e.g. `2021.10.0`) must be updated in:
  19. * `example.yaml` (the `ref:` for the bslamp2 configuration package)
  20. * `packages/core.yaml` (the `ref:` for the external component)
  21. **Push the release to GitHub**
  22. ```
  23. $ git push --set-upstream origin release/2021.10.0
  24. ```