Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add instructions on how to update MinimumNumaflowVersion #152

Merged
merged 1 commit into from
Sep 23, 2024
Merged

docs: add instructions on how to update MinimumNumaflowVersion #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions pkg/info/types.go
View file
Open in desktop
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
View file
Open in desktop
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
Loading