Prepare for v1: Update auth parameters and client version#202
Merged
Marenz merged 3 commits intofrequenz-floss:v0.x.xfrom Oct 28, 2025
Merged
Prepare for v1: Update auth parameters and client version#202Marenz merged 3 commits intofrequenz-floss:v0.x.xfrom
Marenz merged 3 commits intofrequenz-floss:v0.x.xfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the dispatch client integration to prepare for the v1 release by migrating from deprecated authentication parameters to the new authentication model and updating version constraints.
Key Changes:
- Migrated authentication parameters from
keytoauth_keyandsign_secretin all documentation examples - Updated environment variable names from
DISPATCH_API_KEYtoDISPATCH_API_AUTH_KEYand addedDISPATCH_API_SIGN_SECRET - Relaxed version constraint for
frequenz-client-dispatchfrom< 0.12.0to< 1.0.0
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/frequenz/dispatch/_actor_dispatcher.py | Updated example code to use new auth_key and sign_secret parameters with corresponding environment variables |
| pyproject.toml | Updated frequenz-client-dispatch dependency version constraint to allow versions up to 1.0.0 |
| README.md | Updated example code to use new auth_key and sign_secret parameters with corresponding environment variables |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
github-actions
bot
added
part:docs
- Replace deprecated 'key' parameter with 'auth_key' in examples - Add 'sign_secret' parameter to examples - Update environment variable names from DISPATCH_API_KEY to DISPATCH_API_AUTH_KEY - Add DISPATCH_API_SIGN_SECRET environment variable Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
- Change frequenz-client-dispatch version from < 0.12.0 to < 1.0.0 Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
- Mark authentication parameter changes as breaking - Update environment variable changes as breaking - Add summary for v1 preparation Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
llucax
approved these changes
Oct 27, 2025
Comment on lines
-9
to
-10
| * 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. |
Contributor
There was a problem hiding this comment.
I guess these were old release notes from the previous release, right? So the previous release deprecated them and this release will remove the deprecated names?
Contributor
Author
There was a problem hiding this comment.
They are still only deprecated , nothing is made incompatible yet
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
auth_keyandsign_secretparameters instead of deprecatedkeyparameterDISPATCH_API_KEYtoDISPATCH_API_AUTH_KEYand addDISPATCH_API_SIGN_SECRET