From 4a0b4fd6afc9841176693e240a9aeb92adebb78a Mon Sep 17 00:00:00 2001 From: Abdullah Yildirim Date: Thu, 11 Apr 2024 11:25:47 -0400 Subject: [PATCH] chore: update release doc (#118) Signed-off-by: a3hadi --- releases.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/releases.md b/releases.md index 50642e26..21c0d618 100644 --- a/releases.md +++ b/releases.md @@ -2,9 +2,15 @@ This document explains the release process for the Go SDK. You can find the most recent version under [Github Releases](https://github.com/numaproj/numaflow-go/releases). +### Before Release + +If the version to be released has backwards incompatible changes, i.e. it does not support older versions of the Numaflow platform, +you must update the `MinimumNumaflowVersion` constant in the `pkg/info/types.go` 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 Go SDK repo, click `Draft a new release`. Create an appropriate tag for the new version and select it. Make +This can be done via the Github UI. In the `Releases` section of the Go SDK repo, click `Draft a new release`. Create an appropriate tag for the version number, using the [semantic versioning](https://semver.org/) specification, 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. @@ -14,11 +20,8 @@ on your situation. Finally, click `Publish release`, and your version tag will b Once a new version has been released, and its corresponding version tag exists on the remote repo, you want to update the `go.mod` files to reflect this new version: ```shell -./hack/update_examples.sh -u +./hack/update_examples.sh -u ``` After running the above, create a PR for the changes that the script made. Once merged, it will trigger the Docker Publish workflow. 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 the local references). - -If the released version has backwards incompatible changes, i.e. it does not support older versions of the Numaflow platform, -you must update the `MinimumNumaflowVersion` constant in the `pkg/info/types.go` file to the minimum Numaflow version that is supported by your new SDK version. \ No newline at end of file +and the example images will always be using the latest changes (due to the local references). \ No newline at end of file