Skip to content

Commit

Permalink
docs: add instructions on how to update MinimumNumaflowVersion
Browse files Browse the repository at this point in the history
Signed-off-by: Keran Yang <[email protected]>
  • Loading branch information
KeranYang committed Sep 23, 2024
1 parent 232ccc9 commit 96dbe1b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 5 additions & 2 deletions pkg/info/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ const (
Go Language = "go"
Python Language = "python"
Java Language = "java"
Rust Language = "rust"
)

type MapMode string
Expand All @@ -26,8 +27,10 @@ const (
// MapModeKey is the key used in the server info metadata map to indicate which map mode is enabled.
const MapModeKey = "MAP_MODE"

// MinimumNumaflowVersion specifies the minimum Numaflow version required by the current SDK version
const MinimumNumaflowVersion = "1.3.0-rc1"
// MinimumNumaflowVersion is the minimum version of Numaflow required by the current SDK version
// To update this value, please follow the instructions for MINIMUM_NUMAFLOW_VERSION in
// https://github.com/numaproj/numaflow-rs/blob/main/src/shared.rs
const MinimumNumaflowVersion = "1.3.1-z"

// ServerInfo is the information about the server
type ServerInfo struct {
Expand Down
2 changes: 1 addition & 1 deletion releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document explains the release process for the Go SDK. You can find the most

### Before Release

If the version to be released has backwards incompatible changes, i.e. it does not support older versions of the Numaflow platform,
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.

Expand Down

0 comments on commit 96dbe1b

Please sign in to comment.