actions

package

Go to main page

Versions in this module

v0

v0.27.1

Sep 11, 2026

v0.27.0

Sep 5, 2026

Changes in this version

type GetHandler

+ ReportLandedAncestors func(report LandedAncestorReport) (LandedAncestorDecision, error)

type GetNullHandler

+ func (h *GetNullHandler) ReportLandedAncestors(_ LandedAncestorReport) (LandedAncestorDecision, error)

+ type LandedAncestorDecision int

+ const LeaveFrozen

+ const UnfreezeAndRestack

+ type LandedAncestorReport struct

+ CanRestack bool

+ Reanchored []Reanchored

+ Stale []StaleBranch

+ func (r LandedAncestorReport) Unanchored() []string

+ func (r LandedAncestorReport) Unfreezable() []string

+ type Reanchored struct

+ Anchor string

+ Branch string

+ LandedPR *int

+ LandedParent string

+ NewParent string

+ type RenameHandler interface

+ PromptNewName func(currentName string) (string, error)

+ type StaleBranch struct

+ Anchored bool

+ Frozen bool

+ Name string

v0.26.1

Aug 15, 2026

v0.26.0

Aug 15, 2026

v0.25.0

Aug 11, 2026

Changes in this version

+ func EnsureCanModifyHere(ctx *app.Context, branches ...engine.Branch) error

+ func EnsureCanModifyNamesHere(ctx *app.Context, branchNames ...string) error

+ func PRNumberForBranch(eng engine.BranchStatus, branchName string) *int

+ func ResolveConflictWorkflow(ctx *app.Context, stackBranches engine.Branches) error

+ func WarnIfLinearStackRestored(ctx *app.Context, operation string)

type CleanBranchesResult

+ SkippedCheckedOut []string

type ContinuationStateInfo

+ ExpectedBranchRevision string

+ type CurrentBranchReader interface

+ CurrentBranch func() *engine.Branch

type RestackProgress

+ HeldBy string

+ type RestackWorktreeHold struct

+ Branch string

+ Reason string

+ Scope RestackWorktreeHoldScope

+ StackRoot string

+ WorktreePath string

+ type RestackWorktreeHoldReport struct

+ Holds []RestackWorktreeHold

+ Warnings []string

+ func RestackWorktreeHolds(ctx *app.Context) RestackWorktreeHoldReport

+ type RestackWorktreeHoldScope string

+ const RestackWorktreeHoldBranch

+ const RestackWorktreeHoldStack

v0.24.0

Jul 31, 2026

Changes in this version

+ func OpenPRAction(ctx *app.Context, opts OpenPROptions) error

+ func SetBrowserOpener(fn func(url string) error)

type ModifyOptions

+ Into string

+ type OpenPROptions struct

+ Stack bool

+ Target string

v0.23.0

Jul 27, 2026

Changes in this version

+ type BranchDiffStats struct

+ Additions int

+ Deletions int

+ FilesChanged int

+ type BranchInfoPR struct

+ Body string

+ IsDraft bool

+ Number *int

+ State git.PRState

+ Title string

+ URL string

+ type BranchInfoQueryOptions struct

+ BranchName string

+ Diff bool

+ Patch bool

+ Stat bool

+ type BranchInfoResult struct

+ Children []string

+ CommitDate string

+ CommitMessages []string

+ DiffOutput string

+ DiffStats BranchDiffStats

+ IsCurrent bool

+ IsFrozen bool

+ IsLocked bool

+ IsTrunk bool

+ Name string

+ NeedsRestack bool

+ PR *BranchInfoPR

+ Parent string

+ PatchOutput string

+ Scope string

+ StackDescription string

+ StackTitle string

+ Trunk string

+ func QueryBranchInfo(ctx context.Context, eng engine.Engine, opts BranchInfoQueryOptions, ...) (BranchInfoResult, error)

+ type StackInfoBranch struct

+ CommitMessages []string

+ DiffStats BranchDiffStats

+ IsFrozen bool

+ IsLocked bool

+ Name string

+ PRNumber *int

+ PRURL string

+ Parent string

+ Scope string

+ type StackInfoResult struct

+ Branches []StackInfoBranch

+ Current string

+ Order []string

+ Parents map[string]string

+ StackDescription string

+ StackTitle string

+ Trunk string

+ UpToDate map[string]bool

+ func QueryStackInfo(ctx context.Context, eng engine.Engine) (StackInfoResult, error)

v0.22.0

Jul 20, 2026

Changes in this version

+ type ReviewStatus string

+ const ReviewApproved

+ const ReviewChangesRequested

+ const ReviewRequired

+ type TreeStyle string

v0.21.0

Jul 10, 2026

Changes in this version

type CleanBranchesOptions

+ RemoteStatuses engine.BranchRemoteStatuses

v0.20.1

Jun 29, 2026

v0.20.0

Jun 26, 2026

Changes in this version

+ const TreeStyleFull

+ const TreeStyleNormal

+ const TreeStyleShort

+ func TreeAction(ctx *app.Context, opts TreeOptions) error

+ type TreeBranchInfo struct

+ Additions int

+ Children []string

+ Commits int

+ Deletions int

+ IsCurrent bool

+ IsFrozen bool

+ IsLocked bool

+ IsTrunk bool

+ Name string

+ NeedsRestack bool

+ PR *TreePRInfo

+ Parent string

+ Scope string

+ type TreeJSONResult struct

+ Branches []TreeBranchInfo

+ GitHubAvailable bool

+ Summary TreeSummary

+ func BuildTreeJSON(ctx *app.Context, opts TreeOptions) TreeJSONResult

+ type TreeOptions struct

+ BranchName string

+ Interactive bool

+ JSON bool

+ ShowSHAs bool

+ ShowUntracked bool

+ Steps *int

+ Style string

+ type TreePRInfo struct

+ CIStatus string

+ IsDraft bool

+ Number int

+ ReviewStatus string

+ State string

+ Title string

+ URL string

+ type TreeSummary struct

+ ApprovedCount int

+ InReviewCount int

+ TotalBranches int

v0.19.2

Jun 21, 2026

v0.19.1

Jun 12, 2026

Changes in this version

+ func FetchPRContentForBranches(ctx *app.Context, branches []string, repoOwner, repoName string) map[int]github.PRContent

+ func UpdateBranchPRMetadataWithContent(ctx *app.Context, name string, repoOwner, repoName string, ...)

v0.19.0

Jun 3, 2026

Changes in this version

+ const DefaultShareMarker

+ func ShareAction(ctx *app.Context, opts ShareOptions) error

+ func StateAction(ctx *app.Context, opts StateOptions) error

type LogJSONResult

+ func BuildLogJSON(ctx *app.Context, opts LogOptions) LogJSONResult

type MetadataPushEngine

+ PrepareRemoteMetadataPush func(ctx context.Context) error

+ PushMetadataForBranches func(ctx context.Context, branchNames []string) error

+ type OperationStatus struct

+ ConflictedFiles []string

+ InProgress bool

+ Kind string

+ StackitHalted bool

+ type ShareOptions struct

+ BranchName string

+ Marker string

+ type StateOptions struct

+ JSON bool

+ type StateResult struct

+ CurrentBranch string

+ Detached bool

+ Operation OperationStatus

+ Stack LogJSONResult

+ Trunk string

+ WorkingTree WorkingTreeStatus

+ func BuildState(ctx *app.Context, _ StateOptions) StateResult

+ type WorkingTreeStatus struct

+ Clean bool

+ Staged bool

+ Unstaged bool

+ Untracked bool

v0.18.1

May 27, 2026

v0.18.0

May 27, 2026

v0.17.15

May 11, 2026

v0.17.14

May 11, 2026

Changes in this version

+ const LogStyleFull

+ const LogStyleNormal

+ const LogStyleShort

+ func ConfigListAction(repoRoot string, writer io.Writer) error

+ func ContinueAction(ctx *app.Context, opts ContinueOptions) error

+ func DebugAction(ctx *app.Context, opts DebugOptions) error

+ func EnterConflictWorkflow(ctx *app.Context, firstConflict string, allBranches []engine.Branch) error

+ func FormatRerereResolved(count int) string

+ func FreezeAction(ctx *app.Context, branchName string) error

+ func GetAction(ctx *app.Context, branchOrPR string, opts GetOptions, handler GetHandler) error

+ func InfoAction(ctx *app.Context, opts InfoOptions) error

+ func LogAction(ctx *app.Context, opts LogOptions) error

+ func ModifyAction(ctx *app.Context, opts ModifyOptions) error

+ func NewSnapshot(command string, options ...SnapshotOption) engine.SnapshotOptions

+ func PluralIt(plural bool) string

+ func PluralSuffix(word string, plural bool) string

+ func Pluralize(word string, count int) string

+ func PopAction(ctx *app.Context, _ PopOptions) error

+ func PrintConflictStatus(ctx *app.Context, branchName string) error

+ func PushMetadataAndSyncPRs(ctx *app.Context, branchNames []string) error

+ func PushMetadataOnly(ctx *app.Context, eng MetadataPushEngine, branchNames []string) error

+ func RenameAction(ctx *app.Context, opts RenameOptions) error

+ func ReorderAction(ctx *app.Context) error

+ func ResolveBranch(eng engine.BranchReader, branchName string) (engine.Branch, error)

+ func ResolveBranchName(eng engine.BranchReader, branchName string) (string, error)

+ func RestackAction(ctx *app.Context, plan *RestackPlan, handler handlers.RestackHandler) error

+ func RestackBranches(ctx *app.Context, branches []engine.Branch) error

+ func RestackBranchesWithHandler(ctx *app.Context, branches []engine.Branch, callback RestackProgressCallback, ...) error

+ func SquashAction(ctx *app.Context, opts SquashOptions) error

+ func StackInfoAction(ctx *app.Context, opts StackInfoOptions) error

+ func TakeBestEffortSnapshot(ctx *app.Context, opts engine.SnapshotOptions)

+ func UnfreezeAction(ctx *app.Context, branchName string) error

+ func UpdateBranchPRMetadata(ctx *app.Context, name string, repoOwner, repoName string)

+ func UpdateStackPRMetadata(ctx *app.Context, branches []string, repoOwner, repoName string)

+ type BranchDeletionPlan struct

+ BranchesToDelete map[string]string

+ BranchesWithNewParents []string

+ SkippedInWorktree []string

+ UnpushedBranches map[string]bool

+ UtilityBranches map[string]bool

+ func PlanBranchDeletions(ctx *app.Context, opts CleanBranchesOptions) (*BranchDeletionPlan, error)

+ type BranchInfo struct

+ Children []string

+ IsFixed bool

+ IsTracked bool

+ IsTrunk bool

+ MetadataRefSHA string

+ Name string

+ PRInfo *engine.PrInfo

+ Parent string

+ ParentRevision string

+ SHA string

+ type BranchName string

+ type CheckoutHandler interface

+ SelectBranch func(ctx *app.Context, opts CheckoutOptions) (string, error)

+ type CheckoutOptions struct

+ All bool

+ BranchName string

+ CheckoutTrunk bool

+ ShowUntracked bool

+ SkipWorktreeSwitch bool

+ StackOnly bool

+ type CheckoutResult struct

+ FallbackTips []string

+ RerunArgs []string

+ TargetBranch string

+ WorktreeSwitchPath string

+ func CheckoutAction(ctx *app.Context, opts CheckoutOptions, handler CheckoutHandler) (CheckoutResult, error)

+ type CleanBranchesOptions struct

+ CurrentBranch string

+ Force bool

+ InManagedWorktree bool

+ type CleanBranchesResult struct

+ BranchesWithNewParents []string

+ DeletedBranches map[string]string

+ SkippedInWorktree []string

+ SkippedUnpushed []string

+ func CleanBranches(ctx *app.Context, opts CleanBranchesOptions) (*CleanBranchesResult, error)

+ func ExecuteBranchDeletions(ctx *app.Context, plannedDeletion *BranchDeletionPlan, ...) (*CleanBranchesResult, error)

+ type CommandSnapshot struct

+ Args []string

+ Command string

+ CurrentBranch string

+ Timestamp time.Time

+ type CommitSHA string

+ type ConflictMode int

+ const ConflictModeContinue

+ const ConflictModeEnterWorkflow

+ type ContinuationStateInfo struct

+ BranchesToRestack []string

+ BranchesToSync []string

+ CurrentBranchOverride string

+ RebasedBranchBase string

+ type ContinueOptions struct

+ AddAll bool

+ type DebugInfo struct

+ ContinuationState *ContinuationStateInfo

+ RecentCommands []CommandSnapshot

+ RemoteMetadataState *RemoteMetadataStateInfo

+ RepositoryInfo RepositoryInfo

+ StackState StackStateInfo

+ Timestamp time.Time

+ type DebugOptions struct

+ Limit int

+ ShowRemote bool

+ type DiffStats struct

+ Additions int

+ Deletions int

+ FilesChanged int

+ type GetEvent struct

+ Branch string

+ Error error

+ IsNew bool

+ Message string

+ NewRevision string

+ PRNumber *int

+ Phase GetPhase

+ Type GetEventType

+ type GetEventType string

+ const GetEventCompleted

+ const GetEventProgress

+ const GetEventSkipped

+ const GetEventStarted

+ type GetHandler interface

+ Complete func(summary GetSummary)

+ EmitEvent func(event GetEvent)

+ Start func(targetBranch string, prNumber *int)

+ type GetNullHandler struct

+ func (h *GetNullHandler) Complete(_ GetSummary)

+ func (h *GetNullHandler) EmitEvent(_ GetEvent)

+ func (h *GetNullHandler) OnRestackBranch(_ string, _ handlers.RestackResult, _ string, _ *int, _ engine.LockReason, ...)

+ func (h *GetNullHandler) OnRestackComplete(_, _ int, _ []string)

+ func (h *GetNullHandler) OnRestackStart(_ int)

+ func (h *GetNullHandler) Start(_ string, _ *int)

+ type GetOptions struct

+ Downstack bool

+ Force bool

+ Restack bool

+ Unfrozen bool

+ type GetPhase string

+ const GetPhaseCheckout

+ const GetPhaseFetch

+ const GetPhaseMetadata

+ const GetPhaseSync

+ type GetSummary struct

+ BranchesCreated int

+ BranchesUpdated int

+ IsFrozen bool

+ Restacked int

+ TargetBranch string

+ UpToDate bool

+ type InfoOptions struct

+ Body bool

+ BranchName string

+ Diff bool

+ JSON bool

+ Patch bool

+ Stack bool

+ Stat bool

+ type LogBranchInfo struct

+ Additions int

+ Children []string

+ Commits int

+ Deletions int

+ IsCurrent bool

+ IsFrozen bool

+ IsLocked bool

+ IsTrunk bool

+ Name string

+ NeedsRestack bool

+ PR *LogPRInfo

+ Parent string

+ Scope string

+ type LogJSONResult struct

+ Branches []LogBranchInfo

+ GitHubAvailable bool

+ Summary LogSummary

+ type LogOptions struct

+ BranchName string

+ Interactive bool

+ JSON bool

+ ShowSHAs bool

+ ShowUntracked bool

+ Steps *int

+ Style string

+ type LogPRInfo struct

+ CIStatus string

+ IsDraft bool

+ Number int

+ ReviewStatus string

+ State string

+ Title string

+ URL string

+ type LogSummary struct

+ ApprovedCount int

+ InReviewCount int

+ TotalBranches int

+ type MetadataDiffInfo struct

+ Branch string

+ DiffFields []string

+ LocalValue string

+ RemoteValue string

+ type MetadataPushEngine interface

+ BatchSetLastModifiedBy func(branchNames []string) error

+ Git func() git.Runner

+ IsRemoteSyncEnabled func() bool

+ SetRemoteSyncEnabled func(enabled bool)

+ type ModifyOptions struct

+ All bool

+ CreateCommit bool

+ Edit bool

+ InteractiveRebase bool

+ Message string

+ NoEdit bool

+ Patch bool

+ ResetAuthor bool

+ Update bool

+ Verbose int

+ type NullCheckoutHandler struct

+ func (h *NullCheckoutHandler) SelectBranch(_ *app.Context, _ CheckoutOptions) (string, error)

+ type PRNumber int

+ type PopOptions struct

+ type RemoteMetadataStateInfo struct

+ LocalVsRemoteDiffs []MetadataDiffInfo

+ RemoteRefs map[string]RemoteRefInfo

+ RemoteStateAvailable bool

+ type RemoteRefInfo struct

+ LastModified string

+ ModifiedBy string

+ SHA string

+ Scope string

+ type RenameOptions struct

+ Force bool

+ NewName string

+ type RepositoryInfo struct

+ RemoteURL string

+ RepoRoot string

+ type RestackOptions struct

+ AllStacks bool

+ BranchName string

+ ContinueOnConflict bool

+ Jobs int

+ Parallel bool

+ Scope engine.StackRange

+ StackRoots []string

+ type RestackPlan struct

+ func PlanRestack(ctx *app.Context, opts RestackOptions) (*RestackPlan, error)

+ func (p *RestackPlan) BranchCount() int

+ func (p *RestackPlan) HasBranches() bool

+ func (p *RestackPlan) HasWork() bool

+ type RestackProgress struct

+ Branch string

+ Conflict bool

+ Frozen bool

+ IsCurrent bool

+ LockReason engine.LockReason

+ NewParent string

+ NewRev string

+ OldParent string

+ Reparented bool

+ RerereResolvedCount int

+ Result engine.RestackResult

+ StackRoot string

+ type RestackProgressCallback func(RestackProgress)

+ type Restacker interface

+ type SingleBranchInfo struct

+ Children []string

+ CommitDate string

+ CommitMessages []string

+ DiffStats SingleBranchStats

+ IsCurrent bool

+ IsFrozen bool

+ IsLocked bool

+ IsTrunk bool

+ Name string

+ NeedsRestack bool

+ PR *SingleBranchPRInfo

+ Parent string

+ Scope string

+ StackDescription string

+ StackTitle string

+ type SingleBranchPRInfo struct

+ IsDraft bool

+ Number int

+ State string

+ Title string

+ URL string

+ type SingleBranchStats struct

+ Additions int

+ Deletions int

+ FilesChanged int

+ type SnapshotOption func(*engine.SnapshotOptions)

+ func WithArg(arg string) SnapshotOption

+ func WithArgs(args ...string) SnapshotOption

+ func WithFlag(condition bool, flag string) SnapshotOption

+ func WithFlagValue(flag string, value string) SnapshotOption

+ type SquashOptions struct

+ Message string

+ NoEdit bool

+ type StackBranchInfo struct

+ CommitMessages []string

+ DiffStats DiffStats

+ IsFrozen bool

+ IsLocked bool

+ Name string

+ PRNumber *int

+ PRURL string

+ Parent string

+ Scope string

+ type StackInfoOptions struct

+ JSON bool

+ type StackInfoOutput struct

+ Branches []StackBranchInfo

+ StackDescription string

+ StackTitle string

+ type StackStateInfo struct

+ Branches []BranchInfo

+ CurrentBranch string

+ Trunk string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL