semantic

Documentation

Index

• type Commit
• type ReleaseInfo
• type Repository
  • func New(repoPath string) (*Repository, error)
  • func (r *Repository) Info() (ReleaseInfo, error)
  • func (r *Repository) PushExperimental(user, password, key string) error
• type SemanticVersion

Types

type Commit

type Commit struct {
	Version SemanticVersion
	Hash    string
	Type    string
	Scope   string
	Message string
}

type ReleaseInfo

type ReleaseInfo struct {
	// string representation of latest released version
	LatestVersion string
	// string representation of next possible version
	// will be empty if semantic commits does not exist
	// possible tag of current commit
	CurrentTag  string
	NextVersion string
	// List of commits since current version
	NextCommits []Commit
}

ReleaseInfo contains information about commit considered as release

type Repository

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

func New

func New(repoPath string) (*Repository, error)

func (*Repository) Info

func (r *Repository) Info() (ReleaseInfo, error)

Info returns semantic information about selected repository

func (*Repository) PushExperimental

func (r *Repository) PushExperimental(user, password, key string) error

PushExperimental pushes code to remote repository using provided credentials can be usefull in some CI cases

type SemanticVersion

type SemanticVersion uint8

const (
	VersionInvalid SemanticVersion = iota
	VersionNone
	VersionPatch
	VersionMinor
	VersionMajor
)