Skip to content

Commit 9db970d

Browse files
authored
Clear release notes (#201)
2 parents cef0ee2 + 00673ac commit 9db970d

1 file changed

Lines changed: 10 additions & 14 deletions

File tree

RELEASE_NOTES.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,16 @@
22

33
## Summary
44

5-
This breaking release removes deprecated compatibility modules and symbols, and implicit enum conversions.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9-
> [!NOTE]
10-
> 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.
11-
>
12-
> 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.
13-
14-
* 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.
15-
* Replace `frequenz.client.common.metric.Metric` with `frequenz.client.common.metrics.Metric`.
16-
* Replace `frequenz.client.common.microgrid.components` imports with `frequenz.client.common.microgrid.electrical_components` imports.
17-
* Replace `frequenz.client.common.enum_proto.enum_from_proto` with `frequenz.client.common.proto.enum_from_proto`.
18-
* Replace `frequenz.client.common.metrics.proto` conversion imports with `frequenz.client.common.metrics.proto.v1alpha8` imports.
19-
* Replace `PaginationInfo.from_proto()`, `PaginationInfo.to_proto()`, and `PaginationInfo.to_proto_v1alpha8()` with `frequenz.client.common.pagination.proto.v1alpha8` conversion functions.
20-
* Replace `frequenz.client.common.pagination.Info` with `frequenz.client.common.pagination.PaginationInfo`.
21-
* Use API-provided `v1alpha8` pagination protobuf messages directly instead of `frequenz.client.common.pagination.Params`.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10+
11+
## New Features
12+
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
14+
15+
## Bug Fixes
16+
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)