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.

39 lines
1.2 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. * components/xiaomi_bslamp2/__init__.py in the CONFIG_SCHEMA
  12. (cv.require_esphome_version(YEAR, MONTH, PATHLEVEL))
  13. **Create version release branch**
  14. Branch `dev` to a `release/<version>` branch, e.g. `release/2021.10.0`.
  15. ```
  16. $ git checkout dev
  17. $ git checkout -b release/2021.10.0
  18. ```
  19. **Update project version information**
  20. The version of this project (e.g. `2021.10.0`) must be updated in:
  21. * `example.yaml` (the `ref:` for the bslamp2 configuration package)
  22. * `packages/core.yaml` (the `ref:` for the external component)
  23. **Push the release to GitHub**
  24. ```
  25. $ git push --set-upstream origin release/2021.10.0
  26. ```