commit_msg

Documentation

Index

• Constants
• func FakeCommitMsgInputs() (*revision.Revision, *revision.Revision, []*revision.Revision, []string, ...)
• type Builder
  • func NewBuilder(c *config.CommitMsgConfig, reg *config_vars.Registry, ...) (*Builder, error)
  • func (b *Builder) Build(from, to *revision.Revision, rolling []*revision.Revision, ...) (string, error)

Constants

const (
	// TmplNameAndroid is the name of the commit message template used by
	// rollers which roll into Android.
	TmplNameAndroid = "android"

	// TmplNameAndroidNoCR is the name of the commit message template used by
	// rollers which roll into Android where the service account does not
	// have CR+2 access.
	TmplNameAndroidNoCR = "android_nocr"
)

const (
	// TmplNameCanary is the name of the commit message template used by
	// canary rolls.
	TmplNameCanary = "canary"
)

const (
	// TmplNameDefault is the name of the default commit message template which
	// is suitable for most rollers.
	TmplNameDefault = "default"
)

Functions

func FakeCommitMsgInputs

func FakeCommitMsgInputs() (*revision.Revision, *revision.Revision, []*revision.Revision, []string, []string, bool, string)

FakeCommitMsgInputs returns Revisions which may be used to validate commit message templates.

Types

type Builder

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

Builder is a helper used to build commit messages.

func NewBuilder

func NewBuilder(c *config.CommitMsgConfig, reg *config_vars.Registry, childName, parentName, serverURL, childBugLink, parentBugLink string, transitiveDeps []*config.TransitiveDepConfig) (*Builder, error)

NewBuilder returns a Builder instance.

func (*Builder) Build

func (b *Builder) Build(from, to *revision.Revision, rolling []*revision.Revision, reviewers, contacts []string, canary bool, manualRollRequester string) (string, error)

Build a commit message for the given roll.