workspace

type BumpLevel ¶

type BumpLevel int

const (
	BumpLevelNone  BumpLevel = 0
	BumpLevelPatch BumpLevel = 1
	BumpLevelMinor BumpLevel = 2
	BumpLevelMajor BumpLevel = 3
)

func (b BumpLevel) String() string

type Commit ¶

type Commit struct {
	SHA  string
	When time.Time
}

Commit identifies the commit that introduced a bump file.

type CommitCheckpoint ¶ added in v0.0.7

type CommitCheckpoint struct {
	// Batch fingerprints the pending bump files (base name -> content hash)
	// the checkpoint belongs to. A retry with different pending bumps is a
	// different batch and must not reuse this checkpoint.
	Batch map[string]string `toml:"batch"`
	// Released maps release group names to the version released for them in
	// a previous attempt at this batch.
	Released map[string]string `toml:"released"`
}

CommitCheckpoint records the progress of a partially failed `bumper commit` so a retry can skip release groups whose commands already succeeded. It is written after each group completes and removed once the whole batch has been released.

func LoadCommitCheckpoint(dir string) (*CommitCheckpoint, error)

type Config ¶

type Config struct {
	Groups []ReleaseGroup `json:"groups,omitempty,omitzero" toml:"groups,omitempty,omitzero" yaml:"groups,omitempty,omitzero"`
}

func LoadConfig(baseDir string) (*Config, error)

func (c *Config) IndexReleaseGroups() map[string]ReleaseGroup

type ExecRunner ¶ added in v0.0.7

type ExecRunner struct{}

ExecRunner runs group commands as child processes with stderr passed through to the parent process.

func (ExecRunner) Run(ctx context.Context, dir string, inv GroupInvocation, stdout io.Writer) error

type FakeProvenance ¶ added in v0.0.7

type FakeProvenance struct {
	Commits map[string]Commit
}

FakeProvenance serves canned commits from memory so callers can be tested without a git repository.

func (f *FakeProvenance) Resolve(_ context.Context, bumpFiles []string) (map[string]Commit, error)

type FakeRunner ¶ added in v0.0.7

type FakeRunner struct {
	Calls  []FakeRunnerCall
	Stdout map[Verb]string
	Err    error
}

FakeRunner records every invocation and plays back canned stdout per verb so callers can be tested without spawning processes.

func (f *FakeRunner) Run(_ context.Context, dir string, inv GroupInvocation, stdout io.Writer) error

type FakeRunnerCall ¶ added in v0.0.7

type FakeRunnerCall struct {
	Dir        string
	Invocation GroupInvocation
}

type GitProvenance ¶ added in v0.0.7

type GitProvenance struct {
	Logger *slog.Logger
	Dir    string
}

GitProvenance resolves bump-file provenance from the git repository containing Dir, deepening shallow clones as needed. A directory outside any git repository degrades to empty results with a warning.

func NewGitProvenance(logger *slog.Logger, dir string) *GitProvenance

func (g *GitProvenance) Resolve(ctx context.Context, bumpFiles []string) (map[string]Commit, error)

type GroupInvocation ¶ added in v0.0.7

type GroupInvocation struct {
	Verb Verb
	Argv []string
	Env  []string
}

GroupInvocation is a fully-resolved group command: the argv to execute and the BUMPER_* environment variables that carry the protocol inputs. Env holds KEY=VALUE pairs appended to the parent process environment.

func NewCatInvocation(group ReleaseGroup, version string) (GroupInvocation, error)

func NewChangelogInvocation(group ReleaseGroup, nextVersion string, status *ReleaseGroupStatus) (GroupInvocation, error)

func NewCurrentInvocation(group ReleaseGroup) (GroupInvocation, error)

func NewNextInvocation(group ReleaseGroup, nextVersion string) (GroupInvocation, error)

type InvalidConfigError ¶ added in v0.0.5

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

func (e *InvalidConfigError) Error() string

type LogEntry ¶ added in v0.0.5

type LogEntry struct {
	Timestamp int64
	Commit    string
	Content   string
}

type ParsedBump ¶ added in v0.0.7

type ParsedBump struct {
	File    string
	Levels  map[string]string
	Message string
	Commit  *Commit
}

ParsedBump is one bump file's parsed content plus its provenance: the levels recorded per release group, the changelog message, and the commit that introduced the file (nil when unresolved).

func GatherBumps(ctx context.Context, logger *slog.Logger, dir string, provenance Provenance) ([]ParsedBump, error)

type Provenance ¶ added in v0.0.7

type Provenance interface {
	Resolve(ctx context.Context, bumpFiles []string) (map[string]Commit, error)
}

Provenance resolves the commit that introduced each bump file. Files that cannot be resolved are absent from the returned map; callers treat that as "no provenance" rather than an error.

type ReleaseGroup ¶

type ReleaseGroup struct {
	Name         string   `json:"name" toml:"name" yaml:"name"`
	DisplayName  string   `json:"display_name,omitempty" toml:"display_name,omitempty" yaml:"display_name,omitempty"`
	ChangelogCMD []string `json:"changelog_cmd,omitempty,omitzero" toml:"changelog_cmd,omitempty,omitzero" yaml:"changelog_cmd,omitempty,omitzero"`
	CatCMD       []string `json:"cat_cmd,omitempty,omitzero" toml:"cat_cmd,omitempty,omitzero" yaml:"cat_cmd,omitempty,omitzero"`
	CurrentCMD   []string `json:"current_cmd,omitempty,omitzero" toml:"current_cmd,omitempty,omitzero" yaml:"current_cmd,omitempty,omitzero"`
	NextCMD      []string `json:"next_cmd,omitempty,omitzero" toml:"next_cmd,omitempty,omitzero" yaml:"next_cmd,omitempty,omitzero"`
}

type ReleaseGroupStatus ¶ added in v0.0.5

type ReleaseGroupStatus struct {
	Level     BumpLevel
	MajorLogs []LogEntry
	MinorLogs []LogEntry
	PatchLogs []LogEntry
}

type Runner ¶ added in v0.0.7

type Runner interface {
	Run(ctx context.Context, dir string, inv GroupInvocation, stdout io.Writer) error
}

Runner executes resolved group commands. ExecRunner is the process-spawning implementation; FakeRunner substitutes in tests.

type Verb ¶ added in v0.0.7

type Verb string

Verb identifies one of the group-command hooks a release group configures in .bumper/config.toml.

const (
	VerbCurrent   Verb = "current"
	VerbNext      Verb = "next"
	VerbChangelog Verb = "changelog"
	VerbCat       Verb = "cat"
)