Document considerations when changing recommended framework version (#1822)

This commit is contained in:
Otto Winter 2021-05-23 23:24:00 +02:00 committed by GitHub
parent b11d5f6799
commit b92702a312
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -69,6 +69,13 @@ validate_platform = cv.one_of(*ESP_PLATFORMS, upper=True)
PLATFORMIO_ESP8266_LUT = { PLATFORMIO_ESP8266_LUT = {
**ARDUINO_VERSION_ESP8266, **ARDUINO_VERSION_ESP8266,
# Keep this in mind when updating the recommended version:
# * New framework historically have had some regressions, especially for WiFi, BLE and the
# bootloader system. The new version needs to be thoroughly validated before changing the
# recommended version as otherwise a bunch of devices could be bricked
# * The docker images need to be updated to ship the new recommended version, in order not
# to DDoS platformio servers.
# Update this file: https://github.com/esphome/esphome-docker-base/blob/master/platformio.ini
"RECOMMENDED": ARDUINO_VERSION_ESP8266["2.7.4"], "RECOMMENDED": ARDUINO_VERSION_ESP8266["2.7.4"],
"LATEST": "espressif8266", "LATEST": "espressif8266",
"DEV": ARDUINO_VERSION_ESP8266["dev"], "DEV": ARDUINO_VERSION_ESP8266["dev"],
@ -76,6 +83,7 @@ PLATFORMIO_ESP8266_LUT = {
PLATFORMIO_ESP32_LUT = { PLATFORMIO_ESP32_LUT = {
**ARDUINO_VERSION_ESP32, **ARDUINO_VERSION_ESP32,
# See PLATFORMIO_ESP8266_LUT for considerations when changing the recommended version
"RECOMMENDED": ARDUINO_VERSION_ESP32["1.0.6"], "RECOMMENDED": ARDUINO_VERSION_ESP32["1.0.6"],
"LATEST": "espressif32", "LATEST": "espressif32",
"DEV": ARDUINO_VERSION_ESP32["dev"], "DEV": ARDUINO_VERSION_ESP32["dev"],