true_git

Documentation

Index

• Constants
• Variables
• func CreateDetachedMergeCommit(ctx context.Context, ...) (string, error)
• func Fetch(ctx context.Context, path string, options FetchOptions) error
• func GetRealRepoDir(repoDir string) (string, error)
• func GitOpenWithCustomWorktreeDir(gitDir, worktreeDir string) (*git.Repository, error)
• func Init(opts Options) error
• func IsAncestor(ancestorCommit, descendantCommit string, gitDir string) (bool, error)
• func IsShallowClone(path string) (bool, error)
• func WithWorkTree(ctx context.Context, gitDir, workTreeCacheDir string, commit string, ...) error
• type ArchiveDescriptor
  • func Archive(ctx context.Context, out io.Writer, gitDir, workTreeCacheDir string, ...) (*ArchiveDescriptor, error)
  • func ArchiveWithSubmodules(ctx context.Context, out io.Writer, gitDir, workTreeCacheDir string, ...) (*ArchiveDescriptor, error)
• type ArchiveOptions
• type ArchiveType
• type CreateDetachedMergeCommitOptions
• type FetchOptions
• 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
• type RefDescriptor
• type ShowRefResult
  • func ShowRef(repoDir string) (*ShowRefResult, error)
• type WithWorkTreeOptions
• type WorktreeDescriptor
  • func GetWorkTreeList(repoDir string) ([]WorktreeDescriptor, error)

Constants

const (
	MinGitVersionConstraintValue               = "1.9"
	MinGitVersionWithSubmodulesConstraintValue = "2.14"
)

Variables

var (
	ForbiddenGitVersionsConstraintValues = []string{"2.22.0"}
)

Functions

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 GetRealRepoDir

func GetRealRepoDir(repoDir string) (string, error)

func GitOpenWithCustomWorktreeDir

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

func Init

func Init(opts Options) error

func IsAncestor

func IsAncestor(ancestorCommit, descendantCommit string, gitDir string) (bool, error)

func IsShallowClone

func IsShallowClone(path string) (bool, error)

func WithWorkTree

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

Types

type ArchiveDescriptor

type ArchiveDescriptor struct {
	Type    ArchiveType
	IsEmpty bool
}

func Archive

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

func ArchiveWithSubmodules

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

type ArchiveOptions

type ArchiveOptions struct {
	Commit      string
	PathMatcher path_matcher.PathMatcher
}

type ArchiveType

type ArchiveType string

const (
	FileArchive      ArchiveType = "file"
	DirectoryArchive ArchiveType = "directory"
)

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 Options

type Options struct {
	LiveGitOutput bool
}

type PatchDescriptor

type PatchDescriptor struct {
	Paths       []string
	BinaryPaths []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 {
	FromCommit, ToCommit string
	PathMatcher          path_matcher.PathMatcher

	WithEntireFileContext bool
	WithBinary            bool
}

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(repoDir string) (*ShowRefResult, error)

type WithWorkTreeOptions

type WithWorkTreeOptions struct {
	HasSubmodules bool
}

type WorktreeDescriptor

type WorktreeDescriptor struct {
	Path   string
	Head   string
	Branch string
}

func GetWorkTreeList

func GetWorkTreeList(repoDir string) ([]WorktreeDescriptor, error)