From 39fbfd46c0a08690840eb0d81fa45dd5dad31b18 Mon Sep 17 00:00:00 2001 From: Keran Yang Date: Mon, 23 Sep 2024 11:37:33 -0400 Subject: [PATCH] docs: add instructions on how to update MinimumNumaflowVersion (#152) Signed-off-by: Keran Yang --- pkg/info/types.go | 7 +++++-- releases.md | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/pkg/info/types.go b/pkg/info/types.go index 64c17a12..e53448d3 100644 --- a/pkg/info/types.go +++ b/pkg/info/types.go @@ -13,6 +13,7 @@ const ( Go Language = "go" Python Language = "python" Java Language = "java" + Rust Language = "rust" ) type MapMode string @@ -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 { diff --git a/releases.md b/releases.md index ad958c86..ba0977e7 100644 --- a/releases.md +++ b/releases.md @@ -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.