git

Documentation

Index

• func Clone(gitURL, targetDir, branch, tag string, depth int) error
• func ClonePath(gitURL string) (string, error)
• func EnsureInstalled() error
• func IsGitURL(s string) bool
• func Pull(repoDir, ref, refType string) error
• func ResetPull(repoDir, ref, refType string) error

Functions

func Clone

func Clone(gitURL, targetDir, branch, tag string, depth int) error

Clone clones a git repository to the target directory. If branch is non-empty, it checks out that branch. If tag is non-empty, it checks out that tag. If depth > 0, a shallow clone is performed. Progress output goes to stderr.

func ClonePath

func ClonePath(gitURL string) (string, error)

ClonePath returns the local directory path where a git workspace should be cloned. Follows Go module conventions: ~/.cache/flow/git-workspaces/<host>/<path>

func EnsureInstalled

func EnsureInstalled() error

EnsureInstalled checks that the git binary is available on PATH.

func IsGitURL

func IsGitURL(s string) bool

IsGitURL returns true if the given string looks like a Git remote URL (HTTPS or SSH).

func Pull

func Pull(repoDir, ref, refType string) error

Pull fetches and pulls the latest changes for a git repository. If the workspace was cloned with a specific branch, it pulls that branch. If it was cloned with a tag, it fetches tags and checks out the tag.

func ResetPull

func ResetPull(repoDir, ref, refType string) error

ResetPull performs a force update by resetting the working tree to match the remote. For branches, it fetches and does a hard reset to the remote tracking branch. For tags, it fetches tags and checks out the specified tag, discarding local changes.