Skip to content

Commit

Permalink
Update release checklist doc (#1930)
Browse files Browse the repository at this point in the history
  • Loading branch information
pcholakov authored Sep 10, 2024
1 parent d8f9e49 commit 9a48f3d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,13 @@ 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:

* [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)
* [Restate Java SDK](https://github.com/restatedev/sdk-java#versions)
* [Restate TypeScript SDK](https://github.com/restatedev/sdk-typescript#versions)
* [Restate Go SDK](https://github.com/restatedev/sdk-go#versions)
* [Restate Python SDK](https://github.com/restatedev/sdk-python#versions)
* [Restate Rust SDK](https://github.com/restatedev/sdk-rust#versions)

### Building Restate locally

Expand Down
13 changes: 7 additions & 6 deletions docs/dev/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@
Restate artifacts to release:

* Runtime (this repo)
* [SDK-Typescript](https://github.com/restatedev/sdk-typescript/?tab=readme-ov-file#releasing-the-package) and [Node template](https://github.com/restatedev/node-template-generator)
* [Java SDK](https://github.com/restatedev/sdk-java/blob/main/development/release.md)
* [Service protocol](https://github.com/restatedev/service-protocol)
* [Documentation](https://github.com/restatedev/documentation/)
* [Examples](https://github.com/restatedev/examples)
* [Service protocol](https://github.com/restatedev/service-protocol)
* [CDK](https://github.com/restatedev/cdk)
* [Operator](https://github.com/restatedev/restate-operator)
* [CDK Constructs](https://github.com/restatedev/cdk)

Check the respective documentation of the single artifacts to perform a release.

Expand All @@ -23,13 +21,17 @@ We follow [SemVer](https://semver.org/):
> * MINOR version when you add functionality in a backward compatible manner
> * PATCH version when you make backward compatible bug fixes
Runtime and SDKs follow independent versioning. SDKs should declare their compatibility matrix with respective runtime versions.
Runtime and SDKs follow independent artifact versioning. Restate server and SDK compatibility is defined by the intersection of supported service protocol versions.

## Pre-release

Before releasing, make sure all the issues tagged with release-blocker have either been solved, or PRs are ready to solve them:
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.

## Releasing the Restate runtime

1. Make sure that the version field in the [Cargo.toml](/Cargo.toml) and [Chart.yaml](/charts/restate-helm/Chart.yaml) is set to the new release version `X.Y.Z`.
Expand All @@ -42,7 +44,6 @@ https://github.com/issues?q=is%3Aopen+org%3Arestatedev+label%3Arelease-blocker
Don't immediately create a release branch after a MAJOR/MINOR release.
A release branch `release-MAJOR.MINOR` should only be created once a change to the storage formats, APIs or a new feature gets merged that should be shipped with the next MAJOR/MINOR release.


## Post-release

If you are releasing a new major/minor version of the runtime, please also create a new release of the [documentation](https://github.com/restatedev/restate).

0 comments on commit 9a48f3d

Please sign in to comment.