Documentation
¶
Overview ¶
Package git provides functions for determining changes in a git repository.
Index ¶
- Variables
- func AssertGitStatusClean(ctx context.Context, gitExe string) error
- func CheckRemoteURL(ctx context.Context, gitExe, remote string) error
- func CheckVersion(ctx context.Context, gitExe string) error
- func Checkout(ctx context.Context, gitExe, revision string) error
- func FilesChangedSince(ctx context.Context, gitExe, ref string, ignoredChanges []string) ([]string, error)
- func FindCommitsForPath(ctx context.Context, gitExe, path string) ([]string, error)
- func GetCommitHash(ctx context.Context, gitExe, revision string) (string, error)
- func GetLastTag(ctx context.Context, gitExe, remote, branch string) (string, error)
- func IsNewFile(ctx context.Context, gitExe, ref, name string) bool
- func MatchesBranchPoint(ctx context.Context, gitExe, remote, branch string) error
- func ShowFileAtRemoteBranch(ctx context.Context, gitExe, remote, branch, path string) (string, error)
- func ShowFileAtRevision(ctx context.Context, gitExe, revision, path string) (string, error)
- func Tag(ctx context.Context, gitExe, tagName, revision string) error
Constants ¶
This section is empty.
Variables ¶
var ( // ErrGitStatusUnclean reported when the git status reports uncommitted // changes. ErrGitStatusUnclean = errors.New("git working directory is not clean") )
Functions ¶
func AssertGitStatusClean ¶
AssertGitStatusClean returns an error if the git working directory has uncommitted changes.
func CheckRemoteURL ¶
CheckRemoteURL checks that the git remote URL exists.
func CheckVersion ¶
CheckVersion checks that the git version command can run.
func Checkout ¶ added in v0.8.1
Checkout checks out the given revision. If revision is a commit rather than a branch, this will leave the repository with a detached head. If revision is the name of a valid path, that file is checked out instead. (Git does not provide a way of differentiation between these.)
func FilesChangedSince ¶
func FilesChangedSince(ctx context.Context, gitExe, ref string, ignoredChanges []string) ([]string, error)
FilesChangedSince returns the files changed since the given git ref.
func FindCommitsForPath ¶
FindCommitsForPath returns the full hashes of all commits affecting the given path. The commits are returned in normal log order, i.e. latest commit first.
func GetCommitHash ¶ added in v0.8.1
GetCommitHash returns the commit hash pointed at by the given revision, which could be a tag name, a branch name, a relative revision (e.g. "HEAD~").
func GetLastTag ¶
GetLastTag returns the last git tag for the given release configuration.
func MatchesBranchPoint ¶
MatchesBranchPoint returns an error if the local repository has unpushed changes.
func ShowFileAtRemoteBranch ¶
func ShowFileAtRemoteBranch(ctx context.Context, gitExe, remote, branch, path string) (string, error)
ShowFileAtRemoteBranch shows the contents of the file found at the given path on the given remote/branch.
func ShowFileAtRevision ¶
ShowFileAtRevision shows the contents of the file found at the given path at the given revision (which can be a tag, a commit, a remote/branch etc).
Types ¶
This section is empty.
Source Files