release

Documentation

Index

• type Release
  • func GenerateReleasesBetweenTags(baseVersion, headVersion *version.Version, tagPrefix string) ([]Release, error)
  • func (r *Release) Filename(fileExt string) string
  • func (r *Release) GenerateMarkdownChangelog(w io.Writer) error
  • func (r *Release) GetPullRequestSections() (feature []github.PullRequest, bugfix []github.PullRequest, ...)
  • func (r *Release) GithubURL() string
  • func (r *Release) PushToGithub(overwrite bool) error
  • func (r *Release) PushToSlack(channel, iconURL string) error
  • func (r *Release) TagName() string

Types

type Release

type Release struct {
	Tag          githubutil.Tag
	Repository   githubutil.Repository
	Commits      []github.RepositoryCommit
	PullRequests []github.PullRequest
}

Release is a wrapper of github data containing merged prs and commits between two tags. The tag of the release is the one to create release notes for

func GenerateReleasesBetweenTags

func GenerateReleasesBetweenTags(baseVersion, headVersion *version.Version, tagPrefix string) ([]Release, error)

GenerateReleasesBetweenTags generates a release array containing all releases between two tags. For instance sending in v1.10.0 and v1.10.4 will generate a release array containing v1.10.0, v1.10.1, v1.10.2, v1.10.3 and v1.10.4

func (*Release) Filename

func (r *Release) Filename(fileExt string) string

Filename returns an appropriate filename based on the git tag of the release For instance tag 'v1.2.3' returns 'v1_2_3.[fileExt]'

func (*Release) GenerateMarkdownChangelog

func (r *Release) GenerateMarkdownChangelog(w io.Writer) error

GenerateMarkdownChangelog writes a markdown changelog file to the provided writer

func (*Release) GetPullRequestSections

func (r *Release) GetPullRequestSections() (
	feature []github.PullRequest,
	bugfix []github.PullRequest,
	hotfix []github.PullRequest,
	other []github.PullRequest,
)

GetPullRequestSections returns the different pull request groups of a release

func (*Release) GithubURL

func (r *Release) GithubURL() string

GithubURL returns the Github URL for the release

func (*Release) PushToGithub

func (r *Release) PushToGithub(overwrite bool) error

PushToGithub pushes a release to github. If the release already exists, it won't be pushed if the overwrite argument is not present

func (*Release) PushToSlack

func (r *Release) PushToSlack(channel, iconURL string) error

PushToSlack pushes release notes to the slack channel specified

func (*Release) TagName

func (r *Release) TagName() string

TagName returns the git tag for a release