Skip to content

Commit

Permalink
Bump version strings for 1.0 release (#1261)
Browse files Browse the repository at this point in the history
  • Loading branch information
Groxx authored Jul 12, 2023
1 parent 58f9746 commit a072981
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 22 deletions.
40 changes: 27 additions & 13 deletions internal/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,32 @@ package internal
// by the cadence team as part of a major feature or
// behavior change

// LibraryVersion is a semver that represents
// the version of this cadence client library.
// This represents API changes visible to Cadence
// client side library consumers, i.e. developers
// that are writing workflows. So every time we change API
// that can affect them we have to change this number.
// Format: MAJOR.MINOR.PATCH
const LibraryVersion = "0.18.4"
// LibraryVersion is a historical way to report the "library release" version,
// prior to go modules providing a far more consistent way to do so.
// It is sent in a header on every request.
//
// deprecated: This cannot accurately report pre-release version information,
// and it is easy for it to drift from the release version (especially if an old
// commit is tagged, to avoid branching, as this behaves poorly with go modules).
//
// Ideally it would be replaced by runtime/debug.ReadBuildInfo()... but that is
// not guaranteed to exist, and even if this is a fallback it still needs to be
// maintained and may be inherently out of date at any time.
//
// Due to all of this unreliability, this should be used as strictly informational
// metadata, e.g. for caller version monitoring, never behavioral (use
// FeatureVersion or feature flags instead).
const LibraryVersion = "1.0.0"

// FeatureVersion is a semver that represents the
// feature set of this cadence client library support.
// This can be used for client capability check, on
// Cadence server, for backward compatibility
// Format: MAJOR.MINOR.PATCH
// FeatureVersion is a semver that informs the server of what high-level behaviors
// this client supports.
// This is sent in a header on every request.
//
// If you wish to tie new behavior to a client release, rather than a feature
// flag, increment the major/minor/patch as seems appropriate here.
//
// It can in principle be inferred from the release version in nearly all
// "normal" scenarios, but release versions are not always available
// (debug.BuildInfo is not guaranteed) and non-released versions do not have any
// way to safely infer behavior. So it is a hard-coded string instead.
const FeatureVersion = "1.7.0"
19 changes: 10 additions & 9 deletions version.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,14 @@ package cadence

import "go.uber.org/cadence/internal"

// LibraryVersion is a semver string that represents
// the version of this cadence client library
// it will be embedded as a "version" header in every
// rpc call made by this client to cadence server.
// In addition, the version string will be used by
// the server to enforce compatibility checks
// Update to this version number is typically done
// by the cadence team as part of a major feature or
// behavior change
// LibraryVersion is a historical way to report the "library release" version,
// prior to go modules providing a far more consistent way to do so.
// It is sent in a header on every request.
//
// deprecated: For your own library-version reporting, use the go module version
// in your build instead, e.g. from runtime/debug.ReadBuildInfo().
// This may drift from the module version, does not report pre-release information,
// and should only be used as a fallback.
//
// This may be removed or changed in a future version.
const LibraryVersion = internal.LibraryVersion

0 comments on commit a072981

Please sign in to comment.