shell

Documentation

Index

• func GitCheckoutBranch(projectPath, branchName, remote string) error
• func GitCheckoutBranchLocal(projectPath, branchName string) error
• func GitCheckoutRef(projectPath, reference string) error
• func GitCloneProject(repoUrl, defaultRemoteName, destPath string) error
• func GitFetchRemote(projectPath, remote string) error
• func GitInitSubmodules(projectPath string) error
• func GitSetTrackingRemoteBranch(projectPath, branchName, remote string) error
• func GitSetupSparseCheckout(projectPath string, sparseCheckoutDir string) error
• func GitSparseCloneProject(repoUrl, defaultRemoteName, destPath string) error
• type GitRefType
  • func GitResolveReference(projectPath, remote, revision string) (GitRefType, error)

Functions

func GitCheckoutBranch

func GitCheckoutBranch(projectPath, branchName, remote string) error

func GitCheckoutBranchLocal

func GitCheckoutBranchLocal(projectPath, branchName string) error

func GitCheckoutRef

func GitCheckoutRef(projectPath, reference string) error

func GitCloneProject

func GitCloneProject(repoUrl, defaultRemoteName, destPath string) error

GitCloneProject constructs a command-line string for cloning a git project, and delegates execution to the os/exec package.

func GitFetchRemote

func GitFetchRemote(projectPath, remote string) error

func GitInitSubmodules

func GitInitSubmodules(projectPath string) error

func GitSetTrackingRemoteBranch

func GitSetTrackingRemoteBranch(projectPath, branchName, remote string) error

func GitSetupSparseCheckout

func GitSetupSparseCheckout(projectPath string, sparseCheckoutDir string) error

func GitSparseCloneProject

func GitSparseCloneProject(repoUrl, defaultRemoteName, destPath string) error

Types

type GitRefType

type GitRefType int64

const (
	GitRefUnknown GitRefType = iota
	GitRefLocalBranch
	GitRefRemoteBranch
	GitRefTag
	GitRefHash
)

func GitResolveReference

func GitResolveReference(projectPath, remote, revision string) (GitRefType, error)

GitResolveReference determines if the provided revision is a (local) branch, tag, or hash for use when preparing a cloned repository. This is done by using `git show-ref` for branches/tags and `git rev-parse` for checking whether a commit hash exists. If the reference type cannot be determined, GitRefUnknown is returned.