tag

Documentation

Index

• type Tag
  • func (t *Tag) Condition(source string) (bool, error)
  • func (t *Tag) ConditionFromSCM(source string, scm scm.Scm) (bool, error)
  • func (t *Tag) Source(workingDir string) (string, error)
  • func (t *Tag) Target(source string, dryRun bool) (changed bool, err error)
  • func (t *Tag) TargetFromSCM(source string, scm scm.Scm, dryRun bool) (changed bool, files []string, message string, err error)
  • func (t *Tag) Validate() error

Types

type Tag

type Tag struct {
	Path          string         // Path contains the git repository path
	VersionFilter version.Filter // VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
	Message       string         // Message associated to the git Tag
}

Tag contains git tag information

func (*Tag) Condition

func (t *Tag) Condition(source string) (bool, error)

Condition checks that a git tag exists

func (*Tag) ConditionFromSCM

func (t *Tag) ConditionFromSCM(source string, scm scm.Scm) (bool, error)

ConditionFromSCM test if a tag exist from a git repository specific from SCM

func (*Tag) Source

func (t *Tag) Source(workingDir string) (string, error)

Source return the latest git tag based on create time

func (*Tag) Target

func (t *Tag) Target(source string, dryRun bool) (changed bool, err error)

Target create a tag if needed from a local git repository, without pushing the tag

func (*Tag) TargetFromSCM

func (t *Tag) TargetFromSCM(source string, scm scm.Scm, dryRun bool) (changed bool, files []string, message string, err error)

TargetFromSCM create and push a git tag based on the SCM configuration

func (*Tag) Validate

func (t *Tag) Validate() error

Validate tests that tag struct is correctly configured