Dispatch Highlevel Interface Release Notes

Enhancements

• Improved docstring documentation across the project.

Bug Fixes

• Fixed documentation cross-references to dependencies by updating the mkdocstrings inventories to match the minimum dependency versions and adding the missing frequenz-client-base inventory.
• Declared the missing direct dependencies frequenz-client-common, frequenz-core and grpcio, which were previously only pulled in indirectly through frequenz-client-dispatch.

What's Changed

• Add repo-config auto-migration workflow by @llucax in #249
• Bump setuptools from 80.9.0 to 82.0.1 by @dependabot[bot] in #257
• Bump nox from 2025.11.12 to 2026.2.9 by @dependabot[bot] in #260
• Build(deps-dev): Bump uv from 0.10.7 to 0.11.2 in the minor group across 1 directory by @dependabot[bot] in #253
• Bump setuptools-scm from 9.2.2 to 10.0.3 by @dependabot[bot] in #256
• Bump isort from 7.0.0 to 8.0.1 by @dependabot[bot] in #258
• Bump the patch group with 4 updates by @dependabot[bot] in #251
• Build(deps-dev): Bump frequenz-repo-config from 0.13.8 to 0.17.0 in the repo-config group by @dependabot[bot] in #263
• Build(deps): Bump the compatible group across 1 directory with 2 updates by @dependabot[bot] in #264
• Build(deps-dev): Bump mypy from 1.19.1 to 1.20.0 in the minor group across 1 directory by @dependabot[bot] in #262
• Build(deps-dev): Bump black from 25.12.0 to 26.3.1 by @dependabot[bot] in #255
• Build(deps-dev): Bump mkdocstrings-python from 1.18.2 to 2.0.3 by @dependabot[bot] in #259
• Build(deps): Bump the compatible group with 3 updates by @dependabot[bot] in #265
• Build(deps): Bump frequenz-floss/gh-action-setup-git from 16952aac3ccc01d27412fe0dea3ea946530dcace to f9d86a01228ee1cadaac5224d4d7626f1eb23f90 by @dependabot[bot] in #266
• Build(deps): Bump frequenz-floss/gh-action-setup-python-with-deps from 0d0d77eac3b54799f31f25a1060ef2c6ebdf9299 to e4d0b2ef8f5a1612d7827f3abaef17c931d2b946 by @dependabot[bot] in #267
• Build(deps-dev): Bump the patch group with 4 updates by @dependabot[bot] in #268
• Build(deps-dev): Bump types-markdown from 3.10.2.20260211 to 3.10.2.20260408 by @dependabot[bot] in #270
• Build(deps-dev): Bump the minor group across 1 directory with 2 updates by @dependabot[bot] in #269
• Build(deps): Bump actions/create-github-app-token from 2.2.1 to 3.1.1 by @dependabot[bot] in #252
• Build(deps-dev): Bump async-solipsism from 0.8 to 0.9 by @dependabot[bot] in #237
• Build(deps-dev): Bump uv from 0.11.8 to 0.11.15 by @dependabot[bot] in #271
• Build(deps): Bump the compatible group with 4 updates by @dependabot[bot] in #272
• Build(deps-dev): Bump uv from 0.11.15 to 0.11.17 in the patch group by @dependabot[bot] in #273
• Build(deps-dev): Bump black from 26.3.1 to 26.5.1 in the minor group by @dependabot[bot] in #274
• Build(deps-dev): Bump types-markdown from 3.10.2.20260408 to 3.10.2.20260518 by @dependabot[bot] in #275
• Build(deps-dev): Bump pytest-asyncio from 1.3.0 to 1.4.0 by @dependabot[bot] in #276
• Build(deps-dev): Bump pydoclint from 0.8.3 to 0.8.4 by @dependabot[bot] in #277
• Build(deps-dev): Bump mypy from 1.20.2 to 2.1.0 by @dependabot[bot] in #278
• Fix and improve docstring documentation by @llucax in #279
• Build(deps): Bump actions/checkout from 6.0.2 to 7.0.0 by @dependabot[bot] in #281
• Build(deps): Bump frequenz-floss/gh-action-setup-python-with-deps from 1.0.4 to 1.0.5 in the compatible group by @dependabot[bot] in #280
• Build(deps-dev): Bump the patch group with 3 updates by @dependabot[bot] in #282
• Build(deps-dev): Bump the minor group with 2 updates by @dependabot[bot] in #283
• Build(deps-dev): Bump pydoclint from 0.8.4 to 0.9.0 by @dependabot[bot] in #285
• Build(deps-dev): Bump frequenz-repo-config from 0.17.0 to 0.18.0 in the repo-config group across 1 directory by @dependabot[bot] in #284
• Build(deps): Bump the compatible group with 2 updates by @dependabot[bot] in #286
• Build(deps): Bump the compatible group with 6 updates by @dependabot[bot] in #287
• Build(deps): Bump actions/labeler from 6.1.0 to 7.0.0 by @dependabot[bot] in #288
• Build(deps-dev): Bump the patch group with 3 updates by @dependabot[bot] in #289
• Build(deps-dev): Bump the minor group with 3 updates by @dependabot[bot] in #290
• Build(deps-dev): Bump types-markdown from 3.10.2.20260518 to 3.10.2.20260712 by @dependabot[bot] in #292
• Build(deps-dev): Bump pydoclint from 0.9.0 to 0.9.1 by @dependabot[bot] in #293
• Build(deps-dev): Bump setuptools from 82.0.1 to 83.0.0 by @dependabot[bot] in #291
• Build(deps-dev): Bump the patch group with 5 updates by @dependabot[bot] in #294
• Build(deps-dev): Bump flake8-datetimez from 20.10.0 to 26.8.1 by @dependabot[bot] in #298
• Build(deps-dev): Bump setuptools from 83.0.0 to 84.0.0 by @dependabot[bot] in #297
• Build(deps-dev): Bump the minor group across 1 directory with 2 updates by @dependabot[bot] in #295
• Build(deps-dev): Bump the patch group with 5 updates by @dependabot[bot] in #305
• Clear release notes by @llucax in #304
• Fix documentation cross-linking inventory versions by @llucax in #301
• Build(deps-dev): Bump isort from 8.0.1 to 9.0.1 by @dependabot[bot] in #299
• Declare missing direct dependencies by @llucax in #303
• Build(deps-dev): Bump frequenz-repo-config from 0.18.0 to 0.19.0 in the repo-config group across 1 directory by @dependabot[bot] in #296

Full Changelog: v1.0.3...v1.0.4

Dispatch Highlevel Interface Release Notes

Bug Fixes

• Fixed bugs that could cause a dispatch actor not to stop when an update arrives exactly at the moment a dispatch window closes. Also fixed a related issue that could cause incorrect event ordering when multiple dispatches are updated concurrently.

What's Changed

• Bump actions/checkout from 5 to 6 by @dependabot[bot] in #218
• Bump the patch group across 1 directory with 5 updates by @dependabot[bot] in #222
• Clear release notes by @llucax in #223
• Bump uv from 0.9.16 to 0.9.17 in the patch group by @dependabot[bot] in #224
• Bump mkdocs-gen-files from 0.5.0 to 0.6.0 by @dependabot[bot] in #229
• Bump pylint from 3.3.8 to 4.0.4 by @dependabot[bot] in #227
• Improve README.md for better project discoverability by @Marenz in #221
• Bump isort from 6.0.1 to 7.0.0 by @dependabot[bot] in #210
• Bump mkdocstrings[python] from 0.30.1 to 1.0.0 by @dependabot[bot] in #231
• Bump pytest-asyncio from 1.2.0 to 1.3.0 by @dependabot[bot] in #232
• Bump pytest from 8.4.2 to 9.0.2 by @dependabot[bot] in #228
• Bump black from 25.11.0 to 25.12.0 in the minor group by @dependabot[bot] in #225
• Bump time-machine from 2.19.0 to 3.1.0 by @dependabot[bot] in #230
• Bump the patch group across 1 directory with 6 updates by @dependabot[bot] in #245
• Bump actions/upload-artifact from 5 to 7 by @dependabot[bot] in #243
• Bump the minor group across 1 directory with 2 updates by @dependabot[bot] in #244
• Bump the compatible group with 2 updates by @dependabot[bot] in #241
• Bump actions/download-artifact from 6 to 8 by @dependabot[bot] in #242
• Fix scheduler bugs on v1.x.x by @Marenz in #248

Full Changelog: v1.0.2...v1.0.3

Dispatch Highlevel Interface Release Notes

Summary

This release just updates some dependencies to allow compatibility with newer versions.

What's Changed

• Add auto-approve and auto-merge for Dependabot PRs by @Marenz in #211
• Use commit hash for dependabot-auto-approve action by @Marenz in #212
• Fix wrong dependabot-auto-approve hash by @Marenz in #213
• Widen dependency for the SDK to work with the microgrid API v0.18 by @llucax in #219
• Bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #203
• Bump frequenz-floss/gh-action-nox from 1.0.1 to 1.1.0 in the compatible group by @dependabot[bot] in #216
• Bump actions/download-artifact from 5 to 6 by @dependabot[bot] in #204
• Bump pydoclint from 0.7.3 to 0.8.3 by @dependabot[bot] in #214
• Bump the minor group across 1 directory with 8 updates by @dependabot[bot] in #215

Full Changelog: v1.0.1...v1.0.2

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

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

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

❗ ❗ 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

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

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

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