Skip to content

Commit 8350f20

Browse files
committed
Update release notes
Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent b46d35a commit 8350f20

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

RELEASE_NOTES.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,22 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release introduces a more flexible and powerful mechanism for managing dispatch events with new strategies for merging intervals, enhanced customization options, and better overall alignment with evolving SDK dependencies. It also simplifies actor initialization while maintaining robust support for diverse dispatch scenarios.
66

77
## Upgrading
88

99
* Two properties have been replaced by methods that require a type as parameter.
1010
* `Dispatcher.lifecycle_events` has been replaced by the method `Dispatcher.new_lifecycle_events_receiver(self, dispatch_type: str)`.
1111
* `Dispatcher.running_status_change` has been replaced by the method `Dispatcher.new_running_state_event_receiver(self, dispatch_type: str, unify_running_intervals: bool)`.
1212
* The managing actor constructor no longer requires the `dispatch_type` parameter. Instead you're expected to pass the type to the new-receiver function.
13+
* The `DispatchManagingActor` class has been renamed to `DispatchActorsService`.
14+
* It's interface has been simplified and now only requires an actor factory and a running status receiver.
15+
* It only supports a single actor at a time now.
16+
* Refer to the updated [usage example](https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.DispatchActorsService) for more information.
1317

1418
## New Features
1519

16-
* A new feature "merger strategy" (`MergeByType`, `MergeByTypeTarget`) has been added to the `Dispatcher.new_running_state_event_receiver` method. Using it, you can automatically merge & unify consecutive and overlapping dispatch start/stop events of the same type. E.g. dispatch `A` starting at 10:10 and ending at 10:30 and dispatch `B` starts at 10:30 until 11:00, with the feature enabled this would in total trigger one start event, one reconfigure event at 10:30 and one stop event at 11:00.
17-
20+
* A new feature "merger strategy" (`MergeByType`, `MergeByTypeTarget`) has been added to the `Dispatcher.new_running_state_event_receiver` method. Using it, you can automatically merge and unify consecutive and overlapping dispatch start/stop events of the same type. For example:
21+
* If dispatch A starts at 10:10 and ends at 10:30, and dispatch B starts at 10:30 and ends at 11:00, enabling the feature triggers one start event, one reconfigure event at 10:30, and one stop event at 11:00.
22+
* Support for user-defined strategies via `_MergeStrategy` has been introduced to allow customized merging behavior.
1823
* The SDK dependency was widened to allow versions up to (excluding) v1.0.0-rc1600.
19-
20-
## Bug Fixes
21-
22-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)