Skip to content

Clear release notes #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
llucax merged 1 commit into from
Nov 26, 2025
Merged

Clear release notes #129

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,16 @@

## Summary

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).
<!-- Here goes a general summary of what this release is about -->

## Deprecations
## Upgrading

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

## New Features

- New `frequenz.client.common.common.proto` module with conversion utilities for protobuf types:
- `enum_from_proto()` (moved from `enum_proto).
- `datetime_to_proto()` and `datetime_from_proto()` functions to convert between Python `datetime` and protobuf `Timestamp` (imported from `frequenz-client-base`.
- New `metrics` package compatible with API v0.8, which includes:
- `Metric` enum with all supported metrics.
- `MetricSample` dataclass to represent metric samples.
- `AggregatedMetricValue` dataclass to represent derived statistical summaries.
- `Bounds` dataclass to represent bounds for metrics.
- `MetricConnection` and `MetricConnectionCategory` to represent connections from which metrics are obtained.
- `proto` submodule with conversion functions to/from protobuf types.
<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

<!-- Here goes notable bug fixes that are worth a special mention or explanation -->