true_git

Documentation

Index

• Constants
• Variables
• func Archive(ctx context.Context, out io.Writer, gitDir, workTreeCacheDir string, ...) error
• func ArchiveWithSubmodules(ctx context.Context, out io.Writer, gitDir, workTreeCacheDir string, ...) error
• func CreateDetachedMergeCommit(ctx context.Context, ...) (string, error)
• func Fetch(ctx context.Context, path string, options FetchOptions) error
• func GetLastBranchCommitSHA(ctx context.Context, repoPath, branch string) (string, error)
• func GitOpenWithCustomWorktreeDir(gitDir, worktreeDir string) (*git.Repository, error)
• func Init(ctx context.Context, opts Options) error
• func IsAncestor(ctx context.Context, ancestorCommit, descendantCommit string, gitDir string) (bool, error)
• func IsShallowClone(ctx context.Context, path string) (bool, error)
• func IsValidGitDir(ctx context.Context, gitDir string) (bool, error)
• func IsValidWorkTree(ctx context.Context, workTree string) (bool, error)
• func ResolveRepoDir(ctx context.Context, repoDir string) (string, error)
• func SyncSourceWorktreeWithServiceBranch(ctx context.Context, ...) (string, error)
• func UpwardLookupAndVerifyWorkTree(ctx context.Context, lookupPath string) (bool, string, error)
• func WithWorkTree(ctx context.Context, gitDir, workTreeCacheDir string, commit string, ...) error
• type ArchiveOptions
  • func (opts ArchiveOptions) ID() string
• type CreateDetachedMergeCommitOptions
• type FetchOptions
• type GitCmd
  • func NewGitCmd(ctx context.Context, opts *GitCmdOptions, cliArgs ...string) GitCmd
  • func (c *GitCmd) Run(ctx context.Context) error
• type GitCmdOptions
• type Options
• type PatchDescriptor
  • func Patch(ctx context.Context, out io.Writer, gitDir string, opts PatchOptions) (*PatchDescriptor, error)
  • func PatchWithSubmodules(ctx context.Context, out io.Writer, gitDir, workTreeCacheDir string, ...) (*PatchDescriptor, error)
• type PatchOptions
  • func (opts PatchOptions) ID() string
• type RefDescriptor
• type ShowRefResult
  • func ShowRef(ctx context.Context, repoDir string) (*ShowRefResult, error)
• type SyncSourceWorktreeWithServiceBranchOptions
• type WithWorkTreeOptions
• type WorktreeDescriptor
  • func GetWorkTreeList(ctx context.Context, repoDir string) ([]WorktreeDescriptor, error)

Constants

const (
	MinGitVersionConstraintValue = "2.18"
)

Variables

var ErrInvalidDotGit = errors.New("invalid file format: expected gitdir record")

var ForbiddenGitVersionsConstraintValues = []string{"2.22.0"}

Functions

func Archive

func Archive(ctx context.Context, out io.Writer, gitDir, workTreeCacheDir string, opts ArchiveOptions) error

func ArchiveWithSubmodules

func ArchiveWithSubmodules(ctx context.Context, out io.Writer, gitDir, workTreeCacheDir string, opts ArchiveOptions) error

func CreateDetachedMergeCommit

func CreateDetachedMergeCommit(ctx context.Context, gitDir, workTreeCacheDir, commitToMerge, mergeIntoCommit string, opts CreateDetachedMergeCommitOptions) (string, error)

func Fetch

func Fetch(ctx context.Context, path string, options FetchOptions) error

func GetLastBranchCommitSHA

func GetLastBranchCommitSHA(ctx context.Context, repoPath, branch string) (string, error)

func GitOpenWithCustomWorktreeDir

func GitOpenWithCustomWorktreeDir(gitDir, worktreeDir string) (*git.Repository, error)

func Init

func Init(ctx context.Context, opts Options) error

func IsAncestor

func IsAncestor(ctx context.Context, ancestorCommit, descendantCommit string, gitDir string) (bool, error)

func IsShallowClone

func IsShallowClone(ctx context.Context, path string) (bool, error)

func IsValidGitDir

func IsValidGitDir(ctx context.Context, gitDir string) (bool, error)

func IsValidWorkTree

func IsValidWorkTree(ctx context.Context, workTree string) (bool, error)

func ResolveRepoDir

func ResolveRepoDir(ctx context.Context, repoDir string) (string, error)

func SyncSourceWorktreeWithServiceBranch

func SyncSourceWorktreeWithServiceBranch(ctx context.Context, gitDir, sourceWorktreeDir, worktreeCacheDir, commit string, opts SyncSourceWorktreeWithServiceBranchOptions) (string, error)

func UpwardLookupAndVerifyWorkTree

func UpwardLookupAndVerifyWorkTree(ctx context.Context, lookupPath string) (bool, string, error)

func WithWorkTree

func WithWorkTree(ctx context.Context, gitDir, workTreeCacheDir string, commit string, opts WithWorkTreeOptions, f func(workTreeDir string) error) error

Types

type ArchiveOptions

type ArchiveOptions struct {
	Commit      string
	PathScope   string // Determines the directory that will get into the result (similar to <pathspec> in the git commands).
	PathMatcher path_matcher.PathMatcher
	FileRenames map[string]string // Files to rename during archiving. Git repo relative paths of original files as keys, new filenames (without base path) as values.
}

func (ArchiveOptions) ID

func (opts ArchiveOptions) ID() string

TODO: 1.3 add git mapping type (dir, file, ...) to gitArchive stage digest

type CreateDetachedMergeCommitOptions

type CreateDetachedMergeCommitOptions struct {
	HasSubmodules bool
}

type FetchOptions

type FetchOptions struct {
	All       bool
	TagsOnly  bool
	Prune     bool
	PruneTags bool
	Unshallow bool
	RefSpecs  map[string]string
}

type GitCmd

type GitCmd struct {
	*exec.Cmd

	// We always write to all of these buffs, unlike with exec.Cmd.Stdout(Stderr)
	OutBuf    *bytes.Buffer
	ErrBuf    *bytes.Buffer
	OutErrBuf *bytes.Buffer
}

func NewGitCmd

func NewGitCmd(ctx context.Context, opts *GitCmdOptions, cliArgs ...string) GitCmd

func (*GitCmd) Run

func (c *GitCmd) Run(ctx context.Context) error

type GitCmdOptions

type GitCmdOptions struct {
	RepoDir string
}

type Options

type Options struct {
	LiveGitOutput bool
}

type PatchDescriptor

type PatchDescriptor struct {
	Paths         []string
	BinaryPaths   []string
	PathsToRemove []string
}

func Patch

func Patch(ctx context.Context, out io.Writer, gitDir string, opts PatchOptions) (*PatchDescriptor, error)

func PatchWithSubmodules

func PatchWithSubmodules(ctx context.Context, out io.Writer, gitDir, workTreeCacheDir string, opts PatchOptions) (*PatchDescriptor, error)

type PatchOptions

type PatchOptions struct {
	PathScope            string // Determines the directory that will get into the result (similar to <pathspec> in the git commands).
	PathMatcher          path_matcher.PathMatcher
	FromCommit, ToCommit string
	FileRenames          map[string]string // Files to rename during patching. Git repo relative paths of original files as keys, new filenames (without base path) as values.

	WithEntireFileContext bool
	WithBinary            bool
}

func (PatchOptions) ID

func (opts PatchOptions) ID() string

type RefDescriptor

type RefDescriptor struct {
	Commit   string
	FullName string
	IsHEAD   bool

	IsTag   bool
	TagName string

	IsBranch   bool
	BranchName string
	IsRemote   bool
	RemoteName string
}

type ShowRefResult

type ShowRefResult struct {
	Refs []RefDescriptor
}

func ShowRef

func ShowRef(ctx context.Context, repoDir string) (*ShowRefResult, error)

type SyncSourceWorktreeWithServiceBranchOptions

type SyncSourceWorktreeWithServiceBranchOptions struct {
	ServiceBranch   string
	GlobExcludeList []string
}

type WithWorkTreeOptions

type WithWorkTreeOptions struct {
	HasSubmodules bool
}

type WorktreeDescriptor

type WorktreeDescriptor struct {
	Path   string
	Head   string
	Branch string
}

func GetWorkTreeList

func GetWorkTreeList(ctx context.Context, repoDir string) ([]WorktreeDescriptor, error)