From 667a2e734ec6e2b11a5d127f2017e972fa72eed4 Mon Sep 17 00:00:00 2001 From: Leandro Lucarella Date: Wed, 18 Sep 2024 09:26:20 +0200 Subject: [PATCH 1/2] Clear release notes Signed-off-by: Leandro Lucarella --- RELEASE_NOTES.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 93883679..288ad8af 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,5 +1,17 @@ # Frequenz Microgrid API Release Notes +## Summary + + + +## Upgrading + + + +## New Features + + + ## Bug Fixes -- Fix a dependency issue by pinning the `grpcio` version and related libraries. + From 48696264e1614bb3f1835364210cf6a928cd4eef Mon Sep 17 00:00:00 2001 From: Leandro Lucarella Date: Wed, 18 Sep 2024 09:22:40 +0200 Subject: [PATCH 2/2] Bump the `protobuf` and `grpcio` versions The `protobuf` version 4.25.x will go out of support soon(ish), on 31 Mar 2025. Since we don't need to keep compatibility to any legacy code, we can bump it in advance as a preparation. The `googleapis-common-protos` version was also bumped to 1.65.0, as the previous version was too old to work with the new `protobuf` version. https://protobuf.dev/support/version-support/#python Signed-off-by: Leandro Lucarella --- RELEASE_NOTES.md | 2 +- pyproject.toml | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 288ad8af..bf156532 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -6,7 +6,7 @@ ## Upgrading - +- The minimum supported version of `protobuf` was bumped to 5.28.1 and to 1.66.1 for `grpcio`. Make sure to update your dependencies accordingly. ## New Features diff --git a/pyproject.toml b/pyproject.toml index 7daac650..e8c91291 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,9 +10,9 @@ requires = [ # sure the code is generated using the minimum supported versions, as older # versions can't work with code that was generated with newer versions. # https://protobuf.dev/support/cross-version-runtime-guarantee/#backwards - "protobuf == 4.25.3", - "grpcio-tools == 1.51.1", - "grpcio == 1.51.1", + "protobuf == 5.28.1", + "grpcio-tools == 1.66.1", + "grpcio == 1.66.1", ] build-backend = "setuptools.build_meta" @@ -34,14 +34,14 @@ classifiers = [ requires-python = ">= 3.11, < 4" dependencies = [ "frequenz-api-common >= 0.6.2, < 0.7", - "googleapis-common-protos >= 1.56.4, < 2", + "googleapis-common-protos >= 1.65.0, < 2", # We can't widen beyond 6 because of protobuf cross-version runtime guarantees # https://protobuf.dev/support/cross-version-runtime-guarantee/#major - "protobuf >= 4.25.3, < 6", # Do not widen beyond 6! + "protobuf >= 5.28.1, < 7", # Do not widen beyond 7! # We couldn't find any document with a spec about the cross-version runtime # guarantee for grpcio, so unless we find one in the future, we'll assume # major version jumps are not compatible - "grpcio >= 1.51.1, < 2", # Do not widen beyond 2! + "grpcio >= 1.66.1, < 2", # Do not widen beyond 2! ] dynamic = ["version"]