git

package
v1.38.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 17, 2026 License: AGPL-3.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const IsDirtyCacheTTL = 30 * time.Second

IsDirtyCacheTTL is the duration for which a dirty (has changes) result is considered fresh. 30s keeps the review queue responsive when uncommitted changes are present. InvalidateDirtyCache() is called after commits/pushes so critical paths remain snappy.

View Source 
const IsDirtyCleanCacheTTL = 5 * time.Minute

IsDirtyCleanCacheTTL is the TTL when the worktree is known to be clean. Clean worktrees won't change unless Claude commits or a user modifies files; InvalidateDirtyCache() is called on those code paths, so 5 min is safe and cuts subprocess calls by ~10x vs dirty-path TTL for quiescent sessions.

Variables

This section is empty.

Functions

func CheckoutBranch added in v1.37.0 

func CheckoutBranch(repoPath, branchName string) error

CheckoutBranch checks out a branch in an existing repository.

func CleanupWorktrees 

func CleanupWorktrees() error

CleanupWorktrees removes all worktree directories under the configured worktrees dir. It deliberately does NOT delete the associated branches: a branch can hold commits that exist nowhere else (never pushed, never merged), and this function has no way to know whether that's true for any given one. See GitWorktree.Cleanup's doc comment — same fix, same root cause (docs/tasks/backlog-feature-improvement.md).

func FetchBranch added in v1.37.0 

func FetchBranch(repoPath, branchName string) error

FetchBranch fetches a specific branch from the origin remote.

func GetCurrentBranchName added in v1.35.0 

func GetCurrentBranchName(path string) (string, error)

GetCurrentBranchName returns the current branch name for a git repository or worktree. Returns an error if the repo is in detached HEAD state.

func GetHeadCommitSHA added in v1.37.0 

func GetHeadCommitSHA(path string) (string, error)

GetHeadCommitSHA returns the SHA of the HEAD commit for a git repository or worktree.

func InitializeProjectDirectory added in v1.35.0 

func InitializeProjectDirectory(path string) error

InitializeProjectDirectory creates a directory and initializes it as a git repository. Behavior by pre-existing state:

  • Path does not exist: creates with os.MkdirAll(path, 0755), runs git init, commits.
  • Path exists, no .git: runs git init in place, commits.
  • Path exists, already a git repo: no-op, returns nil.
  • Path exists but is a regular file: returns an error.

On partial failure (dir created, git init failed): attempts os.RemoveAll to roll back the newly created directory. Logs a warning if rollback also fails.

func IsGitRepo 

func IsGitRepo(path string) bool

IsGitRepo checks if the given path is within a git repository

func RemoteURL added in v1.37.0 

func RemoteURL(repoPath, remote string) (string, error)

RemoteURL returns the URL of the named remote (usually "origin") for a local repo.

Types

type DiffStats 

type DiffStats struct {
	// Content is the full diff content
	Content string
	// Added is the number of added lines
	Added int
	// Removed is the number of removed lines
	Removed int
	// Error holds any error that occurred during diff computation
	// This allows propagating setup errors (like missing base commit) without breaking the flow
	Error error
}

DiffStats holds statistics about the changes in a diff

func (*DiffStats) IsEmpty 

func (d *DiffStats) IsEmpty() bool

type GitWorktree 

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

GitWorktree manages git worktree operations for a session

func NewGitWorktree 

func NewGitWorktree(repoPath string, sessionName string) (tree *GitWorktree, branchname string, err error)

NewGitWorktree creates a new GitWorktree instance

func NewGitWorktreeFromCommitSHA 

func NewGitWorktreeFromCommitSHA(repoPath, sessionName, branchName, commitSHA string) (*GitWorktree, string, error)

NewGitWorktreeFromCommitSHA creates a new GitWorktree that will branch from the given commitSHA when Setup() is called, instead of branching from the current HEAD. This is used by ForkFromCheckpoint to recreate the exact git state at checkpoint time.

func NewGitWorktreeFromExisting 

func NewGitWorktreeFromExisting(existingWorktreePath string, sessionName string) (*GitWorktree, error)

NewGitWorktreeFromExisting creates a GitWorktree from an existing worktree path This is used when connecting to worktrees that were created manually or by deleted sessions

func NewGitWorktreeFromExistingWithExecutor 

func NewGitWorktreeFromExistingWithExecutor(existingWorktreePath string, sessionName string, cmdExec executor.Executor) (*GitWorktree, error)

NewGitWorktreeFromExistingWithExecutor creates a GitWorktree from an existing worktree path with an optional executor.

func NewGitWorktreeFromStorage 

func NewGitWorktreeFromStorage(repoPath string, worktreePath string, sessionName string, branchName string, baseCommitSHA string) *GitWorktree

func NewGitWorktreeFromStorageWithExecutor 

func NewGitWorktreeFromStorageWithExecutor(repoPath string, worktreePath string, sessionName string, branchName string, baseCommitSHA string, cmdExec executor.Executor) *GitWorktree

NewGitWorktreeFromStorageWithExecutor creates a GitWorktree from stored data with an optional executor. If cmdExec is nil, a default executor is used.

func NewGitWorktreeWithBranch 

func NewGitWorktreeWithBranch(repoPath string, sessionName string, customBranch string) (tree *GitWorktree, branchname string, err error)

NewGitWorktreeWithBranch creates a new GitWorktree instance with an optional custom branch name

func NewGitWorktreeWithBranchAndExecutor 

func NewGitWorktreeWithBranchAndExecutor(repoPath string, sessionName string, customBranch string, cmdExec executor.Executor) (tree *GitWorktree, branchname string, err error)

NewGitWorktreeWithBranchAndExecutor creates a new GitWorktree with optional branch name and executor. If cmdExec is nil, a default executor is used.

func (*GitWorktree) Cleanup 

func (g *GitWorktree) Cleanup() error

Cleanup removes the worktree. It deliberately does NOT delete the branch: branch deletion via go-git's RemoveReference is not a "safe if merged" check, it is unconditional, and a branch can hold commits that exist nowhere else (never pushed, never merged). Silently destroying those on session teardown was a live bug — see docs/tasks/backlog-feature-improvement.md ("stop_session silently deletes the git branch"). A leftover local branch ref costs nothing; a lost commit is not recoverable through this code path. Equivalent to Remove() — kept as a separate method so callers don't need to know the two used to differ.

func (*GitWorktree) CommitChanges 

func (g *GitWorktree) CommitChanges(commitMessage string) error

CommitChanges commits changes locally without pushing to remote

func (*GitWorktree) CreatePR added in v1.37.0 

func (g *GitWorktree) CreatePR(title, body string) (prURL string, prNumber int, err error)

CreatePR creates a GitHub pull request for the current branch and returns the PR URL and number. Title defaults to the branch name if empty. If a PR already exists for the branch it is returned without creating a new one.

func (*GitWorktree) Diff 

func (g *GitWorktree) Diff() *DiffStats

Diff returns the git diff between the worktree and the base branch along with statistics

func (*GitWorktree) EnablePRAutoMerge added in v1.37.0 

func (g *GitWorktree) EnablePRAutoMerge(prNumber int) error

EnablePRAutoMerge enables GitHub auto-merge on the given PR so it merges automatically once required CI checks pass. Best-effort: fails silently when the repo does not have auto-merge enabled in its branch protection rules.

func (*GitWorktree) GetBaseCommitSHA 

func (g *GitWorktree) GetBaseCommitSHA() string

GetBaseCommitSHA returns the base commit SHA for the worktree

func (*GitWorktree) GetBranchName 

func (g *GitWorktree) GetBranchName() string

GetBranchName returns the name of the branch associated with this worktree

func (*GitWorktree) GetPRStatus added in v1.37.0 

func (g *GitWorktree) GetPRStatus(prNumber int) (*PRStatus, error)

GetPRStatus fetches the combined CI check status, reviewer decisions, mergeability, and PR comments for the given pull request number.

func (*GitWorktree) GetRepoName 

func (g *GitWorktree) GetRepoName() string

GetRepoName returns the name of the repository (last part of the repoPath).

func (*GitWorktree) GetRepoPath 

func (g *GitWorktree) GetRepoPath() string

GetRepoPath returns the path to the repository

func (*GitWorktree) GetWorktreePath 

func (g *GitWorktree) GetWorktreePath() string

GetWorktreePath returns the path to the worktree

func (*GitWorktree) InvalidateDirtyCache added in v1.22.0 

func (g *GitWorktree) InvalidateDirtyCache()

InvalidateDirtyCache clears the IsDirty cache so the next call re-runs git status. Call this whenever worktree state changes outside of Claude's control (e.g. after a manual commit, after running git operations, or in tests after writing files directly).

func (*GitWorktree) IsBranchCheckedOut 

func (g *GitWorktree) IsBranchCheckedOut() (bool, error)

IsBranchCheckedOut checks if the instance branch is currently checked out. Uses go-git to read HEAD directly (no subprocess).

func (*GitWorktree) IsDirty 

func (g *GitWorktree) IsDirty() (bool, error)

IsDirty checks if the worktree has uncommitted changes. Results are cached for IsDirtyCacheTTL (dirty) or IsDirtyCleanCacheTTL (clean).

func (*GitWorktree) IsDirtyWithHint added in v1.22.0 

func (g *GitWorktree) IsDirtyWithHint(claudeActive bool) (bool, error)

IsDirtyWithHint checks if the worktree has uncommitted changes. When claudeActive is true the subprocess is skipped entirely and the cached value is returned (or false if no cached value is available yet), because Claude never modifies worktree state while it is actively generating output.

func (*GitWorktree) IsPRMerged added in v1.37.0 

func (g *GitWorktree) IsPRMerged(prNumber int) (bool, error)

IsPRMerged reports whether the given PR number has been merged.

func (*GitWorktree) OpenBranchURL 

func (g *GitWorktree) OpenBranchURL() error

OpenBranchURL opens the branch URL in the default browser

func (*GitWorktree) PrimeDirtyCacheAt added in v1.35.0 

func (g *GitWorktree) PrimeDirtyCacheAt(t time.Time)

PrimeDirtyCacheAt sets the dirty-cache timestamp to t without running git status. Use this to stagger per-session cache expiry so sessions added to the poller within a short window don't all expire simultaneously and burst-launch git subprocesses.

func (*GitWorktree) Prune 

func (g *GitWorktree) Prune() error

Prune removes all working tree administrative files and directories

func (*GitWorktree) PushBranch added in v1.37.0 

func (g *GitWorktree) PushBranch() error

func (*GitWorktree) PushChanges 

func (g *GitWorktree) PushChanges(commitMessage string, open bool) error

PushChanges commits and pushes changes in the worktree to the remote branch

func (*GitWorktree) Remove 

func (g *GitWorktree) Remove() error

Remove removes the worktree but keeps the branch

func (*GitWorktree) Setup 

func (g *GitWorktree) Setup() error

Setup creates a new worktree for the session

type PRStatus added in v1.37.0 

type PRStatus struct {
	// CIFailing is true when at least one CI check has a terminal failure.
	CIFailing bool
	// HasBlockingReviews is true when a reviewer has requested changes.
	HasBlockingReviews bool
	// HasConflicts is true when GitHub reports mergeStateStatus == "DIRTY" or
	// mergeable == "CONFLICTING" — its branch cannot be merged as-is and needs
	// a rebase. Both fields are checked (see Task 1.1.1d) because gh's
	// mergeable field has been observed returning stale data (cli/cli#9583).
	HasConflicts bool
	// IsClosed is true when the PR's state is CLOSED (rejected by a human without
	// merging) rather than OPEN or MERGED. Callers must check this before treating
	// "not merged" as "still open and healthy" — a closed PR will never merge on
	// its own no matter how long ReconcilePRPending keeps polling it.
	IsClosed bool
	// IsDraft is true when the PR is still marked draft on GitHub. Captured from
	// the same gh pr view call as everything else on this struct (no second API
	// call) so callers such as the backlog stuck-item detector (prReadyToMergeSolo)
	// can gate on it without an extra fetch.
	IsDraft bool
	// Mergeable is the raw upper-cased GitHub `mergeable` field ("MERGEABLE",
	// "CONFLICTING", or "UNKNOWN"). HasConflicts is the belt-and-suspenders
	// bool derived from this plus mergeStateStatus (see above); Mergeable is
	// exposed separately for callers (prReadyToMergeSolo) that want the literal
	// "MERGEABLE" check called out in ADR-001 rather than the inverse-of-conflict
	// approximation.
	Mergeable string
	// ApprovedCount is the number of current non-dismissed APPROVED reviews.
	ApprovedCount int
	// ChangesRequestedCount is the number of current non-dismissed
	// CHANGES_REQUESTED reviews (equivalently, len of the reviews backing
	// HasBlockingReviews — exposed as a count so callers building a
	// github.PRInfo-shaped value don't need to re-derive it from the bool).
	ChangesRequestedCount int
	// FeedbackText is a combined human-readable summary for the fix agent.
	FeedbackText string
	// contains filtered or unexported fields
}

PRStatus holds the CI, review, and conflict state for a pull request.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.