Skip to content

Commit 5ddb903

Browse files
committed
Update readme, make it ready for release
Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent 07a077e commit 5ddb903

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ This release introduces a more flexible and powerful mechanism for managing disp
99
* `Dispatcher.start` is no longer `async`. Remove `await` when calling it.
1010
* Two properties have been replaced by methods that require a type as parameter.
1111
* `Dispatcher.lifecycle_events` has been replaced by the method `Dispatcher.new_lifecycle_events_receiver(self, dispatch_type: str)`.
12-
* `Dispatcher.running_status_change` has been replaced by the method `Dispatcher.new_running_state_event_receiver(self, dispatch_type: str, unify_running_intervals: bool)`.
12+
* `Dispatcher.running_status_change` has been replaced by the method `Dispatcher.new_running_state_event_receiver(self, dispatch_type: str, merge_strategy: MergeStrategy)`.
1313
* The managing actor constructor no longer requires the `dispatch_type` parameter. Instead you're expected to pass the type to the new-receiver function.
1414
* The `DispatchManagingActor` class has been renamed to `DispatchActorsService`.
1515
* It's interface has been simplified and now only requires an actor factory and a running status receiver.
16-
* It only supports a single actor at a time now.
16+
* It only starts/stops a single actor at a time now instead of a set of actors.
1717
* Refer to the updated [usage example](https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.DispatchActorsService) for more information.
1818
* `DispatchUpdate` was renamed to `DispatchInfo`.
1919

2020
## New Features
2121

22-
* 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.
22+
* A new feature "merge strategy" (`MergeByType`, `MergeByTypeTarget`) has been added to the `Dispatcher.new_running_state_event_receiver` method. Using it, you can automatically merge 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.
2323
* The SDK dependency was widened to allow versions up to (excluding) v1.0.0-rc1600.
24-
* A new function `Dispatcher.manage` was added to simplify dispatchable actor management initialization.
24+
* Actor management with dispatches has been simplified. Calling `Dispatcher.start_dispatching(dispatch_type, actor_factory, merge_strategy)` will begin managing your actor for the given type and merge strategy. All you need provide is an actor factory. To stop dispatching for your type, call `Dispatcher.stop_dispatching(dispatch_type)`.

0 commit comments

Comments
 (0)