Skip to content

Clear release notes #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 26, 2024
Merged

Clear release notes #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,16 @@

## Summary

This version removes `grpclib` support and adds new SSL options to the connection URI.
<!-- Here goes a general summary of what this release is about -->

## Upgrading

- `grpclib` was removed, if you used `grpclib` you should switch to `grpcio` instead.

You should also update your dependency to `frequenz-client-base` (without any `[grpclib]` or `[grpcio]` suffix). Also, now there is no need to pass around the channel type to the `BaseApiClient` or the `parse_grpc_uri` function.

- The `parse_grpc_uri` function (and `BaseApiClient` constructor) now enables SSL by default (`ssl=false` should be passed to disable it).

- The `parse_grpc_uri` and `BaseApiClient` function now accepts a set of defaults to use when the URI does not specify a value for a given option.
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

## New Features

- The connection URI can now have a few new SSL options:
<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

* `ssl_root_certificates_path` to specify the path to the root certificates file.
* `ssl_private_key_path` to specify the path to the private key file.
* `ssl_certificate_chain_path` to specify the path to the certificate chain file.
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->