diff --git a/releases.md b/releases.md index e54cdaa..fd7ddc5 100644 --- a/releases.md +++ b/releases.md @@ -10,16 +10,17 @@ For example, the version in the `README.md`, as well as the `pom.xml` in the roo As a result, the correct SDK version will always be printed in the server information logs, and the example images will always be using the latest changes (due to pointing to the local maven repository that is built). +If version to be released has backwards incompatible changes, i.e. it does not support older versions of the Numaflow platform, +you must update the `MINIMUM_NUMAFLOW_VERSION` constant in the `src/main/java/io/numaproj/numaflow/info/ServerInfo.java` file to the minimum Numaflow version that is supported by your new SDK version. +Ensure that this change is merged and included in the release. + ### How to Release -This can be done via the Github UI. In the `Releases` section of the Java SDK repo, click `Draft a new release`. Create an appropriate tag for the new version and select it. Make -the title the same as the tag. Click `Generate release notes` so that all the changes made since the last release are documented. If there are any major features or breaking +This can be done via the Github UI. In the `Releases` section of the Java SDK repo, click `Draft a new release`. Create a tag that has the same name as the version that you specified in the root +`pom.xml` prefixed with a 'v', and select it. Make the title the same as the tag. Click `Generate release notes` so that all the changes made since the last release are documented. If there are any major features or breaking changes that you would like to highlight as part of the release, add those to the description as well. Then set the release as either pre-release or latest, depending on your situation. Finally, click `Publish release`, and your version tag will be the newest release on the repository. ### After Release After your release a Github Actions workflow, `Publish to Maven Central and Github Packages`, will be triggered. Monitor the workflow run and ensure that it succeeds. - -If the released version has backwards incompatible changes, i.e. it does not support older versions of the Numaflow platform, -you must update the `MINIMUM_NUMAFLOW_VERSION` constant in the `src/main/java/io/numaproj/numaflow/info/ServerInfo.java` file to the minimum Numaflow version that is supported by your new SDK version.