notes

package

v0.6.0 Latest Latest Go to latest Published: Jan 26, 2023 License: MIT Imports: 14 Imported by: 0

Details

Package notes wraps engine interfaces with common logic unrelated to any particular engine implementation.

This section is empty.

This section is empty.

This section is empty.

type BuildRequest struct {
	Version   string
	FromSHA   string
	ToSHA     string
	ClosedPRs []git.PullRequest
}

BuildRequest is a request for changelog building.

type Builder struct {
	Extras map[string]string
	// contains filtered or unexported fields
}

Builder provides methods to form changelog.

func NewBuilder(cfgPath string, extras map[string]string) (*Builder, error)

NewBuilder creates a new Builder.

func (s *Builder) Build(req BuildRequest) (string, error)

Build builds the changelog for the tag.

type Category struct {
	Title        string
	Labels       []string
	BranchRegexp *regexp.Regexp
}

Category describes pull request category with its title, which will be derived to template and labels, that indicates the belonging to this category.