commit

Sep 12, 2026

Changes in this version

type PlannerOptions

+ AddPaths []string

type StageMode

+ const StageScoped

Aug 19, 2026

Changes in this version

type GitBackend

+ Cfg *config.Config

Aug 4, 2026

Changes in this version

type Plan

+ Origin string

type PlannerOptions

+ Origin string

Jul 11, 2026

Changes in this version

+ type ConfirmRequiredError struct

+ Detail string

+ func (e *ConfirmRequiredError) Error() string

+ type DecisionRequiredError struct

+ Choices []string

+ Detail string

+ func (e *DecisionRequiredError) Error() string

type Engine

+ func (e *Engine) Execute(plan gitplan.Plan, opts ExecuteOptions) (*ExecuteResult, error)

+ func (e *Engine) Plan(policy gitplan.Policy) gitplan.Plan

+ func (e *Engine) PlanPull(policy gitplan.Policy) gitplan.Plan

+ func (e *Engine) PlanTo(remote, branch string, policy gitplan.Policy) (gitplan.Plan, error)

+ type ErrReplayCorruption struct

+ Actual []string

+ Commit string

+ Expected []string

+ func (e *ErrReplayCorruption) Error() string

+ type ExecuteOptions struct

+ Approved bool

+ type ExecuteResult struct

+ Performed []gitplan.OpKind

+ type RefusedError struct

+ Detail string

+ func (e *RefusedError) Error() string

Jun 4, 2026

Changes in this version

+ func Replay(session *gitstate.SyncSession) error

+ func RunCommitMsgHook(repoRoot, message string, cb func(stream, line string)) (string, error)

+ func RunHook(repoRoot, hookName string, args []string, input []byte, ...) error

+ func RunPostCommitHook(repoRoot string, cb func(stream, line string))

+ func RunPreCommitHook(repoRoot string, wt *git.Worktree, cb func(stream, line string)) error

+ type CommitBlock struct

+ ID string

+ Message string

+ Ring CommitRing

+ func (b CommitBlock) Overrideable() bool

+ type CommitBlocks []CommitBlock

+ func (bs CommitBlocks) GovernanceOnly() CommitBlocks

+ func (bs CommitBlocks) HasDeterminism() bool

+ func (bs CommitBlocks) HasGovernance() bool

+ func (bs CommitBlocks) HasHard() bool

+ func (bs CommitBlocks) HasMechanical() bool

+ type CommitRing string

+ const RingDeterminism

+ const RingGovernance

+ const RingMechanical

+ type Engine struct

+ func NewEngine(session *gitstate.SyncSession, opts EngineOptions) *Engine

+ func (e *Engine) Sync() (*SyncResult, error)

+ type EngineOptions struct

+ OnEvent func(gitstate.TransitionEvent)

+ RebaseOnDiverge bool

+ Refspec string

+ Remote string

type GitBackend

+ func (g *GitBackend) Push(opts PushOptions) (*SyncResult, error)

type PushOptions

+ RebaseOnDiverge bool

type Result

+ MaintainerOverride bool

+ OverriddenBlocks CommitBlocks

+ Sync *SyncResult

+ type SyncAction string

+ const SyncFastForward

+ const SyncFetch

+ const SyncNoop

+ const SyncPush

+ const SyncRebase

+ const SyncSetUpstream

+ type SyncResult struct

+ ActionsExecuted []SyncAction

+ Noop bool

+ PushedRef string

Apr 4, 2026

Changes in this version

type GitBackend

+ OnCommitLine func(stream string, line string)

+ type StreamHandlers struct

+ OnStderrLine func(string)

+ OnStdoutLine func(string)

+ type StreamResult struct

+ ExitCode int

+ Stderr []byte

+ Stdout []byte

Mar 13, 2026

Changes in this version

+ func BranchFromRefspec(refspec string) string

+ type Backend interface

+ Execute func(ctx context.Context, plan *Plan, conventional bool) (*Result, error)

+ type DryRunBackend struct

+ RootDir string

+ func (d *DryRunBackend) Execute(_ context.Context, plan *Plan, conventional bool) (*Result, error)

+ type FileChange struct

+ Deleted bool

+ Path string

+ type ForgeBackend struct

+ Branch string

+ ForgeClient forge.Forge

+ RootDir string

+ func (f *ForgeBackend) Execute(ctx context.Context, plan *Plan, conventional bool) (*Result, error)

+ type GitBackend struct

+ RootDir string

+ func (g *GitBackend) Execute(_ context.Context, plan *Plan, conventional bool) (*Result, error)

+ type Plan struct

+ Body string

+ Breaking bool

+ Paths []string

+ Push PushOptions

+ Scope string

+ SignOff bool

+ SkipCI bool

+ StageMode StageMode

+ Summary string

+ Type string

+ func BuildPlan(opts PlannerOptions, cfg config.CommitConfig, registry *TypeRegistry, ...) (*Plan, error)

+ func (p Plan) Message(conventional bool) string

+ func (p Plan) Subject(conventional bool) string

+ type PlannerOptions struct

+ All bool

+ Body string

+ Breaking bool

+ Message string

+ Paths []string

+ Push *bool

+ Refspec string

+ Remote string

+ Scope string

+ SignOff bool

+ SkipCI *bool

+ Type string

+ type PushOptions struct

+ Enabled bool

+ Refspec string

+ Remote string

+ type Result struct

+ Backend string

+ Files []string

+ Message string

+ NoOp bool

+ Pushed bool

+ SHA string

+ type StageMode string

+ const StageAll

+ const StageExplicit

+ const StageStaged

+ type TypeRegistry struct

+ func NewTypeRegistry(types []config.CommitType) *TypeRegistry

+ func (r *TypeRegistry) List() []config.CommitType

+ func (r *TypeRegistry) Resolve(key string) (resolvedKey string, forceBang bool, err error)

+ func (r *TypeRegistry) Valid(key string) bool