semrel

package

v0.1.9 Latest Latest Go to latest Published: Oct 6, 2020 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func CreateSemanticReleaseCommand() *cobra.Command

CreateSemanticReleaseCommand creates the root Semantic Release command

type Change struct {
	Commit        git.Commit
	Major         bool
	Minor         bool
	ParsedMessage ParsedCommitMessage
}

Change represents a change that will go out

func CalculateChange(commit git.Commit) Change

CalculateChange calculates a changed out of a commit

func (c Change) String() string

type ParsedCommitMessage struct {
	Body    string
	Footer  string
	Scope   string
	Subject string
	Type    string
}

ParsedCommitMessage represents a commit message that was parsed from a message in the format followed by the Semantic Release format. This format was adopted from the Angular.js community and you can read more here: https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines

func ParseCommitMessage(commitMessage string) *ParsedCommitMessage

ParseCommitMessage parses a commit message

type Release struct {
	Changes []Change
	Version semver.Version
}

Release represents a group of changes that will be released

func CalculateNextRelease(latestVersion semver.Version, commits []git.Commit) (Release, error)

CalculateNextRelease will calculate what will go out in the next release, and if it is a major, minor or patch change.

func (release Release) ChangeLog() string

ChangeLog returns a string representing the change log for the release, in markdown format

func (release Release) ChangesByType() map[string][]Change

ChangesByType group the changes for the release by their type