Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

gitinterfaces

package

Go to main page

Versions in this module

v0

v0.456.0

Oct 6, 2025

v0.448.0

Sep 5, 2025

v0.446.0

Sep 4, 2025

Changes in this version

+ type GitCommit interface

+ CreateTag func(ctx context.Context, ...) (GitTag, error)

+ GetAgeSeconds func(ctx context.Context) (float64, error)

+ GetAuthorEmail func(ctx context.Context) (string, error)

+ GetAuthorString func(ctx context.Context) (string, error)

+ GetCommitMessage func(ctx context.Context) (string, error)

+ GetHash func(ctx context.Context) (string, error)

+ GetNewestTagVersion func(ctx context.Context) (versionutils.Version, error)

+ GetNewestTagVersionOrNilIfUnset func(ctx context.Context) (versionutils.Version, error)

+ GetNewestTagVersionString func(ctx context.Context) (string, error)

+ GetParentCommits func(ctx context.Context, options *parameteroptions.GitCommitGetParentsOptions) ([]GitCommit, error)

+ HasParentCommit func(ctx context.Context) (bool, error)

+ HasVersionTag func(ctx context.Context) (bool, error)

+ ListTagNames func(ctx context.Context) ([]string, error)

+ ListTags func(ctx context.Context) ([]GitTag, error)

+ ListVersionTagNames func(ctx context.Context) ([]string, error)

+ type GitRemoteConfig interface

+ Equals func(other GitRemoteConfig) bool

+ GetRemoteName func() (string, error)

+ GetUrlFetch func() (string, error)

+ GetUrlPush func() (string, error)

+ SetUrlFetch func(url string) error

+ SetUrlPush func(url string) error

+ type GitRepository interface

+ AddFileByPath func(ctx context.Context, pathToAdd string) (err error)

+ AddFilesByPath func(ctx context.Context, pathsToAdd []string) (err error)

+ AddRemote func(ctx context.Context, options *gitparameteroptions.GitRemoteAddOptions) (err error)

+ BranchByNameExists func(ctx context.Context, branchName string) (branchExists bool, err error)

+ CheckExists func(ctx context.Context) (err error)

+ CheckHasNoUncommittedChanges func(ctx context.Context) (err error)

+ CheckIsGolangApplication func(ctx context.Context) (err error)

+ CheckIsGolangPackage func(ctx context.Context) (err error)

+ CheckIsOnLocalhost func(ctx context.Context) (err error)

+ CheckIsPreCommitRepository func(ctx context.Context) (err error)

+ CheckoutBranchByName func(ctx context.Context, name string) (err error)

+ CloneRepository func(ctx context.Context, repository GitRepository) (err error)

+ CloneRepositoryByPathOrUrl func(ctx context.Context, pathOrUrl string) (err error)

+ Commit func(ctx context.Context, commitOptions *gitparameteroptions.GitCommitOptions) (createdCommit GitCommit, err error)

+ CommitAndPush func(ctx context.Context, commitOptions *gitparameteroptions.GitCommitOptions) (createdCommit GitCommit, err error)

+ CommitHasParentCommitByCommitHash func(hash string) (hasParentCommit bool, err error)

+ CommitIfUncommittedChanges func(ctx context.Context, commitOptions *gitparameteroptions.GitCommitOptions) (createdCommit GitCommit, err error)

+ Create func(ctx context.Context, options *filesoptions.CreateOptions) (err error)

+ CreateAndInit func(ctx context.Context, options *parameteroptions.CreateRepositoryOptions) (err error)

+ CreateBranch func(ctx context.Context, createOptions *parameteroptions.CreateBranchOptions) (err error)

+ CreateFileInDirectory func(ctx context.Context, filePath string, optins *filesoptions.CreateOptions) (createdFile filesinterfaces.File, err error)

+ CreateSubDirectory func(ctx context.Context, subDirectoryName string, ...) (createdSubDirectory filesinterfaces.Directory, err error)

+ CreateTag func(ctx context.Context, ...) (createdTag GitTag, err error)

+ Delete func(ctx context.Context, options *filesoptions.DeleteOptions) (err error)

+ DeleteBranchByName func(ctx context.Context, name string) (err error)

+ DirectoryByPathExists func(ctx context.Context, path ...string) (exists bool, err error)

+ EnsureMainReadmeMdExists func(ctx context.Context) (err error)

+ Exists func(ctx context.Context) (exists bool, err error)

+ Fetch func(ctx context.Context) (err error)

+ FileByPathExists func(ctx context.Context, path string) (exists bool, err error)

+ GetAuthorEmailByCommitHash func(hash string) (authorEmail string, err error)

+ GetAuthorStringByCommitHash func(hash string) (authorString string, err error)

+ GetCommitAgeDurationByCommitHash func(hash string) (ageDuration *time.Duration, err error)

+ GetCommitAgeSecondsByCommitHash func(hash string) (ageSeconds float64, err error)

+ GetCommitMessageByCommitHash func(hash string) (commitMessage string, err error)

+ GetCommitParentsByCommitHash func(ctx context.Context, hash string, ...) (commitParents []GitCommit, err error)

+ GetCommitTimeByCommitHash func(hash string) (commitTime *time.Time, err error)

+ GetCurrentBranchName func(ctx context.Context) (branchName string, err error)

+ GetCurrentCommit func(ctx context.Context) (commit GitCommit, err error)

+ GetCurrentCommitHash func(ctx context.Context) (currentCommitHash string, err error)

+ GetCurrentCommitMessage func(ctx context.Context) (currentCommitMessage string, err error)

+ GetCurrentCommitsNewestVersion func(ctx context.Context) (newestVersion versionutils.Version, err error)

+ GetCurrentCommitsNewestVersionOrNilIfNotPresent func(ctx context.Context) (newestVersion versionutils.Version, err error)

+ GetDirectoryByPath func(pathToSubDir ...string) (subDir filesinterfaces.Directory, err error)

+ GetFileByPath func(path ...string) (fileInRepo filesinterfaces.File, err error)

+ GetGitStatusOutput func(ctx context.Context) (output string, err error)

+ GetHashByTagName func(tagName string) (hash string, err error)

+ GetHostDescription func() (hostDescription string, err error)

+ GetLatestTagVersion func(ctx context.Context) (latestTagVersion versionutils.Version, err error)

+ GetLatestTagVersionAsString func(ctx context.Context) (latestTagVersion string, err error)

+ GetLatestTagVersionOrNilIfNotFound func(ctx context.Context) (latestTagVersion versionutils.Version, err error)

+ GetPath func() (path string, err error)

+ GetPathAndHostDescription func() (path string, hostDescription string, err error)

+ GetRemoteConfigs func(ctx context.Context) (remoteConfigs []GitRemoteConfig, err error)

+ GetRootDirectory func(ctx context.Context) (directory filesinterfaces.Directory, err error)

+ GetRootDirectoryPath func(ctx context.Context) (path string, err error)

+ HasInitialCommit func(ctx context.Context) (hasInitialCommit bool, err error)

+ HasNoUncommittedChanges func(ctx context.Context) (noUncommitedChnages bool, err error)

+ HasUncommittedChanges func(ctx context.Context) (hasUncommitedChanges bool, err error)

+ Init func(ctx context.Context, options *parameteroptions.CreateRepositoryOptions) (err error)

+ IsBareRepository func(ctx context.Context) (isBareRepository bool, err error)

+ IsGitRepository func(ctx context.Context) (isRepository bool, err error)

+ IsGolangApplication func(ctx context.Context) (isGolangApplication bool, err error)

+ IsGolangPackage func(ctx context.Context) (isGolangPackage bool, err error)

+ IsInitialized func(ctx context.Context) (isInitialited bool, err error)

+ IsOnLocalhost func(ctx context.Context) (isOnLocalhost bool, err error)

+ IsPreCommitRepository func(ctx context.Context) (isPreCommitRepository bool, err error)

+ ListBranchNames func(ctx context.Context) (branchNames []string, err error)

+ ListFilePaths func(ctx context.Context, listFileOptions *parameteroptions.ListFileOptions) (filePaths []string, err error)

+ ListFiles func(ctx context.Context, listFileOptions *parameteroptions.ListFileOptions) (files []filesinterfaces.File, err error)

+ ListTagNames func(ctx context.Context) (tagNames []string, err error)

+ ListTags func(ctx context.Context) (tags []GitTag, err error)

+ ListTagsForCommitHash func(ctx context.Context, hash string) (tags []GitTag, err error)

+ ListVersionTags func(ctx context.Context) (versionTags []GitTag, err error)

+ Pull func(ctx context.Context) (err error)

+ PullFromRemote func(pullOptions *gitparameteroptions.GitPullFromRemoteOptions) (err error)

+ Push func(ctx context.Context) (err error)

+ PushTagsToRemote func(ctx context.Context, remoteName string) (err error)

+ PushToRemote func(ctx context.Context, remoteName string) (err error)

+ RemoteByNameExists func(ctx context.Context, remoteName string) (remoteExists bool, err error)

+ RemoteConfigurationExists func(ctx context.Context, config GitRemoteConfig) (exists bool, err error)

+ RemoveRemoteByName func(ctx context.Context, remoteName string) (err error)

+ SetGitConfig func(ctx context.Context, options *gitparameteroptions.GitConfigSetOptions) (err error)

+ SetRemoteUrl func(ctx context.Context, remoteUrl string) (err error)

+ WriteBytesToFile func(ctx context.Context, path string, content []byte, ...) (writtenFile filesinterfaces.File, err error)

+ WriteStringToFile func(ctx context.Context, path string, content string, ...) (writtenFile filesinterfaces.File, err error)

+ type GitTag interface

+ GetGitRepository func() (repo GitRepository, err error)

+ GetHash func(ctx context.Context) (hash string, err error)

+ GetName func() (name string, err error)

+ GetVersion func() (version versionutils.Version, err error)

+ IsVersionTag func() (isVersionTag bool, err error)

+ SetName func(name string) (err error)