v1.0.1

Dispatch Highlevel Interface Release Notes

Summary

This is a patch release that widens the dependency of the frequenz-client-dispatch package to < 2.0.0.

What's Changed

• Update frequenz-client-dispatch requirement from <1.0.0,>=0.11.3 to >=0.11.3,<2.0.0 by @dependabot[bot] in #208

Full Changelog: v1.0.0...v1.0.1

v1.0.0

Dispatch Highlevel Interface Release Notes

Summary

This is the first major version release with authentication parameter updates and dependency version expansion.

Upgrading

• The key parameter in the Dispatcher constructor is deprecated. Use auth_key instead.
• The sign_secret parameter is available and should be used for authentication. It will be soon required.
• The components property in DispatchInfo is deprecated. Use target instead.

New Features

• dry_run status is now considered when merging dispatches. Dispatches with different dry_run values will no longer be merged, ensuring that dry-run and operational dispatches are handled by separate actors.
• Two new parameters were added to the Dispatcher constructor:
  • sign_secret: A secret key used for signing messages.
  • auth_key: An authentication key for the Dispatch API.
• Dispatcher now only fetches ongoing dispatches, excluding completed ones, to optimize performance and relevance.

Bug Fixes

What's Changed

• Bump the minor group with 6 updates by @dependabot[bot] in #198
• Prepare for v1: Update auth parameters and client version by @Marenz in #202

Full Changelog: v0.10.4...v1.0.0

v0.10.4

Dispatch Highlevel Interface Release Notes

Summary

Upgrading

• The key parameter in the Dispatcher constructor is now deprecated. Use auth_key instead. The sign_secret parameter is an additional optional parameter for signing.
• The components property in DispatchInfo is now deprecated. Use target instead.

New Features

• dry_run status is now considered when merging dispatches. Dispatches with different dry_run values will no longer be merged, ensuring that dry-run and operational dispatches are handled by separate actors.
• Two new parameters were added to the Dispatcher constructor:
  • sign_secret: A secret key used for signing messages.
  • auth_key: An authentication key for the Dispatch API.
• Dispatcher now only fetches ongoing dispatches, excluding completed ones, to optimize performance and relevance.

Bug Fixes

What's Changed

• Bump pytest-asyncio from 1.1.0 to 1.2.0 by @dependabot[bot] in #200
• Bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #196
• Bump the patch group with 4 updates by @dependabot[bot] in #197
• Bump pydoclint from 0.6.11 to 0.7.3 by @dependabot[bot] in #199
• Make DispatchInfo c'tor accept components by @Marenz in #201

Full Changelog: v0.10.3...v0.10.4

v0.10.3

❗ ❗ THIS RELEASE HAS BEEN YANKED DUE TO INCOMPLETE BACKWARDS COMPATIBILITY ❗ ❗

Dispatch Highlevel Interface Release Notes

Summary

Upgrading

• The key parameter in the Dispatcher constructor is now deprecated. Use auth_key instead. The sign_secret parameter is an additional optional parameter for signing.
• The components property in DispatchInfo is now deprecated. Use target instead.

New Features

• dry_run status is now considered when merging dispatches. Dispatches with different dry_run values will no longer be merged, ensuring that dry-run and operational dispatches are handled by separate actors.
• Two new parameters were added to the Dispatcher constructor:
  • sign_secret: A secret key used for signing messages.
  • auth_key: An authentication key for the Dispatch API.
• Dispatcher now only fetches ongoing dispatches, excluding completed ones, to optimize performance and relevance.

Bug Fixes

What's Changed

• Bump mkdocs-material from 9.6.14 to 9.6.16 in the patch group by @dependabot[bot] in #177
• Bump the minor group with 2 updates by @dependabot[bot] in #178
• Bump async-solipsism from 0.7 to 0.8 by @dependabot[bot] in #180
• Bump types-markdown from 3.8.0.20250415 to 3.8.0.20250708 by @dependabot[bot] in #181
• Bump the compatible group with 2 updates by @dependabot[bot] in #183
• Bump pytest-asyncio from 1.0.0 to 1.1.0 by @dependabot[bot] in #182
• Bump mkdocstrings[python] from 0.29.1 to 0.30.0 in the mkdocstrings group by @dependabot[bot] in #179
• Support key signing and handle dry_run cleaner by @Marenz in #184
• Bump pydoclint from 0.6.6 to 0.6.11 by @dependabot[bot] in #186
• Bump mkdocstrings-python from 1.16.12 to 1.18.2 in the mkdocstrings group by @dependabot[bot] in #191
• Bump actions/checkout from 4 to 5 by @dependabot[bot] in #192
• Bump types-markdown from 3.8.0.20250708 to 3.8.0.20250809 by @dependabot[bot] in #188
• Bump setuptools-scm[toml] from 8.3.1 to 9.2.0 by @dependabot[bot] in #189
• Bump time-machine from 2.16.0 to 2.19.0 in the minor group by @dependabot[bot] in #190
• Bump the patch group with 4 updates by @dependabot[bot] in #187
• Bump actions/download-artifact from 4 to 5 in the artifacts group by @dependabot[bot] in #193
• Deprecate DispatchInfo.components in favor of target by @Marenz in #194
• Fetch only ongoing dispatches by @Marenz in #195

Full Changelog: v0.10.2...v0.10.3

v0.10.2

Dispatch Highlevel Interface Release Notes

Summary

Upgrading

New Features

Bug Fixes

• The merge by type class now uses the correct logger path.
• The merge by type was made more robust under heavy load, making sure to use the same now for all dispatches that are checked.
• Fix that the merge filter was using an outdated dispatches dict once fetch() ran.

What's Changed

• Bump pytest-asyncio from 0.26.0 to 1.0.0 by @dependabot[bot] in #171
• Bump the minor group with 2 updates by @dependabot[bot] in #172
• Bump the patch group with 6 updates by @dependabot[bot] in #173
• Fix dispatch dict passed to MergeStrategy not getting updated for future fetch's by @Marenz in #174

Full Changelog: v0.10.1...v0.10.2

v0.10.1

Dispatch Highlevel Interface Release Notes

Summary

Upgrading

The frequenz.dispatch.TargetComponents type was removed, use frequenz.client.dispatch.TargetComponents instead.

New Features

• The dispatcher offers two new parameters to control the client's call and stream timeout:
  • call_timeout: The maximum time to wait for a response from the client.
  • stream_timeout: The maximum time to wait before restarting a stream.
• While the dispatch stream restarts we refresh our dispatch cache as well, to ensure we didn't miss any updates.

Bug Fixes

• Fixed that dispatches are never retried on failure, but instead an infinite loop of retry logs is triggered.

What's Changed

• Bug fixes after testing with edge app by @Marenz in #169
• Fix Typo by @Marenz in #170

Full Changelog: v0.10.0...v0.10.1

v0.9.0

Dispatch Highlevel Interface Release Notes

Upgrading

• Change minimum version of the frequenz-sdk dependency from >= 1.0.0-rc2000 to >= 1.0.0-rc1900

What's Changed

• Make DispatchInfo components type: TargetComponent public by @ela-kotulska-frequenz in #160

Full Changelog: v0.8.1...v0.9.0

v0.8.1

Dispatch Highlevel Interface Release Notes

Bug Fixes

• Make DispatchInfo components type: TargetComponent public

What's Changed

• Update release notes by @ela-kotulska-frequenz in #159
• Bump the patch group with 7 updates by @dependabot in #157
• Bump the minor group with 2 updates by @dependabot in #158

Full Changelog: v0.8.0...v0.8.1

v0.8.0

Dispatch Highlevel Interface Release Notes

New Features

• This release now supports the sdk up to rc2000.
• Less logs are now on INFO level, and more on DEBUG level, making the output less verbose.
• Changed the type of DispatchInfo.components from list[int] | list[ComponentCategory] to list[ComponentId] | list[ComponentCategory], where ComponentId is imported from frequenz.client.microgrid.

What's Changed

• Reset release notes by @Marenz in #153
• Widen sdk dependency to support rc2000 by @Marenz in #152
• Less verbose logs by @Marenz in #154
• Use ComponentId instead of int TargetComponents by @ela-kotulska-frequenz in #156

Full Changelog: v0.7.0...v0.8.0

v0.7.0

Dispatch Highlevel Interface Release Notes

Upgrading

This is a breaking release that requires you to use the new URL for the dispatch service.

Bug Fixes

• Fix that a user might see invalid values for dispatches without end_time.

What's Changed

• Clear release notes by @shsms in #137
• Update to frequenz-client-dispatch 0.9.0 by @Marenz in #138
• Bump the patch group with 4 updates by @dependabot in #139
• Bump pydoclint from 0.6.4 to 0.6.6 by @dependabot in #141
• Bump setuptools from 78.1.0 to 80.1.0 by @dependabot in #142
• Bump the minor group across 1 directory with 6 updates by @dependabot in #148
• Update minor version of frequenz-client-dispatch to 0.10.1 by @Marenz in #151
• Update dispatch url used in examples to dummy by @Marenz in #150

Full Changelog: v0.6.2...v0.7.0