pkg

Documentation

Index

• type Generator
  • func CreateGenerator(path string, mods ...GeneratorConfigMod) *Generator
  • func (g *Generator) Classify() (err error)
  • func (g *Generator) Generate() (err error)
  • func (g *Generator) ReadCommmits() (err error)
• type GeneratorConfigMod
  • func WithCategories(categories string) GeneratorConfigMod
  • func WithEndReference(endRef string) GeneratorConfigMod
  • func WithOutputToFile(filePath string) GeneratorConfigMod
  • func WithOutputToStdio() GeneratorConfigMod
  • func WithPromo() GeneratorConfigMod
  • func WithStartReference(startRef string) GeneratorConfigMod
• type Releaser
  • func CreateNewReleaser(vString string, mods ...ReleaserMod) (r *Releaser, err error)
  • func (r *Releaser) HasPrerelease() bool
  • func (r *Releaser) String() (s string)
• type ReleaserMod
  • func WithClearPrerelease() ReleaserMod
  • func WithMajorIncrement() ReleaserMod
  • func WithMajorReset() ReleaserMod
  • func WithMinorIncrement() ReleaserMod
  • func WithMinorReset() ReleaserMod
  • func WithPatchIncrement() ReleaserMod
  • func WithPatchReset() ReleaserMod
  • func WithPreTag(preTag string) ReleaserMod
  • func WithPrerelease(pre string) ReleaserMod
  • func WithPrereleaseIncrement() ReleaserMod
  • func WithPrereleaseReset() ReleaserMod

Types

type Generator

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

func CreateGenerator

func CreateGenerator(path string, mods ...GeneratorConfigMod) *Generator

func (*Generator) Classify

func (g *Generator) Classify() (err error)

func (*Generator) Generate

func (g *Generator) Generate() (err error)

func (*Generator) ReadCommmits

func (g *Generator) ReadCommmits() (err error)

ReadCommmits will try to collect commits in the given range or default to current tag to the previous tag or current commit to recent tag, in the same order of priority

type GeneratorConfigMod

type GeneratorConfigMod func(*Generator)

func WithCategories

func WithCategories(categories string) GeneratorConfigMod

func WithEndReference

func WithEndReference(endRef string) GeneratorConfigMod

func WithOutputToFile

func WithOutputToFile(filePath string) GeneratorConfigMod

func WithOutputToStdio

func WithOutputToStdio() GeneratorConfigMod

func WithPromo

func WithPromo() GeneratorConfigMod

func WithStartReference

func WithStartReference(startRef string) GeneratorConfigMod

type Releaser

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

func CreateNewReleaser

func CreateNewReleaser(vString string, mods ...ReleaserMod) (r *Releaser, err error)

func (*Releaser) HasPrerelease

func (r *Releaser) HasPrerelease() bool

func (*Releaser) String

func (r *Releaser) String() (s string)

type ReleaserMod

type ReleaserMod func(*Releaser)

func WithClearPrerelease

func WithClearPrerelease() ReleaserMod

func WithMajorIncrement

func WithMajorIncrement() ReleaserMod

func WithMajorReset

func WithMajorReset() ReleaserMod

func WithMinorIncrement

func WithMinorIncrement() ReleaserMod

func WithMinorReset

func WithMinorReset() ReleaserMod

func WithPatchIncrement

func WithPatchIncrement() ReleaserMod

func WithPatchReset

func WithPatchReset() ReleaserMod

func WithPreTag

func WithPreTag(preTag string) ReleaserMod

func WithPrerelease

func WithPrerelease(pre string) ReleaserMod

func WithPrereleaseIncrement

func WithPrereleaseIncrement() ReleaserMod

func WithPrereleaseReset

func WithPrereleaseReset() ReleaserMod