Skip to content
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

Clear release notes #312

Merged
merged 1 commit into from
Jul 9, 2024
Merged

Clear release notes #312

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
14 changes: 8 additions & 6 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

## Summary

In addition to the new `LatestValueCache` and the ability to `filter` messages on `Receiver`s, this release introduces two "Experimental" features for providing interconnections between channels.
<!-- Here goes a general summary of what this release is about -->

## New Features
## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

- The `LatestValueCache` class, which used to be internal to the Frequenz SDK, is now available through the channels package.
## New Features

- **Experimental**: `RelaySender`, which is a `Sender` that forwards the messages sent to it, to multiple senders.
<!-- Here goes the main new features and examples or instructions on how to use them -->

- **Experimental**: `Pipe`, which provides a pipe between two channels, by connecting a `Receiver` to a `Sender`.
## Bug Fixes

- `Receiver`s now have a `filter` method that applies a filter function on the messages on a receiver.
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->