Skip to content

Commit c120517

Browse files
committed
Clear release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent e1c02e5 commit c120517

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

RELEASE_NOTES.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,16 @@
22

33
## Summary
44

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

77
## Upgrading
88

9-
- `grpclib` was removed, if you used `grpclib` you should switch to `grpcio` instead.
10-
11-
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.
12-
13-
- The `parse_grpc_uri` function (and `BaseApiClient` constructor) now enables SSL by default (`ssl=false` should be passed to disable it).
14-
15-
- 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.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1610

1711
## New Features
1812

19-
- The connection URI can now have a few new SSL options:
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
14+
15+
## Bug Fixes
2016

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

0 commit comments

Comments
 (0)