git

Documentation

Overview

Package git allows to interact with Git.

Index

• func GetCurrentBranchName(t testing.TestingT) string
• func GetCurrentBranchNameContext(t testing.TestingT, ctx context.Context, dir string) string
• func GetCurrentBranchNameContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)
• func GetCurrentBranchNameE(t testing.TestingT) (string, error)
• func GetCurrentBranchNameOldContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)
• func GetCurrentBranchNameOldE(t testing.TestingT) (string, error)
• func GetCurrentGitRef(t testing.TestingT) string
• func GetCurrentGitRefContext(t testing.TestingT, ctx context.Context, dir string) string
• func GetCurrentGitRefContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)
• func GetCurrentGitRefE(t testing.TestingT) (string, error)
• func GetRepoRoot(t testing.TestingT) string
• func GetRepoRootContext(t testing.TestingT, ctx context.Context, dir string) string
• func GetRepoRootContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)
• func GetRepoRootE(t testing.TestingT) (string, error)
• func GetRepoRootForDir(t testing.TestingT, dir string) string
• func GetRepoRootForDirContext(t testing.TestingT, ctx context.Context, dir string) string
• func GetRepoRootForDirContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)
• func GetRepoRootForDirE(t testing.TestingT, dir string) (string, error)
• func GetTagContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)
• func GetTagE(t testing.TestingT) (string, error)

Functions

func GetCurrentBranchName

func GetCurrentBranchName(t testing.TestingT) string

GetCurrentBranchName retrieves the current branch name or an empty string in case of detached state. Fails the test if an error occurs.

Deprecated: Use GetCurrentBranchNameContext instead, which supports context cancellation and accepts an explicit working directory rather than relying on the process working directory.

func GetCurrentBranchNameContext

func GetCurrentBranchNameContext(t testing.TestingT, ctx context.Context, dir string) string

GetCurrentBranchNameContext retrieves the current branch name or an empty string in case of detached state. The dir parameter specifies the working directory for the git command; if empty, the process working directory is used. Fails the test if an error occurs.

func GetCurrentBranchNameContextE

func GetCurrentBranchNameContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)

GetCurrentBranchNameContextE retrieves the current branch name or an empty string in case of detached state. Uses git branch --show-current, which was introduced in git v2.22. Falls back to git rev-parse for older versions. The dir parameter specifies the working directory for the git command; if empty, the process working directory is used.

func GetCurrentBranchNameE

func GetCurrentBranchNameE(t testing.TestingT) (string, error)

GetCurrentBranchNameE retrieves the current branch name or an empty string in case of detached state. Uses git branch --show-current, which was introduced in git v2.22. Falls back to git rev-parse for older versions.

Deprecated: Use GetCurrentBranchNameContextE instead, which supports context cancellation and accepts an explicit working directory rather than relying on the process working directory.

func GetCurrentBranchNameOldContextE

func GetCurrentBranchNameOldContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)

GetCurrentBranchNameOldContextE retrieves the current branch name or an empty string in case of detached state using git rev-parse --abbrev-ref HEAD. This is a fallback for git versions older than v2.22 that lack git branch --show-current. The dir parameter specifies the working directory for the git command; if empty, the process working directory is used.

func GetCurrentBranchNameOldE

func GetCurrentBranchNameOldE(t testing.TestingT) (string, error)

GetCurrentBranchNameOldE retrieves the current branch name or an empty string in case of detached state using git rev-parse --abbrev-ref HEAD.

Deprecated: Use GetCurrentBranchNameOldContextE instead, which supports context cancellation and accepts an explicit working directory rather than relying on the process working directory.

func GetCurrentGitRef

func GetCurrentGitRef(t testing.TestingT) string

GetCurrentGitRef retrieves the current branch name, lightweight (non-annotated) tag, or exact tag value if the tag points to the current commit. Fails the test if an error occurs.

Deprecated: Use GetCurrentGitRefContext instead, which supports context cancellation and accepts an explicit working directory rather than relying on the process working directory.

func GetCurrentGitRefContext

func GetCurrentGitRefContext(t testing.TestingT, ctx context.Context, dir string) string

GetCurrentGitRefContext retrieves the current branch name, lightweight (non-annotated) tag, or exact tag value if the tag points to the current commit. The dir parameter specifies the working directory for the git command; if empty, the process working directory is used. Fails the test if an error occurs.

func GetCurrentGitRefContextE

func GetCurrentGitRefContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)

GetCurrentGitRefContextE retrieves the current branch name, lightweight (non-annotated) tag, or exact tag value if the tag points to the current commit. The dir parameter specifies the working directory for the git command; if empty, the process working directory is used.

func GetCurrentGitRefE

func GetCurrentGitRefE(t testing.TestingT) (string, error)

GetCurrentGitRefE retrieves the current branch name, lightweight (non-annotated) tag, or exact tag value if the tag points to the current commit.

Deprecated: Use GetCurrentGitRefContextE instead, which supports context cancellation and accepts an explicit working directory rather than relying on the process working directory.

func GetRepoRoot

func GetRepoRoot(t testing.TestingT) string

GetRepoRoot retrieves the path to the root directory of the repo. Fails the test if there is an error.

Deprecated: Use GetRepoRootContext instead, which supports context cancellation and accepts an explicit working directory rather than relying on the process working directory.

func GetRepoRootContext

func GetRepoRootContext(t testing.TestingT, ctx context.Context, dir string) string

GetRepoRootContext retrieves the path to the root directory of the repo. The dir parameter specifies the working directory for the git command; if empty, the process working directory is used. Fails the test if there is an error.

func GetRepoRootContextE

func GetRepoRootContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)

GetRepoRootContextE retrieves the path to the root directory of the repo. The dir parameter specifies the working directory for the git command; if empty, the process working directory is used.

func GetRepoRootE

func GetRepoRootE(t testing.TestingT) (string, error)

GetRepoRootE retrieves the path to the root directory of the repo.

Deprecated: Use GetRepoRootContextE instead, which supports context cancellation and accepts an explicit working directory rather than relying on the process working directory.

func GetRepoRootForDir

func GetRepoRootForDir(t testing.TestingT, dir string) string

GetRepoRootForDir retrieves the path to the root directory of the repo in which dir resides. Fails the test if there is an error.

Deprecated: Use GetRepoRootForDirContext instead, which supports context cancellation.

func GetRepoRootForDirContext

func GetRepoRootForDirContext(t testing.TestingT, ctx context.Context, dir string) string

GetRepoRootForDirContext retrieves the path to the root directory of the repo in which dir resides. Fails the test if there is an error.

func GetRepoRootForDirContextE

func GetRepoRootForDirContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)

GetRepoRootForDirContextE retrieves the path to the root directory of the repo in which dir resides.

func GetRepoRootForDirE

func GetRepoRootForDirE(t testing.TestingT, dir string) (string, error)

GetRepoRootForDirE retrieves the path to the root directory of the repo in which dir resides.

Deprecated: Use GetRepoRootForDirContextE instead, which supports context cancellation.

func GetTagContextE

func GetTagContextE(t testing.TestingT, ctx context.Context, dir string) (string, error)

GetTagContextE retrieves the lightweight (non-annotated) tag or exact tag value if the tag points to the current commit. The dir parameter specifies the working directory for the git command; if empty, the process working directory is used.

func GetTagE

func GetTagE(t testing.TestingT) (string, error)

GetTagE retrieves the lightweight (non-annotated) tag or exact tag value if the tag points to the current commit.

Deprecated: Use GetTagContextE instead, which supports context cancellation and accepts an explicit working directory rather than relying on the process working directory.