release

Documentation

Index

• Variables
• func DetectPlatform() (string, error)
• func GenerateReleaseNotes(commits []*semrel.Commit, filters *Filters, matchRules []*MatchRule) string
• func NewGithubReleaser(token, owner, repo, branch string) (*githubReleaser, error)
• func NewGitlabReleaser(token, projectID, branch string) (*gitlabReleaser, error)
• type ErrUnsupportedPlatform
  • func NewErrUnsupportedPlatform(platform string) *ErrUnsupportedPlatform
  • func (e *ErrUnsupportedPlatform) Error() string
• type Filters
  • func (f *Filters) MatchScope(s string) bool
  • func (f *Filters) MatchType(t string) bool
• type MatchRule
  • func NewMatchRule(pattern, replace string) (*MatchRule, error)
  • func (r *MatchRule) Apply(s string) string
• type Releaser
  • func Platform(platform, token, projectID, branch string) (Releaser, error)

Variables

var ErrPlatformDetectionFailed = errors.New("failed to detect platform")

Functions

func DetectPlatform

func DetectPlatform() (string, error)

func GenerateReleaseNotes

func GenerateReleaseNotes(commits []*semrel.Commit, filters *Filters, matchRules []*MatchRule) string

func NewGithubReleaser

func NewGithubReleaser(token, owner, repo, branch string) (*githubReleaser, error)

func NewGitlabReleaser

func NewGitlabReleaser(token, projectID, branch string) (*gitlabReleaser, error)

Types

type ErrUnsupportedPlatform

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

func NewErrUnsupportedPlatform

func NewErrUnsupportedPlatform(platform string) *ErrUnsupportedPlatform

func (*ErrUnsupportedPlatform) Error

func (e *ErrUnsupportedPlatform) Error() string

type Filters

type Filters struct {
	Types  []string
	Scopes []string
}

Filters matches types and scopes in conventional commits, and excludes them from release notes.

func (*Filters) MatchScope

func (f *Filters) MatchScope(s string) bool

func (*Filters) MatchType

func (f *Filters) MatchType(t string) bool

type MatchRule

type MatchRule struct {
	Match   *regexp.Regexp
	Replace string
}

MatchRule holds one regex + replacement template.

func NewMatchRule

func NewMatchRule(pattern, replace string) (*MatchRule, error)

NewMatchRule creates a new MatchRule with the given regex pattern and replacement template.

func (*MatchRule) Apply

func (r *MatchRule) Apply(s string) string

Apply runs the regex on s, substituting every match according to the Replace template (using $1, $2, … for capture groups).

type Releaser

type Releaser interface {
	Release(tag, notes string) error
}

func Platform

func Platform(platform, token, projectID, branch string) (Releaser, error)