versioning

Documentation

Index

• Constants
• func AddVersionReport(ctx context.Context, report VersionReport) error
• func MustGenerate(ctx context.Context) bool
• type BumpType
• type MergedVersionReport
  • func WithVersionReportCapture[T any](ctx context.Context, f func(ctx context.Context) (T, error)) (*MergedVersionReport, T, error)
  • func (m *MergedVersionReport) GetMarkdownSection() string
  • func (m *MergedVersionReport) MustGenerate() bool
• type VersionReport

Constants

const ENV_VAR_PREFIX = "SPEAKEASY_VERSION_REPORT_LOCATION"

Functions

func AddVersionReport

func AddVersionReport(ctx context.Context, report VersionReport) error

func MustGenerate

func MustGenerate(ctx context.Context) bool

Types

type BumpType

type BumpType string

const (
	BumpMajor      BumpType = "major"
	BumpMinor      BumpType = "minor"
	BumpPatch      BumpType = "patch"
	BumpGraduate   BumpType = "graduate"
	BumpPrerelease BumpType = "prerelease"
	BumpCustom     BumpType = "custom"
	BumpNone       BumpType = "none"
)

type MergedVersionReport

type MergedVersionReport struct {
	Reports []VersionReport
}

func WithVersionReportCapture

func WithVersionReportCapture[T any](ctx context.Context, f func(ctx context.Context) (T, error)) (*MergedVersionReport, T, error)

func (*MergedVersionReport) GetMarkdownSection

func (m *MergedVersionReport) GetMarkdownSection() string

func (*MergedVersionReport) MustGenerate

func (m *MergedVersionReport) MustGenerate() bool

type VersionReport

type VersionReport struct {
	Key          string   `json:"key"`
	Priority     int      `json:"priority"`
	BumpType     BumpType `json:"bump_type"`
	NewVersion   string   `json:"new_version"`
	MustGenerate bool     `json:"must_generate"`
	PRReport     string   `json:"pr_report"`
	// contains filtered or unexported fields
}