Skip to content

Commit e3c0feb

Browse files
authored
Clear release notes (#129)
2 parents 7bdac82 + dbc4302 commit e3c0feb

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

RELEASE_NOTES.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,16 @@
22

33
## Summary
44

5-
This release main change is the introduction of a new `metrics` package compatible with the common API v0.8 (`v1alpha8`) (the old `metric` package, in singular, still works with the old v0.5/`v1` version).
5+
<!-- Here goes a general summary of what this release is about -->
66

7-
## Deprecations
7+
## Upgrading
88

9-
- The old `frequenz.client.common.enum_proto` module is now deprecated, please use `frequenz.client.common.proto.enum_from_proto` instead.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1010

1111
## New Features
1212

13-
- New `frequenz.client.common.common.proto` module with conversion utilities for protobuf types:
14-
- `enum_from_proto()` (moved from `enum_proto).
15-
- `datetime_to_proto()` and `datetime_from_proto()` functions to convert between Python `datetime` and protobuf `Timestamp` (imported from `frequenz-client-base`.
16-
- New `metrics` package compatible with API v0.8, which includes:
17-
- `Metric` enum with all supported metrics.
18-
- `MetricSample` dataclass to represent metric samples.
19-
- `AggregatedMetricValue` dataclass to represent derived statistical summaries.
20-
- `Bounds` dataclass to represent bounds for metrics.
21-
- `MetricConnection` and `MetricConnectionCategory` to represent connections from which metrics are obtained.
22-
- `proto` submodule with conversion functions to/from protobuf types.
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)