Browse Source

Prepare for release

release/2023.4.0
Maurice Makaay 1 year ago
parent
commit
624d63c8bb
5 changed files with 20 additions and 8 deletions
  1. +4
    -1
      CHANGELOG.md
  2. +1
    -1
      README.md
  3. +2
    -2
      components/xiaomi_bslamp2/__init__.py
  4. +1
    -1
      doc/installation.md
  5. +12
    -3
      doc/release_plan.md

+ 4
- 1
CHANGELOG.md View File

@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [next release]
## [2023.4.0]
**Note**: This release requires ESPHome 2023.4.0 and Home Assistant 2021.8.0 or newer.
### Fixed ### Fixed
- Compile issues with recent ESPHome versions fixed: - Compile issues with recent ESPHome versions fixed:
@ -13,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- On systems for which the above toolchain could be found, compilation would fail - On systems for which the above toolchain could be found, compilation would fail
with an error about `esp_mac.h` not being found. with an error about `esp_mac.h` not being found.
### Changed
- ESPHome's compile-time warnings about "GPIO<x> is a Strapping PIN and should - ESPHome's compile-time warnings about "GPIO<x> is a Strapping PIN and should
be avoided" are now being suppressed. These warning are often interpreted be avoided" are now being suppressed. These warning are often interpreted
by users of this firmware as problems. However, the pinouts are dictated by by users of this firmware as problems. However, the pinouts are dictated by


+ 1
- 1
README.md View File

@ -49,7 +49,7 @@ aspect of the lamp and to integrate the lamp in your Home Assistant setup.
For those who have experience with flashing ESPHome onto devices: For those who have experience with flashing ESPHome onto devices:
* Make sure you are using ESPHome 2022.12.0 or newer.
* Make sure you are using ESPHome 2023.4.0 or newer.
* Copy [`example.yaml`](example.yaml) to `<CONFIG_DIR>/<NODE_NAME>.yaml`. * Copy [`example.yaml`](example.yaml) to `<CONFIG_DIR>/<NODE_NAME>.yaml`.
* Modify the configuration to your needs (see the [configuration guide](doc/configuration.md)). * Modify the configuration to your needs (see the [configuration guide](doc/configuration.md)).
* Compile the `firmware.bin` file and download it to the device to which you have connected your * Compile the `firmware.bin` file and download it to the device to which you have connected your


+ 2
- 2
components/xiaomi_bslamp2/__init__.py View File

@ -46,10 +46,10 @@ FRONT_PANEL_LED_OPTIONS = {
def check_version_compatibility(config): def check_version_compatibility(config):
esphome_version = parse_esphome_version() esphome_version = parse_esphome_version()
if esphome_version < (2022, 12, 0):
if esphome_version < (2023, 4, 0):
raise Invalid( raise Invalid(
"This xiaomi_bslamp2 component requires at least ESPHome " + "This xiaomi_bslamp2 component requires at least ESPHome " +
"version 2022.12.0; Please upgrade ESPHome and try again."
"version 2023.4.0; Please upgrade ESPHome and try again."
) )
return config return config


+ 1
- 1
doc/installation.md View File

@ -2,7 +2,7 @@
# Installation guide # Installation guide
The code must be compiled into a firmware using ESPHome 2022.12.0 or later. Therefore, a prerequisite
The code must be compiled into a firmware using ESPHome 2023.4.0 or later. Therefore, a prerequisite
is that you have ESPHome up and running in some form (command line, docker container, web dashboard, is that you have ESPHome up and running in some form (command line, docker container, web dashboard,
possibly from within Home Assistant as an add-on). For information on this, please refer to the possibly from within Home Assistant as an add-on). For information on this, please refer to the
documentation on the [ESPHome website](https://esphome.io). documentation on the [ESPHome website](https://esphome.io).


+ 12
- 3
doc/release_plan.md View File

@ -1,7 +1,11 @@
# Release plan # Release plan
All development is done in the `dev` branch. Once the development branch is
ready for a new production release, the following steps are followed:
**All development is done in the `dev` branch**
$ git checkout dev
Once the development branch is ready for a new production release, the following
steps are followed:
**Update the CHANGELOG.md** **Update the CHANGELOG.md**
@ -19,11 +23,16 @@ The minimum ESPHome version requirement must be documented correctly in the foll
to check the maximum version of ESPHome that can be used. An example to check the maximum version of ESPHome that can be used. An example
of this use can be found in the `release/2021.10.0` branch. of this use can be found in the `release/2021.10.0` branch.
**Push the dev changes to GitHub**
$ git add ...
$ git commit -m "Prepare for release"
$ git push
**Create version release branch** **Create version release branch**
Branch `dev` to a `release/<version>` branch, e.g. `release/2021.10.0`. Branch `dev` to a `release/<version>` branch, e.g. `release/2021.10.0`.
``` ```
$ git checkout dev
$ git checkout -b release/2021.10.0 $ git checkout -b release/2021.10.0
``` ```


Loading…
Cancel
Save