Help us shape the future of Go! Take the 2026 Go Developer Survey

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
- API
  
  Reference documentation for the pkg.go.dev API
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

repository

package

Go to main page

Versions in this module

v0

v0.11.0

Sep 22, 2026

Changes in this version

+ var ErrRefChanged = errors.New("ref changed")

+ func GetDefaultString(key string, cfg ConfigRead, def string) (string, error)

+ func RepoBrowseTest(t *testing.T, repo browsable)

+ func RepoDataUpdateRefTest(t *testing.T, repo RepoData)

+ type BranchInfo struct

+ Hash Hash

+ Name string

+ type ChangeStatus string

+ const ChangeStatusAdded

+ const ChangeStatusDeleted

+ const ChangeStatusModified

+ const ChangeStatusRenamed

+ func (s *ChangeStatus) UnmarshalGQL(v any) error

+ func (s ChangeStatus) MarshalGQL(w io.Writer)

+ type ChangedFile struct

+ OldPath *string

+ Path string

+ Status ChangeStatus

+ type CommitDetail struct

+ Files []ChangedFile

+ FullMessage string

+ type CommitMeta struct

+ AuthorEmail string

+ AuthorName string

+ Date time.Time

+ Hash Hash

+ Message string

+ Parents []Hash

+ type DiffHunk struct

+ Lines []DiffLine

+ NewLines int

+ NewStart int

+ OldLines int

+ OldStart int

+ type DiffLine struct

+ Content string

+ NewLine int

+ OldLine int

+ Type DiffLineType

+ type DiffLineType string

+ const DiffLineAdded

+ const DiffLineContext

+ const DiffLineDeleted

+ func (t *DiffLineType) UnmarshalGQL(v any) error

+ func (t DiffLineType) MarshalGQL(w io.Writer)

+ type FileDiff struct

+ Hunks []DiffHunk

+ IsBinary bool

+ IsDelete bool

+ IsNew bool

+ OldPath *string

+ Path string

+ type GitRefType string

+ const GitRefTypeBranch

+ const GitRefTypeCommit

+ const GitRefTypeTag

+ func (e *GitRefType) UnmarshalGQL(v any) error

+ func (e *GitRefType) UnmarshalJSON(b []byte) error

+ func (e GitRefType) IsValid() bool

+ func (e GitRefType) MarshalGQL(w io.Writer)

+ func (e GitRefType) MarshalJSON() ([]byte, error)

+ func (e GitRefType) String() string

type GoGitRepo

+ func (repo *GoGitRepo) BlobAtPath(ref, path string) (io.ReadCloser, int64, Hash, error)

+ func (repo *GoGitRepo) Branches() ([]BranchInfo, error)

+ func (repo *GoGitRepo) CommitDetail(hash Hash) (CommitDetail, error)

+ func (repo *GoGitRepo) CommitFileDiff(hash Hash, filePath string) (FileDiff, error)

+ func (repo *GoGitRepo) CommitLog(ref, path string, limit int, after Hash, since, until *time.Time) ([]CommitMeta, error)

+ func (repo *GoGitRepo) Head() (RefMeta, error)

+ func (repo *GoGitRepo) LastCommitForEntries(ref, path string, names []string) (map[string]CommitMeta, error)

+ func (repo *GoGitRepo) Tags() ([]TagInfo, error)

+ func (repo *GoGitRepo) TreeAtPath(ref, path string) ([]TreeEntry, error)

type ObjectType

+ const Executable

+ const Submodule

+ const Symlink

+ func (ot *ObjectType) UnmarshalGQL(v any) error

+ func (ot ObjectType) MarshalGQL(w io.Writer)

+ type RefMeta struct

+ Hash string

+ Name string

+ ShortName string

+ Type GitRefType

+ type RepoBrowse interface

+ BlobAtPath func(ref, path string) (io.ReadCloser, int64, Hash, error)

+ Branches func() ([]BranchInfo, error)

+ CommitDetail func(hash Hash) (CommitDetail, error)

+ CommitFileDiff func(hash Hash, filePath string) (FileDiff, error)

+ CommitLog func(ref, path string, limit int, after Hash, since, until *time.Time) ([]CommitMeta, error)

+ Head func() (RefMeta, error)

+ LastCommitForEntries func(ref, path string, names []string) (map[string]CommitMeta, error)

+ Tags func() ([]TagInfo, error)

+ TreeAtPath func(ref, path string) ([]TreeEntry, error)

+ type TagInfo struct

+ Hash Hash

+ Name string

v0.10.1

May 19, 2025

v0.10.0

May 18, 2025

v0.9.0

May 12, 2025

v0.8.1

May 5, 2025

Changes in this version

+ var ErrClockNotExist = errors.New("clock doesn't exist")

+ var ErrKeyringKeyNotFound = keyring.ErrKeyNotFound

+ var ErrMultipleConfigEntry = errors.New("multiple config entry for the given key")

+ var ErrNoConfigEntry = errors.New("no config entry for the given key")

+ var ErrNotARepo = errors.New("not a git repository")

+ var ErrNotFound = errors.New("ref not found")

+ func NewMockRepo() *mockRepo

+ func NewMockRepoClock() *mockRepoClock

+ func NewMockRepoCommon() *mockRepoCommon

+ func NewMockRepoConfig() *mockRepoConfig

+ func NewMockRepoData() *mockRepoData

+ func NewMockRepoKeyring() *mockRepoKeyring

+ func NewMockRepoStorage() *mockRepoStorage

+ func NewMockRepoTest() *mockRepoTest

+ func ParseTimestamp(s string) (time.Time, error)

+ func RepoClockTest(t *testing.T, repo RepoClock)

+ func RepoConfigTest(t *testing.T, repo RepoConfig)

+ func RepoDataSignatureTest(t *testing.T, repo RepoData)

+ func RepoDataTest(t *testing.T, repo RepoData)

+ func RepoIndexTest(t *testing.T, repo RepoIndex)

+ func RepoStorageTest(t *testing.T, repo RepoStorage)

+ func RepoTest(t *testing.T, creator RepoCreator)

+ type ClockLoader struct

+ Clocks []string

+ Witnesser func(repo ClockedRepo) error

+ type ClockedRepo interface

+ type Commit struct

+ Hash Hash

+ Parents []Hash

+ Signature io.Reader

+ SignedData io.Reader

+ TreeHash Hash

+ type Config interface

+ type ConfigRead interface

+ ReadAll func(keyPrefix string) (map[string]string, error)

+ ReadBool func(key string) (bool, error)

+ ReadString func(key string) (string, error)

+ ReadTimestamp func(key string) (time.Time, error)

+ type ConfigWrite interface

+ RemoveAll func(keyPrefix string) error

+ StoreBool func(key string, value bool) error

+ StoreString func(key, value string) error

+ StoreTimestamp func(key string, value time.Time) error

+ type GoGitRepo struct

+ func InitBareGoGitRepo(path, namespace string) (*GoGitRepo, error)

+ func InitGoGitRepo(path, namespace string) (*GoGitRepo, error)

+ func OpenGoGitRepo(path, namespace string, clockLoaders []ClockLoader) (*GoGitRepo, error)

+ func (repo *GoGitRepo) AddRemote(name string, url string) error

+ func (repo *GoGitRepo) AllClocks() (map[string]lamport.Clock, error)

+ func (repo *GoGitRepo) AnyConfig() ConfigRead

+ func (repo *GoGitRepo) Close() error

+ func (repo *GoGitRepo) CopyRef(source string, dest string) error

+ func (repo *GoGitRepo) EraseFromDisk() error

+ func (repo *GoGitRepo) FetchRefs(remote string, prefixes ...string) (string, error)

+ func (repo *GoGitRepo) GetCoreEditor() (string, error)

+ func (repo *GoGitRepo) GetIndex(name string) (Index, error)

+ func (repo *GoGitRepo) GetLocalRemote() string

+ func (repo *GoGitRepo) GetOrCreateClock(name string) (lamport.Clock, error)

+ func (repo *GoGitRepo) GetRemotes() (map[string]string, error)

+ func (repo *GoGitRepo) GetUserEmail() (string, error)

+ func (repo *GoGitRepo) GetUserName() (string, error)

+ func (repo *GoGitRepo) GlobalConfig() Config

+ func (repo *GoGitRepo) Increment(name string) (lamport.Time, error)

+ func (repo *GoGitRepo) Keyring() Keyring

+ func (repo *GoGitRepo) ListCommits(ref string) ([]Hash, error)

+ func (repo *GoGitRepo) ListRefs(refPrefix string) ([]string, error)

+ func (repo *GoGitRepo) LocalConfig() Config

+ func (repo *GoGitRepo) LocalStorage() LocalStorage

+ func (repo *GoGitRepo) PushRefs(remote string, prefixes ...string) (string, error)

+ func (repo *GoGitRepo) ReadCommit(hash Hash) (Commit, error)

+ func (repo *GoGitRepo) ReadData(hash Hash) ([]byte, error)

+ func (repo *GoGitRepo) ReadTree(hash Hash) ([]TreeEntry, error)

+ func (repo *GoGitRepo) RefExist(ref string) (bool, error)

+ func (repo *GoGitRepo) RemoveRef(ref string) error

+ func (repo *GoGitRepo) ResolveRef(ref string) (Hash, error)

+ func (repo *GoGitRepo) StoreCommit(treeHash Hash, parents ...Hash) (Hash, error)

+ func (repo *GoGitRepo) StoreData(data []byte) (Hash, error)

+ func (repo *GoGitRepo) StoreSignedCommit(treeHash Hash, signKey *openpgp.Entity, parents ...Hash) (Hash, error)

+ func (repo *GoGitRepo) StoreTree(mapping []TreeEntry) (Hash, error)

+ func (repo *GoGitRepo) UpdateRef(ref string, hash Hash) error

+ func (repo *GoGitRepo) Witness(name string, time lamport.Time) error

+ type Hash string

+ func (h *Hash) IsValid() bool

+ func (h *Hash) UnmarshalGQL(v interface{}) error

+ func (h Hash) MarshalGQL(w io.Writer)

+ func (h Hash) String() string

+ type Index interface

+ Clear func() error

+ Close func() error

+ DocCount func() (uint64, error)

+ IndexBatch func() (indexer func(id string, texts []string) error, closer func() error)

+ IndexOne func(id string, texts []string) error

+ Remove func(id string) error

+ Search func(terms []string) (ids []string, err error)

+ type Item = keyring.Item

+ type Keyring interface

+ Get func(key string) (Item, error)

+ Keys func() ([]string, error)

+ Remove func(key string) error

+ Set func(item Item) error

+ type LocalStorage interface

+ RemoveAll func(path string) error

+ type MemConfig struct

+ func NewMemConfig() *MemConfig

+ func (mc *MemConfig) ReadAll(keyPrefix string) (map[string]string, error)

+ func (mc *MemConfig) ReadBool(key string) (bool, error)

+ func (mc *MemConfig) ReadString(key string) (string, error)

+ func (mc *MemConfig) ReadTimestamp(key string) (time.Time, error)

+ func (mc *MemConfig) RemoveAll(keyPrefix string) error

+ func (mc *MemConfig) StoreBool(key string, value bool) error

+ func (mc *MemConfig) StoreString(key, value string) error

+ func (mc *MemConfig) StoreTimestamp(key string, value time.Time) error

+ type ObjectType int

+ const Blob

+ const Tree

+ const Unknown

+ func ParseObjectType(mode, objType string) (ObjectType, error)

+ func (ot ObjectType) Format() string

+ type Repo interface

+ Close func() error

+ type RepoClock interface

+ AllClocks func() (map[string]lamport.Clock, error)

+ GetOrCreateClock func(name string) (lamport.Clock, error)

+ Increment func(name string) (lamport.Time, error)

+ Witness func(name string, time lamport.Time) error

+ type RepoCommon interface

+ GetCoreEditor func() (string, error)

+ GetRemotes func() (map[string]string, error)

+ GetUserEmail func() (string, error)

+ GetUserName func() (string, error)

+ type RepoCommonStorage interface

+ type RepoConfig interface

+ AnyConfig func() ConfigRead

+ GlobalConfig func() Config

+ LocalConfig func() Config

+ type RepoCreator func(t testing.TB, bare bool) TestedRepo

+ type RepoData interface

+ CopyRef func(source string, dest string) error

+ FetchRefs func(remote string, prefixes ...string) (string, error)

+ ListCommits func(ref string) ([]Hash, error)

+ ListRefs func(refPrefix string) ([]string, error)

+ PushRefs func(remote string, prefixes ...string) (string, error)

+ ReadCommit func(hash Hash) (Commit, error)

+ ReadData func(hash Hash) ([]byte, error)

+ ReadTree func(hash Hash) ([]TreeEntry, error)

+ RefExist func(ref string) (bool, error)

+ RemoveRef func(ref string) error

+ ResolveRef func(ref string) (Hash, error)

+ StoreCommit func(treeHash Hash, parents ...Hash) (Hash, error)

+ StoreData func(data []byte) (Hash, error)

+ StoreSignedCommit func(treeHash Hash, signKey *openpgp.Entity, parents ...Hash) (Hash, error)

+ StoreTree func(mapping []TreeEntry) (Hash, error)

+ UpdateRef func(ref string, hash Hash) error

+ type RepoIndex interface

+ GetIndex func(name string) (Index, error)

+ type RepoKeyring interface

+ Keyring func() Keyring

+ type RepoStorage interface

+ LocalStorage func() LocalStorage

+ type TestedRepo interface

+ func CreateGoGitTestRepo(t testing.TB, bare bool) TestedRepo

+ func SetupGoGitReposAndRemote(t *testing.T) (repoA, repoB, remote TestedRepo)

+ type TreeEntry struct

+ Hash Hash

+ Name string

+ ObjectType ObjectType

+ func ParseTreeEntry(line string) (TreeEntry, error)

+ func SearchTreeEntry(entries []TreeEntry, name string) (TreeEntry, bool)

+ func (entry TreeEntry) Format() string