-
Notifications
You must be signed in to change notification settings - Fork 44
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.
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
Update release checklist doc #1930
Conversation
- remove SDK release requirement - add explicit service protocol release requirement
README.md
Outdated
|
||
* [SDK-Java](https://github.com/restatedev/sdk-java/?tab=readme-ov-file#versions) | ||
* [SDK-Typescript](https://github.com/restatedev/sdk-typescript/?tab=readme-ov-file#versions) | ||
* [SDK-TypeScript](https://github.com/restatedev/sdk-typescript/?tab=readme-ov-file#versions) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add all the other SDK links too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
@@ -108,10 +108,10 @@ Restate follows [Semantic Versioning](https://semver.org/). | |||
|
|||
You can safely upgrade from a Restate `x.y` to `x.(y+1)` release without performing any manual data migration, as Restate performs an automatic data migration for you. | |||
|
|||
To check the compatibility with the SDKs, check the respective READMEs: | |||
For SDK compatibility, refer to the supported version matrix in the respective READMEs: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps generally, what I would write here is something along the lines of "get in touch with the respective SDK owners to check whether a new release should be made for the SDKs"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
@@ -30,6 +30,8 @@ https://github.com/issues?q=is%3Aopen+org%3Arestatedev+label%3Arelease-blocker | |||
|
|||
Make sure that all [supported service protocol versions](../../crates/types/src/service_protocol.rs) are released. | |||
|
|||
Confirm if any SDK releases are needed to keep up with the runtime and/or service protocol releases. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
perfect!
Minor tidy-up: