# Release Kalix Java/Scala SDKs ### Prepare - [x] Make sure all important PRs have been merged - [x] Check that the [latest build](https://github.com/lightbend/kalix-jvm-sdk/actions?query=branch%3Amain) successfully finished - [x] Make sure a version of the Kalix Runtime that supports the protocol version the SDK expects has been deployed to production You can see the Kalix Runtime version on prod [in groundcover](https://app.groundcover.com/grafana/d/Kalix-Metrics/prod-kalix-metrics?from=now-1h&to=now&timezone=browser&var-environment=%24__all&var-region=%24__all&var-cluster=%24__all&var-namespace=%24__all&var-service=%24__all&backendId=groundcover&tenantUUID=c469a891-3123-484d-89bf-23efdd3f2b92&src_cluster=gcp-us-east1&duration=Last+5+minutes) ### Cutting the release - [x] Update the "Change date" on [the license](../blob/main/LICENSE#L9) to release date plus three years and the version of the SDK in "Licensed Work". - [x] Use the "Generate release notes" button to create [a new release](https://github.com/lightbend/kalix-jvm-sdk/releases/new?tag=v1.5.30) with the appropriate tag. - Review the generated notes and "Publish release" - CI will automatically publish to the repository based on the tag ### Check availability - [x] Wait for the [Publish action](https://github.com/lightbend/kalix-jvm-sdk/actions/workflows/publish.yml) to complete for the release tag - [x] Manually update [`docs/kalix-current`](https://github.com/lightbend/kalix-jvm-sdk/commits/docs/kalix-current) (There is a workflow but that has been failing, possibly for expired secrets) - To update that branch, run this locally ```shell git fetch --tags cd docs make deploy ``` - [ ] Check the released artifacts - [ ] Check the parent pom is available at Maven Central: `mvn dependency:get -Dartifact=io.kalix:kalix-java-sdk-protobuf-parent:1.5.30:pom` - [x] Check the core SDK is available in our own repo: `mvn dependency:get -Dartifact=io.kalix:kalix-jvm-core-sdk:1.5.30` ### Fix and publish docs - [ ] In case there were important updates, update the [supported version in the main docs](https://github.com/lightbend/kalix-docs/blob/main/docs/modules/ROOT/partials/include.adoc#L21) (affects [Supported Languages](https://docs.kalix.io/sdk-support/supported-languages.html)) - [x] Add an item to the [Release Notes](https://github.com/lightbend/kalix-docs/blob/main/docs/modules/reference/pages/release-notes.adoc) in the documentation - [ ] Release the Kalix documentation to get the SDK docs updates published ### Update to the latest version - [x] Review and merge PR created by bot (should appear [here](https://github.com/lightbend/kalix-jvm-sdk/pulls?q=is%3Apr+is%3Aopen+auto+pr+)). While reviewing confirm the release version is updated for: - `kalix-sdk.version` in the `samples/*/pom.xml` files - `kalix-sdk.version` default value in the `samples/scala-*/project/plugins.sbt` files - version in `maven-java/**/pom.xml` ### Check docs update - [ ] Check for [updated docs](https://docs.kalix.io/index.html) (see the timestamp on the bottom of the page) - no longer there - [ ] Check for the latest version on the [dependency configuration example](https://docs.kalix.io/java-protobuf/index.html#_reference_the_kalix_protobuf_sdks) ### Announcements - [ ] Add a summary of relevant changes and a link to the release notes into [Kalix Release Notes aggregation](https://docs.google.com/document/d/1Q0yWZssJHhF9oOKMW1yHq-QCyXJ-Ej8DeNuim4_QN6w/edit?usp=sharing) - [ ] Close this issue
Release Kalix Java/Scala SDKs
Prepare
You can see the Kalix Runtime version on prod in groundcover
Cutting the release
Check availability
Wait for the Publish action to complete for the release tag
Manually update
docs/kalix-current(There is a workflow but that has been failing, possibly for expired secrets)git fetch --tags cd docs make deployCheck the released artifacts
mvn dependency:get -Dartifact=io.kalix:kalix-java-sdk-protobuf-parent:1.5.30:pommvn dependency:get -Dartifact=io.kalix:kalix-jvm-core-sdk:1.5.30Fix and publish docs
Update to the latest version
kalix-sdk.versionin thesamples/*/pom.xmlfileskalix-sdk.versiondefault value in thesamples/scala-*/project/plugins.sbtfilesmaven-java/**/pom.xmlCheck docs update
Announcements