versionctrl

Documentation

Overview

Prepare or load Version.go in fixed directory `./pkg/version/version.go`

Index

• type Version
  • func VersionInit(vs, pn string, path ...string) (*Version, error)
  • func VersionLoad(path ...string) (*Version, error)
  • func (v *Version) Increment(op string) error
  • func (v *Version) String() string

Types

type Version

type Version struct {
	PackageName string
	Major       uint64
	Minor       uint64
	Patch       uint64
	// contains filtered or unexported fields
}

Version encapsulates a semantic version as well as a package name.

func VersionInit

func VersionInit(vs, pn string, path ...string) (*Version, error)

Init initializes a `Version.go` file with the specified version string and package name.

func VersionLoad

func VersionLoad(path ...string) (*Version, error)

Load reads `Version.go` in the current directory and loads it into a `*Version` instance.

func (*Version) Increment

func (v *Version) Increment(op string) error

Increment loads the version from the current directory and updates the appropriate component of the semantic version (major, minor or patch).

func (*Version) String

func (v *Version) String() string

String implements the stringer interface for `Version`.