Skip to content

Commit c5829ca

Browse files
committed
Update release notes for v1 release
- Mark authentication parameter changes as breaking - Update environment variable changes as breaking - Add summary for v1 preparation Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent 30ec4e9 commit c5829ca

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

RELEASE_NOTES.md

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

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
Major release preparing for v1 with breaking changes to authentication parameters and dependency updates.
66

77
## Upgrading
88

9-
* 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.
9+
* **BREAKING**: The `key` parameter in the `Dispatcher` constructor has been removed. Use `auth_key` instead.
10+
* **BREAKING**: The `sign_secret` parameter is now required for authentication.
11+
* **BREAKING**: Environment variables have been updated:
12+
* `DISPATCH_API_KEY``DISPATCH_API_AUTH_KEY`
13+
* `DISPATCH_API_SIGN_SECRET` is now required
1014
* The `components` property in `DispatchInfo` is now deprecated. Use `target` instead.
1115

1216
## New Features

0 commit comments

Comments
 (0)