Preparations for release #165
Merged
Conversation
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
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the release by removing deprecated certificate/tls hacks, updating the API URL, and renaming the client to DispatchApiClient.
- Removed custom certificate options from SslOptions in the dispatch client
- Updated default server URLs in _client.py and main.py
- Revised examples and documentation in the README and RELEASE_NOTES for clarity and consistency
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/frequenz/client/dispatch/_client.py | Removed certificate parameters and updated the API URL |
| src/frequenz/client/dispatch/main.py | Updated the default dispatch API URL |
| RELEASE_NOTES.md | Clarified the description for end_time handling issue |
| README.md | Updated client name, server URL, and documentation link |
Comments suppressed due to low confidence (2)
README.md:42
- [nitpick] The documentation link anchor 'ApiDispatchClient' does not match the updated client name 'DispatchApiClient'; please verify that the anchor accurately reflects the intended naming.
For detailed usage and advanced features, check out the [client documentation](https://frequenz-floss.github.io/frequenz-client-dispatch-python/latest/reference/frequenz/client/dispatch/#frequenz.client.dispatch.ApiDispatchClient).
src/frequenz/client/dispatch/_client.py:78
- Ensure that the removal of the certificate loading does not compromise TLS verification; if relying solely on 'enabled=True', verify that the underlying TLS library provides the necessary certificate validation.
ssl=SslOptions(enabled=True),
| ## Bug Fixes | ||
|
|
||
| * `end_time` was not correctly handling the `None` value when converted from protobuf to pythons `Dispatch` class. | ||
| * Fix that a user might see invalid values for dispatches without `end_time`. It was not correctly handling the `None` value when converted from protobuf to pythons `Dispatch` class. |
There was a problem hiding this comment.
[nitpick] There's a typo in 'pythons'; consider updating to 'Python's' for clarity.
Suggested change
| * Fix that a user might see invalid values for dispatches without `end_time`. It was not correctly handling the `None` value when converted from protobuf to pythons `Dispatch` class. | |
| * Fix that a user might see invalid values for dispatches without `end_time`. It was not correctly handling the `None` value when converted from protobuf to Python's `Dispatch` class. |
Marenz
force-pushed
the
remove-custom-certs
branch
2 times, most recently
from
15fdc03 to
511e644
Compare
As we decided to do a hard-switch rather than a smooth one, we are removing all hacks and set it up to work only with the official domain & certificate now. Signed-off-by: Mathias L. Baumann <[email protected]>
Signed-off-by: Mathias L. Baumann <[email protected]>
Signed-off-by: Mathias L. Baumann <[email protected]>
Marenz
force-pushed
the
remove-custom-certs
branch
from
511e644 to
3af7b9f
Compare
llucax
approved these changes
May 14, 2025
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.
DispatchApiClient