From 624d63c8bb5a0e4b8afdf43e3d3bb90e925659b2 Mon Sep 17 00:00:00 2001 From: Maurice Makaay Date: Tue, 9 May 2023 11:35:31 +0200 Subject: [PATCH] Prepare for release --- CHANGELOG.md | 5 ++++- README.md | 2 +- components/xiaomi_bslamp2/__init__.py | 4 ++-- doc/installation.md | 2 +- doc/release_plan.md | 15 ++++++++++++--- 5 files changed, 20 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7577221..643d5a7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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/), 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 - 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 with an error about `esp_mac.h` not being found. +### Changed - ESPHome's compile-time warnings about "GPIO is a Strapping PIN and should be avoided" are now being suppressed. These warning are often interpreted by users of this firmware as problems. However, the pinouts are dictated by diff --git a/README.md b/README.md index 9d4f7e4..37548cd 100644 --- a/README.md +++ b/README.md @@ -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: -* 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 `/.yaml`. * 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 diff --git a/components/xiaomi_bslamp2/__init__.py b/components/xiaomi_bslamp2/__init__.py index 913d633..64ed1a5 100644 --- a/components/xiaomi_bslamp2/__init__.py +++ b/components/xiaomi_bslamp2/__init__.py @@ -46,10 +46,10 @@ FRONT_PANEL_LED_OPTIONS = { def check_version_compatibility(config): esphome_version = parse_esphome_version() - if esphome_version < (2022, 12, 0): + if esphome_version < (2023, 4, 0): raise Invalid( "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 diff --git a/doc/installation.md b/doc/installation.md index 8d8977a..ee8f429 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -2,7 +2,7 @@ # 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, 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). diff --git a/doc/release_plan.md b/doc/release_plan.md index 453316a..2e8283e 100644 --- a/doc/release_plan.md +++ b/doc/release_plan.md @@ -1,7 +1,11 @@ # 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** @@ -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 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** Branch `dev` to a `release/` branch, e.g. `release/2021.10.0`. ``` -$ git checkout dev $ git checkout -b release/2021.10.0 ```