diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index daa022a1..92616f87 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -2,20 +2,16 @@ ## Summary -This breaking release removes deprecated compatibility modules and symbols, and implicit enum conversions. + ## Upgrading -> [!NOTE] -> We recommend upgrading first to v0.3.8 and remove all deprecation warnings (and implicit conversions of enum values to protobuf messages) before upgrading to v0.4.0. -> -> By doing so you'll be guided by the deprecation warnings and when you are done, upgrading to v0.4.0 should imply not extra work. - -* Passing enum values directly to build protobuf messages is not longer supported, you need to call the conversion functions `xxx_(from|to)_proto_v1alpha8()` explicitly. -* Replace `frequenz.client.common.metric.Metric` with `frequenz.client.common.metrics.Metric`. -* Replace `frequenz.client.common.microgrid.components` imports with `frequenz.client.common.microgrid.electrical_components` imports. -* Replace `frequenz.client.common.enum_proto.enum_from_proto` with `frequenz.client.common.proto.enum_from_proto`. -* Replace `frequenz.client.common.metrics.proto` conversion imports with `frequenz.client.common.metrics.proto.v1alpha8` imports. -* Replace `PaginationInfo.from_proto()`, `PaginationInfo.to_proto()`, and `PaginationInfo.to_proto_v1alpha8()` with `frequenz.client.common.pagination.proto.v1alpha8` conversion functions. -* Replace `frequenz.client.common.pagination.Info` with `frequenz.client.common.pagination.PaginationInfo`. -* Use API-provided `v1alpha8` pagination protobuf messages directly instead of `frequenz.client.common.pagination.Params`. + + +## New Features + + + +## Bug Fixes + +