version

Documentation

Index

• Constants
• func Set(ver *Version) error
• func SetForBranch(ver *Version, branch string) (act action.Action, err error)
• type Config
  • func LoadConfig() (*Config, error)
• type LocalConfig
  • func (local *LocalConfig) PromptUserForConfig() error
  • func (local *LocalConfig) Validate() error
• type Version
  • func FromTag(tag string) (*Version, error)
  • func Get() (*Version, error)
  • func GetByBranch(branch string) (ver *Version, err error)
  • func Parse(versionString string) (*Version, error)
  • func (v *Version) BaseString() string
  • func (v *Version) Clone() *Version
  • func (v *Version) IncrementMinor() *Version
  • func (v *Version) IncrementPatch() *Version
  • func (v *Version) ReleaseTagString() string
  • func (v *Version) Set(versionString string) error
  • func (v *Version) ToStableVersion() (*Version, error)
  • func (v *Version) ToStageVersion() (*Version, error)
  • func (v *Version) ToTestingVersion() (*Version, error)
  • func (v *Version) ToTrunkVersion() (*Version, error)
  • func (v *Version) Zero() bool
• type Versions
  • func (vs Versions) Len() int
  • func (vs Versions) Less(i, j int) bool
  • func (vs Versions) Swap(i, j int)

Constants

const ConfigKey = "salsaflow.core.versioning"

Functions

func Set

func Set(ver *Version) error

Set runs the set_version script.

func SetForBranch

func SetForBranch(ver *Version, branch string) (act action.Action, err error)

Types

type Config

type Config struct {
	TrunkSuffix   semver.PRVersion
	TestingSuffix semver.PRVersion
	StagingSuffix semver.PRVersion
}

func LoadConfig

func LoadConfig() (*Config, error)

LoadConfig can be used to load versioning-related configuration for SalsaFlow.

type LocalConfig

type LocalConfig struct {
	TrunkSuffix   string `prompt:"trunk version string suffix"   default:"dev"   json:"trunk_suffix"`
	TestingSuffix string `prompt:"testing version string suffix" default:"qa"    json:"testing_suffix"`
	StagingSuffix string `prompt:"staging version string suffix" default:"stage" json:"staging_suffix"`
}

func (*LocalConfig) PromptUserForConfig

func (local *LocalConfig) PromptUserForConfig() error

func (*LocalConfig) Validate

func (local *LocalConfig) Validate() error

type Version

type Version struct {
	semver.Version
}

func FromTag

func FromTag(tag string) (*Version, error)

func Get

func Get() (*Version, error)

Get runs the get_version script.

func GetByBranch

func GetByBranch(branch string) (ver *Version, err error)

func Parse

func Parse(versionString string) (*Version, error)

func (*Version) BaseString

func (v *Version) BaseString() string

BaseString only returns MAJOR.MINOR.PATCH

func (*Version) Clone

func (v *Version) Clone() *Version

func (*Version) IncrementMinor

func (v *Version) IncrementMinor() *Version

func (*Version) IncrementPatch

func (v *Version) IncrementPatch() *Version

func (*Version) ReleaseTagString

func (v *Version) ReleaseTagString() string

func (*Version) Set

func (v *Version) Set(versionString string) error

Set implements flag.Value interface.

func (*Version) ToStableVersion

func (v *Version) ToStableVersion() (*Version, error)

func (*Version) ToStageVersion

func (v *Version) ToStageVersion() (*Version, error)

func (*Version) ToTestingVersion

func (v *Version) ToTestingVersion() (*Version, error)

func (*Version) ToTrunkVersion

func (v *Version) ToTrunkVersion() (*Version, error)

func (*Version) Zero

func (v *Version) Zero() bool

type Versions

type Versions []*Version

Versions implement sort.Interface

func (Versions) Len

func (vs Versions) Len() int

func (Versions) Less

func (vs Versions) Less(i, j int) bool

func (Versions) Swap

func (vs Versions) Swap(i, j int)