versioning

Documentation

Index

• type Artifact
  • func GetArtifact(buildTool, buildDescriptorFilePath string, opts *Options, ...) (Artifact, error)
• type Docker
  • func (d *Docker) GetVersion() (string, error)
  • func (d *Docker) SetVersion(version string) error
  • func (d *Docker) VersioningScheme() string
• type INIfile
  • func (i *INIfile) GetVersion() (string, error)
  • func (i *INIfile) SetVersion(version string) error
  • func (i *INIfile) VersioningScheme() string
• type JSONfile
  • func (j *JSONfile) GetVersion() (string, error)
  • func (j *JSONfile) SetVersion(version string) error
  • func (j *JSONfile) VersioningScheme() string
• type Maven
  • func (m *Maven) GetVersion() (string, error)
  • func (m *Maven) SetVersion(version string) error
  • func (m *Maven) VersioningScheme() string
• type Options
• type Versionfile
  • func (v *Versionfile) GetVersion() (string, error)
  • func (v *Versionfile) SetVersion(version string) error
  • func (v *Versionfile) VersioningScheme() string
• type YAMLfile
  • func (y *YAMLfile) GetVersion() (string, error)
  • func (y *YAMLfile) SetVersion(version string) error
  • func (y *YAMLfile) VersioningScheme() string

Types

type Artifact

type Artifact interface {
	VersioningScheme() string
	GetVersion() (string, error)
	SetVersion(string) error
}

Artifact defines the versioning operations for various build tools

func GetArtifact

func GetArtifact(buildTool, buildDescriptorFilePath string, opts *Options, execRunner mavenExecRunner) (Artifact, error)

GetArtifact returns the build tool specific implementation for retrieving version, etc. of an artifact

type Docker

type Docker struct {
	// contains filtered or unexported fields
}

Docker defines an artifact based on a Dockerfile

func (*Docker) GetVersion

func (d *Docker) GetVersion() (string, error)

GetVersion returns the current version of the artifact

func (*Docker) SetVersion

func (d *Docker) SetVersion(version string) error

SetVersion updates the version of the artifact

func (*Docker) VersioningScheme

func (d *Docker) VersioningScheme() string

VersioningScheme returns the relevant versioning scheme

type INIfile

type INIfile struct {
	// contains filtered or unexported fields
}

INIfile defines an artifact using a json file for versioning

func (*INIfile) GetVersion

func (i *INIfile) GetVersion() (string, error)

GetVersion returns the current version of the artifact with a ini-file-based build descriptor

func (*INIfile) SetVersion

func (i *INIfile) SetVersion(version string) error

SetVersion updates the version of the artifact with a ini-file-based build descriptor

func (*INIfile) VersioningScheme

func (i *INIfile) VersioningScheme() string

VersioningScheme returns the relevant versioning scheme

type JSONfile

type JSONfile struct {
	// contains filtered or unexported fields
}

JSONfile defines an artifact using a json file for versioning

func (*JSONfile) GetVersion

func (j *JSONfile) GetVersion() (string, error)

GetVersion returns the current version of the artifact with a JSON-based build descriptor

func (*JSONfile) SetVersion

func (j *JSONfile) SetVersion(version string) error

SetVersion updates the version of the artifact with a JSON-based build descriptor

func (*JSONfile) VersioningScheme

func (j *JSONfile) VersioningScheme() string

VersioningScheme returns the relevant versioning scheme

type Maven

type Maven struct {
	// contains filtered or unexported fields
}

Maven defines a maven artifact used for versioning

func (*Maven) GetVersion

func (m *Maven) GetVersion() (string, error)

GetVersion returns the current version of the artifact

func (*Maven) SetVersion

func (m *Maven) SetVersion(version string) error

SetVersion updates the version of the artifact

func (*Maven) VersioningScheme

func (m *Maven) VersioningScheme() string

VersioningScheme returns the relevant versioning scheme

type Options

type Options struct {
	ProjectSettingsFile string
	GlobalSettingsFile  string
	M2Path              string
	VersionSource       string
	VersionSection      string
	VersionField        string
	VersioningScheme    string
}

Options define build tool specific settings in order to properly retrieve e.g. the version of an artifact

type Versionfile

type Versionfile struct {
	// contains filtered or unexported fields
}

Versionfile defines an artifact containing the version in a file, e.g. VERSION

func (*Versionfile) GetVersion

func (v *Versionfile) GetVersion() (string, error)

GetVersion returns the current version of the artifact

func (*Versionfile) SetVersion

func (v *Versionfile) SetVersion(version string) error

SetVersion updates the version of the artifact

func (*Versionfile) VersioningScheme

func (v *Versionfile) VersioningScheme() string

VersioningScheme returns the relevant versioning scheme

type YAMLfile

type YAMLfile struct {
	// contains filtered or unexported fields
}

YAMLfile defines an artifact using a yaml file for versioning

func (*YAMLfile) GetVersion

func (y *YAMLfile) GetVersion() (string, error)

GetVersion returns the current version of the artifact with a YAML-based build descriptor

func (*YAMLfile) SetVersion

func (y *YAMLfile) SetVersion(version string) error

SetVersion updates the version of the artifact with a YAML-based build descriptor

func (*YAMLfile) VersioningScheme

func (y *YAMLfile) VersioningScheme() string

VersioningScheme returns the relevant versioning scheme