git

Documentation

Overview

Package git wraps os/exec calls to the git binary. All functions shell out to git plumbing commands and return structured results.

Index

• Variables
• func AddFile(ctx context.Context, indexPath, filePath string) error
• func CommitMessage(ctx context.Context, rev string) (string, error)
• func CommitTree(ctx context.Context, treeSHA, parentSHA, message string) (string, error)
• func CommonGitDir(ctx context.Context) (string, error)
• func GitDir(ctx context.Context) (string, error)
• func HeadRef(ctx context.Context) (string, error)
• func IsIgnored(ctx context.Context, filePath string) (bool, error)
• func IsTracked(ctx context.Context, filePath string) (bool, error)
• func ReadTree(ctx context.Context, indexPath, treeish string) error
• func RepoRoot(ctx context.Context) (string, error)
• func RevParse(ctx context.Context, rev string) (string, error)
• func RmCached(ctx context.Context, indexPath, filePath string) error
• func Run(ctx context.Context, args ...string) (stdout, stderr string, err error)
• func RunPassthrough(ctx context.Context, args ...string) error
• func RunWithEnv(ctx context.Context, env []string, args ...string) (stdout, stderr string, err error)
• func RunWithEnvStdin(ctx context.Context, env []string, stdin []byte, args ...string) (stdout, stderr string, err error)
• func SyncMainIndex(ctx context.Context, treeish string) error
• func UpdateRef(ctx context.Context, ref, newSHA, oldSHA string) error
• func WriteTree(ctx context.Context, indexPath string) (string, error)

Variables

var ErrDetachedHead = fmt.Errorf("HEAD is detached (not on a branch); check out a branch first or use --branch")

ErrDetachedHead is returned when HEAD is not on a branch.

Functions

func AddFile

func AddFile(ctx context.Context, indexPath, filePath string) error

AddFile stages a file into a custom index.

func CommitMessage

func CommitMessage(ctx context.Context, rev string) (string, error)

CommitMessage returns the full commit message of the given revision.

func CommitTree

func CommitTree(ctx context.Context, treeSHA, parentSHA, message string) (string, error)

CommitTree creates a commit object from a tree SHA and parent, returns commit SHA. If parentSHA is empty, creates a root commit.

func CommonGitDir

func CommonGitDir(ctx context.Context) (string, error)

CommonGitDir returns the path to the shared .git directory. For normal repos this equals GitDir(); for worktrees it returns the main .git dir that is shared across all worktrees. Lock files should live here so that worktrees committing to the same branch serialize correctly.

func GitDir

func GitDir(ctx context.Context) (string, error)

GitDir returns the path to the .git directory.

func HeadRef

func HeadRef(ctx context.Context) (string, error)

HeadRef returns the current branch ref (e.g. "refs/heads/main"). Returns ErrDetachedHead if HEAD is not on a branch.

func IsIgnored

func IsIgnored(ctx context.Context, filePath string) (bool, error)

IsIgnored checks whether a file matches a gitignore rule.

func IsTracked

func IsTracked(ctx context.Context, filePath string) (bool, error)

IsTracked checks whether a file is tracked by git (present in HEAD tree). Uses cat-file instead of ls-files because safegit never writes to the main index -- files committed via safegit exist in HEAD but not in .git/index.

func ReadTree

func ReadTree(ctx context.Context, indexPath, treeish string) error

ReadTree populates a temporary index from a treeish (commit/tree SHA or ref).

func RepoRoot

func RepoRoot(ctx context.Context) (string, error)

RepoRoot returns the absolute path to the repository root.

func RevParse

func RevParse(ctx context.Context, rev string) (string, error)

RevParse resolves a revision to a full SHA.

func RmCached

func RmCached(ctx context.Context, indexPath, filePath string) error

RmCached removes a file from a custom index without touching the working tree.

func Run

func Run(ctx context.Context, args ...string) (stdout, stderr string, err error)

Run executes a git command and returns stdout, stderr, and any error.

func RunPassthrough

func RunPassthrough(ctx context.Context, args ...string) error

RunPassthrough executes a git command with stdin/stdout/stderr wired to the terminal (os.Stdin, os.Stdout, os.Stderr). It prepends --no-optional-locks like Run, but does not capture output -- suitable for interactive/pager commands.

func RunWithEnv

func RunWithEnv(ctx context.Context, env []string, args ...string) (stdout, stderr string, err error)

RunWithEnv executes a git command with additional environment variables.

func RunWithEnvStdin

func RunWithEnvStdin(ctx context.Context, env []string, stdin []byte, args ...string) (stdout, stderr string, err error)

RunWithEnvStdin executes a git command with environment variables and stdin data.

func SyncMainIndex

func SyncMainIndex(ctx context.Context, treeish string) error

SyncMainIndex updates the main .git/index to match the given treeish. This makes git status/diff reflect the committed state after safegit commits.

func UpdateRef

func UpdateRef(ctx context.Context, ref, newSHA, oldSHA string) error

UpdateRef atomically updates a ref using compare-and-swap. oldSHA is the expected current value; if empty, the ref must not exist.

func WriteTree

func WriteTree(ctx context.Context, indexPath string) (string, error)

WriteTree writes the index content as a tree object, returns the tree SHA.