git

package module
v4.2.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 3, 2018 License: Apache-2.0 Imports: 44 Imported by: 1

README

go-git logo GoDoc Build Status Build status codecov.io Go Report Card

go-git is a highly extensible git implementation library written in pure Go.

It can be used to manipulate git repositories at low level (plumbing) or high level (porcelain), through an idiomatic Go API. It also supports several type of storage, such as in-memory filesystems, or custom implementations thanks to the Storer interface.

It's being actively develop since 2015 and is being use extensively by source{d} and Keybase, and by many other libraries and tools.

Comparison with git

go-git aims to be fully compatible with git, all the porcelain operations are implemented to work exactly as git does.

git is a humongous project with years of development by thousands of contributors, making it challenging for go-git implement all the features. You can find a comparison of go-git vs git in the compatibility documentation.

Installation

The recommended way to install go-git is:

go get -u gopkg.in/src-d/go-git.v4/...

We use gopkg.in for having a versioned API, this means that when go get clones the package, is the latest tag matching v4.* cloned and not the master branch.

Examples

Please note that the functions CheckIfError and Info used in the examples are from the examples package just to be used in the examples.

Basic example

A basic example that mimics the standard git clone command

// Clone the given repository to the given directory
Info("git clone https://github.com/src-d/go-git")

_, err := git.PlainClone("/tmp/foo", false, &git.CloneOptions{
    URL:      "https://github.com/src-d/go-git",
    Progress: os.Stdout,
})

CheckIfError(err)

Outputs:

Counting objects: 4924, done.
Compressing objects: 100% (1333/1333), done.
Total 4924 (delta 530), reused 6 (delta 6), pack-reused 3533

In-memory example

Cloning a repository into memory and printing the history of HEAD, just like git log does

// Clones the given repository in memory, creating the remote, the local
// branches and fetching the objects, exactly as:
Info("git clone https://github.com/src-d/go-siva")

r, err := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{
    URL: "https://github.com/src-d/go-siva",
})

CheckIfError(err)

// Gets the HEAD history from HEAD, just like does:
Info("git log")

// ... retrieves the branch pointed by HEAD
ref, err := r.Head()
CheckIfError(err)


// ... retrieves the commit history
cIter, err := r.Log(&git.LogOptions{From: ref.Hash()})
CheckIfError(err)

// ... just iterates over the commits, printing it
err = cIter.ForEach(func(c *object.Commit) error {
	fmt.Println(c)
	return nil
})
CheckIfError(err)

Outputs:

commit ded8054fd0c3994453e9c8aacaf48d118d42991e
Author: Santiago M. Mola <santi@mola.io>
Date:   Sat Nov 12 21:18:41 2016 +0100

    index: ReadFrom/WriteTo returns IndexReadError/IndexWriteError. (#9)

commit df707095626f384ce2dc1a83b30f9a21d69b9dfc
Author: Santiago M. Mola <santi@mola.io>
Date:   Fri Nov 11 13:23:22 2016 +0100

    readwriter: fix bug when writing index. (#10)

    When using ReadWriter on an existing siva file, absolute offset for
    index entries was not being calculated correctly.
...

You can find this example and many others at the examples folder

Contribute

Contributions are more than welcome, if you are interested please take a look to our Contributing Guidelines.

License

Apache License Version 2.0, see LICENSE

Documentation

Overview

A highly extensible git implementation in pure Go.

go-git aims to reach the completeness of libgit2 or jgit, nowadays covers the majority of the plumbing read operations and some of the main write operations, but lacks the main porcelain operations such as merges.

It is highly extensible, we have been following the open/close principle in its design to facilitate extensions, mainly focusing the efforts on the persistence of the objects.

Index

Examples

Constants

This section is empty.

Variables

View Source 
var (
	ErrBranchHashExclusive  = errors.New("Branch and Hash are mutually exclusive")
	ErrCreateRequiresBranch = errors.New("Branch is mandatory when Create is used")
)
View Source 
var (
	NoErrAlreadyUpToDate     = errors.New("already up-to-date")
	ErrDeleteRefNotSupported = errors.New("server does not support delete-refs")
	ErrForceNeeded           = errors.New("some refs were not updated")
)
View Source 
var (
	ErrInvalidReference          = errors.New("invalid reference, should be a tag or a branch")
	ErrRepositoryNotExists       = errors.New("repository does not exist")
	ErrRepositoryAlreadyExists   = errors.New("repository already exists")
	ErrRemoteNotFound            = errors.New("remote not found")
	ErrRemoteExists              = errors.New("remote already exists	")
	ErrWorktreeNotProvided       = errors.New("worktree should be provided")
	ErrIsBareRepository          = errors.New("worktree not available in a bare repository")
	ErrUnableToResolveCommit     = errors.New("unable to resolve commit")
	ErrPackedObjectsNotSupported = errors.New("Packed objects not supported")
)
View Source 
var (
	ErrSubmoduleAlreadyInitialized = errors.New("submodule already initialized")
	ErrSubmoduleNotInitialized     = errors.New("submodule not initialized")
)
View Source 
var (
	ErrWorktreeNotClean  = errors.New("worktree is not clean")
	ErrSubmoduleNotFound = errors.New("submodule not found")
	ErrUnstagedChanges   = errors.New("worktree contains unstaged changes")
)
View Source 
var (
	// ErrDestinationExists in an Move operation means that the target exists on
	// the worktree.
	ErrDestinationExists = errors.New("destination exists")
	// ErrGlobNoMatches in an AddGlob if the glob pattern does not match any
	// files in the worktree.
	ErrGlobNoMatches = errors.New("glob pattern did not match any files")
)
View Source 
var (
	ErrHashOrReference = errors.New("ambiguous options, only one of CommitHash or ReferenceName can be passed")
)
View Source 
var ErrLooseObjectsNotSupported = errors.New("Loose objects not supported")
View Source 
var (
	ErrMissingAuthor = errors.New("author field is required")
)
View Source 
var (
	ErrMissingURL = errors.New("URL field is required")
)

Functions

This section is empty.

Types

type BlameResult 

type BlameResult struct {
	// Path is the path of the File that we're blaming.
	Path string
	// Rev (Revision) is the hash of the specified Commit used to generate this result.
	Rev plumbing.Hash
	// Lines contains every line with its authorship.
	Lines []*Line
}

BlameResult represents the result of a Blame operation.

func Blame 

func Blame(c *object.Commit, path string) (*BlameResult, error)

Blame returns a BlameResult with the information about the last author of each line from file `path` at commit `c`.

type CheckoutOptions 

type CheckoutOptions struct {
	// Hash to be checked out, if used HEAD will in detached mode. Branch and
	// Hash are mutually exclusive, if Create is not used.
	Hash plumbing.Hash
	// Branch to be checked out, if Branch and Hash are empty is set to `master`.
	Branch plumbing.ReferenceName
	// Create a new branch named Branch and start it at Hash.
	Create bool
	// Force, if true when switching branches, proceed even if the index or the
	// working tree differs from HEAD. This is used to throw away local changes
	Force bool
}

CheckoutOptions describes how a checkout 31operation should be performed.

func (*CheckoutOptions) Validate 

func (o *CheckoutOptions) Validate() error

Validate validates the fields and sets the default values.

type CleanOptions 

type CleanOptions struct {
	Dir bool
}

CleanOptions describes how a clean should be performed.

type CloneOptions 

type CloneOptions struct {
	// The (possibly remote) repository URL to clone from.
	URL string
	// Auth credentials, if required, to use with the remote repository.
	Auth transport.AuthMethod
	// Name of the remote to be added, by default `origin`.
	RemoteName string
	// Remote branch to clone.
	ReferenceName plumbing.ReferenceName
	// Fetch only ReferenceName if true.
	SingleBranch bool
	// No checkout of HEAD after clone if true.
	NoCheckout bool
	// Limit fetching to the specified number of commits.
	Depth int
	// RecurseSubmodules after the clone is created, initialize all submodules
	// within, using their default settings. This option is ignored if the
	// cloned repository does not have a worktree.
	RecurseSubmodules SubmoduleRescursivity
	// Progress is where the human readable information sent by the server is
	// stored, if nil nothing is stored and the capability (if supported)
	// no-progress, is sent to the server to avoid send this information.
	Progress sideband.Progress
	// Tags describe how the tags will be fetched from the remote repository,
	// by default is AllTags.
	Tags TagMode
}

CloneOptions describes how a clone should be performed.

func (*CloneOptions) Validate 

func (o *CloneOptions) Validate() error

Validate validates the fields and sets the default values.

type CommitOptions 

type CommitOptions struct {
	// All automatically stage files that have been modified and deleted, but
	// new files you have not told Git about are not affected.
	All bool
	// Author is the author's signature of the commit.
	Author *object.Signature
	// Committer is the committer's signature of the commit. If Committer is
	// nil the Author signature is used.
	Committer *object.Signature
	// Parents are the parents commits for the new commit, by default when
	// len(Parents) is zero, the hash of HEAD reference is used.
	Parents []plumbing.Hash
}

CommitOptions describes how a commit operation should be performed.

func (*CommitOptions) Validate 

func (o *CommitOptions) Validate(r *Repository) error

Validate validates the fields and sets the default values.

type FetchOptions 

type FetchOptions struct {
	// Name of the remote to fetch from. Defaults to origin.
	RemoteName string
	RefSpecs   []config.RefSpec
	// Depth limit fetching to the specified number of commits from the tip of
	// each remote branch history.
	Depth int
	// Auth credentials, if required, to use with the remote repository.
	Auth transport.AuthMethod
	// Progress is where the human readable information sent by the server is
	// stored, if nil nothing is stored and the capability (if supported)
	// no-progress, is sent to the server to avoid send this information.
	Progress sideband.Progress
	// Tags describe how the tags will be fetched from the remote repository,
	// by default is TagFollowing.
	Tags TagMode
	// Force allows the fetch to update a local branch even when the remote
	// branch does not descend from it.
	Force bool
}

FetchOptions describes how a fetch should be performed

func (*FetchOptions) Validate 

func (o *FetchOptions) Validate() error

Validate validates the fields and sets the default values.

type FileStatus 

type FileStatus struct {
	// Staging is the status of a file in the staging area
	Staging StatusCode
	// Worktree is the status of a file in the worktree
	Worktree StatusCode
	// Extra contains extra information, such as the previous name in a rename
	Extra string
}

FileStatus contains the status of a file in the worktree

type GrepOptions 

type GrepOptions struct {
	// Patterns are compiled Regexp objects to be matched.
	Patterns []*regexp.Regexp
	// InvertMatch selects non-matching lines.
	InvertMatch bool
	// CommitHash is the hash of the commit from which worktree should be derived.
	CommitHash plumbing.Hash
	// ReferenceName is the branch or tag name from which worktree should be derived.
	ReferenceName plumbing.ReferenceName
	// PathSpecs are compiled Regexp objects of pathspec to use in the matching.
	PathSpecs []*regexp.Regexp
}

GrepOptions describes how a grep should be performed.

func (*GrepOptions) Validate 

func (o *GrepOptions) Validate(w *Worktree) error

Validate validates the fields and sets the default values.

type GrepResult 

type GrepResult struct {
	// FileName is the name of file which contains match.
	FileName string
	// LineNumber is the line number of a file at which a match was found.
	LineNumber int
	// Content is the content of the file at the matching line.
	Content string
	// TreeName is the name of the tree (reference name/commit hash) at
	// which the match was performed.
	TreeName string
}

GrepResult is structure of a grep result.

func (GrepResult) String 

func (gr GrepResult) String() string

type Line 

type Line struct {
	// Author is the email address of the last author that modified the line.
	Author string
	// Text is the original text of the line.
	Text string
	// Date is when the original text of the line was introduced
	Date time.Time
	// Hash is the commit hash that introduced the original line
	Hash plumbing.Hash
}

Line values represent the contents and author of a line in BlamedResult values.

type ListOptions 

type ListOptions struct {
	// Auth credentials, if required, to use with the remote repository.
	Auth transport.AuthMethod
}

ListOptions describes how a remote list should be performed.

type LogOptions 

type LogOptions struct {
	// When the From option is set the log will only contain commits
	// reachable from it. If this option is not set, HEAD will be used as
	// the default From.
	From plumbing.Hash

	// The default traversal algorithm is Depth-first search
	// set Order=LogOrderCommitterTime for ordering by committer time (more compatible with `git log`)
	// set Order=LogOrderBSF for Breadth-first search
	Order LogOrder
}

LogOptions describes how a log action should be performed.

type LogOrder 

type LogOrder int8
const (
	LogOrderDefault LogOrder = iota
	LogOrderDFS
	LogOrderDFSPost
	LogOrderBSF
	LogOrderCommitterTime
)

type PruneHandler 

type PruneHandler func(unreferencedObjectHash plumbing.Hash) error

type PruneOptions 

type PruneOptions struct {
	// OnlyObjectsOlderThan if set to non-zero value
	// selects only objects older than the time provided.
	OnlyObjectsOlderThan time.Time
	// Handler is called on matching objects
	Handler PruneHandler
}

type PullOptions 

type PullOptions struct {
	// Name of the remote to be pulled. If empty, uses the default.
	RemoteName string
	// Remote branch to clone. If empty, uses HEAD.
	ReferenceName plumbing.ReferenceName
	// Fetch only ReferenceName if true.
	SingleBranch bool
	// Limit fetching to the specified number of commits.
	Depth int
	// Auth credentials, if required, to use with the remote repository.
	Auth transport.AuthMethod
	// RecurseSubmodules controls if new commits of all populated submodules
	// should be fetched too.
	RecurseSubmodules SubmoduleRescursivity
	// Progress is where the human readable information sent by the server is
	// stored, if nil nothing is stored and the capability (if supported)
	// no-progress, is sent to the server to avoid send this information.
	Progress sideband.Progress
	// Force allows the pull to update a local branch even when the remote
	// branch does not descend from it.
	Force bool
}

PullOptions describes how a pull should be performed.

func (*PullOptions) Validate 

func (o *PullOptions) Validate() error

Validate validates the fields and sets the default values.

type PushOptions 

type PushOptions struct {
	// RemoteName is the name of the remote to be pushed to.
	RemoteName string
	// RefSpecs specify what destination ref to update with what source
	// object. A refspec with empty src can be used to delete a reference.
	RefSpecs []config.RefSpec
	// Auth credentials, if required, to use with the remote repository.
	Auth transport.AuthMethod
	// Progress is where the human readable information sent by the server is
	// stored, if nil nothing is stored.
	Progress sideband.Progress
}

PushOptions describes how a push should be performed.

func (*PushOptions) Validate 

func (o *PushOptions) Validate() error

Validate validates the fields and sets the default values.

type Remote 

type Remote struct {
	// contains filtered or unexported fields
}

Remote represents a connection to a remote repository.

func (*Remote) Config 

func (r *Remote) Config() *config.RemoteConfig

Config returns the RemoteConfig object used to instantiate this Remote.

func (*Remote) Fetch 

func (r *Remote) Fetch(o *FetchOptions) error

Fetch fetches references along with the objects necessary to complete their histories.

Returns nil if the operation is successful, NoErrAlreadyUpToDate if there are no changes to be fetched, or an error.

func (*Remote) FetchContext 

func (r *Remote) FetchContext(ctx context.Context, o *FetchOptions) error

FetchContext fetches references along with the objects necessary to complete their histories.

Returns nil if the operation is successful, NoErrAlreadyUpToDate if there are no changes to be fetched, or an error.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

func (*Remote) List 

func (r *Remote) List(o *ListOptions) (rfs []*plumbing.Reference, err error)

List the references on the remote repository.

func (*Remote) Push 

func (r *Remote) Push(o *PushOptions) error

Push performs a push to the remote. Returns NoErrAlreadyUpToDate if the remote was already up-to-date.

func (*Remote) PushContext 

func (r *Remote) PushContext(ctx context.Context, o *PushOptions) (err error)

PushContext performs a push to the remote. Returns NoErrAlreadyUpToDate if the remote was already up-to-date.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

func (*Remote) String 

func (r *Remote) String() string

type RepackConfig 

type RepackConfig struct {
	// UseRefDeltas configures whether packfile encoder will use reference deltas.
	// By default OFSDeltaObject is used.
	UseRefDeltas bool
	// OnlyDeletePacksOlderThan if set to non-zero value
	// selects only objects older than the time provided.
	OnlyDeletePacksOlderThan time.Time
}

type Repository 

type Repository struct {
	Storer storage.Storer
	// contains filtered or unexported fields
}

Repository represents a git repository

func Clone 

func Clone(s storage.Storer, worktree billy.Filesystem, o *CloneOptions) (*Repository, error)

Clone a repository into the given Storer and worktree Filesystem with the given options, if worktree is nil a bare repository is created. If the given storer is not empty ErrRepositoryAlreadyExists is returned.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

Example 
// Filesystem abstraction based on memory
fs := memfs.New()
// Git objects storer based on memory
storer := memory.NewStorage()

// Clones the repository into the worktree (fs) and storer all the .git
// content into the storer
_, _ = git.Clone(storer, fs, &git.CloneOptions{
	URL: "https://github.com/git-fixtures/basic.git",
})

// Prints the content of the CHANGELOG file from the cloned repository
changelog, _ := fs.Open("CHANGELOG")

io.Copy(os.Stdout, changelog)

Output:

Initial changelog

func CloneContext 

func CloneContext(
	ctx context.Context, s storage.Storer, worktree billy.Filesystem, o *CloneOptions,
) (*Repository, error)

CloneContext a repository into the given Storer and worktree Filesystem with the given options, if worktree is nil a bare repository is created. If the given storer is not empty ErrRepositoryAlreadyExists is returned.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

func Init 

func Init(s storage.Storer, worktree billy.Filesystem) (*Repository, error)

Init creates an empty git repository, based on the given Storer and worktree. The worktree Filesystem is optional, if nil a bare repository is created. If the given storer is not empty ErrRepositoryAlreadyExists is returned

func Open 

func Open(s storage.Storer, worktree billy.Filesystem) (*Repository, error)

Open opens a git repository using the given Storer and worktree filesystem, if the given storer is complete empty ErrRepositoryNotExists is returned. The worktree can be nil when the repository being opened is bare, if the repository is a normal one (not bare) and worktree is nil the err ErrWorktreeNotProvided is returned

func PlainClone 

func PlainClone(path string, isBare bool, o *CloneOptions) (*Repository, error)

PlainClone a repository into the path with the given options, isBare defines if the new repository will be bare or normal. If the path is not empty ErrRepositoryAlreadyExists is returned.

Example 
// Tempdir to clone the repository
dir, err := ioutil.TempDir("", "clone-example")
if err != nil {
	log.Fatal(err)
}

defer os.RemoveAll(dir) // clean up

// Clones the repository into the given dir, just as a normal git clone does
_, err = git.PlainClone(dir, false, &git.CloneOptions{
	URL: "https://github.com/git-fixtures/basic.git",
})

if err != nil {
	log.Fatal(err)
}

// Prints the content of the CHANGELOG file from the cloned repository
changelog, err := os.Open(filepath.Join(dir, "CHANGELOG"))
if err != nil {
	log.Fatal(err)
}

io.Copy(os.Stdout, changelog)

Output:

Initial changelog

func PlainCloneContext 

func PlainCloneContext(ctx context.Context, path string, isBare bool, o *CloneOptions) (*Repository, error)

PlainCloneContext a repository into the path with the given options, isBare defines if the new repository will be bare or normal. If the path is not empty ErrRepositoryAlreadyExists is returned.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

func PlainInit 

func PlainInit(path string, isBare bool) (*Repository, error)

PlainInit create an empty git repository at the given path. isBare defines if the repository will have worktree (non-bare) or not (bare), if the path is not empty ErrRepositoryAlreadyExists is returned.

func PlainOpen 

func PlainOpen(path string) (*Repository, error)

PlainOpen opens a git repository from the given path. It detects if the repository is bare or a normal one. If the path doesn't contain a valid repository ErrRepositoryNotExists is returned

func (*Repository) BlobObject 

func (r *Repository) BlobObject(h plumbing.Hash) (*object.Blob, error)

BlobObject returns a Blob with the given hash. If not found plumbing.ErrObjectNotFound is returned.

func (*Repository) BlobObjects 

func (r *Repository) BlobObjects() (*object.BlobIter, error)

BlobObjects returns an unsorted BlobIter with all the blobs in the repository.

func (*Repository) Branches 

func (r *Repository) Branches() (storer.ReferenceIter, error)

Branches returns all the References that are Branches.

func (*Repository) CommitObject 

func (r *Repository) CommitObject(h plumbing.Hash) (*object.Commit, error)

CommitObject return a Commit with the given hash. If not found plumbing.ErrObjectNotFound is returned.

func (*Repository) CommitObjects 

func (r *Repository) CommitObjects() (object.CommitIter, error)

CommitObjects returns an unsorted CommitIter with all the commits in the repository.

func (*Repository) Config 

func (r *Repository) Config() (*config.Config, error)

Config return the repository config

func (*Repository) CreateRemote 

func (r *Repository) CreateRemote(c *config.RemoteConfig) (*Remote, error)

CreateRemote creates a new remote

Example 
r, _ := git.Init(memory.NewStorage(), nil)

// Add a new remote, with the default fetch refspec
_, err := r.CreateRemote(&config.RemoteConfig{
	Name: "example",
	URLs: []string{"https://github.com/git-fixtures/basic.git"},
})

if err != nil {
	log.Fatal(err)
}

list, err := r.Remotes()
if err != nil {
	log.Fatal(err)
}

for _, r := range list {
	fmt.Println(r)
}

// Example Output:
// example https://github.com/git-fixtures/basic.git (fetch)
// example https://github.com/git-fixtures/basic.git (push)

Output:

func (*Repository) DeleteObject 

func (r *Repository) DeleteObject(hash plumbing.Hash) error

DeleteObject deletes an object from a repository. The type conveniently matches PruneHandler.

func (*Repository) DeleteRemote 

func (r *Repository) DeleteRemote(name string) error

DeleteRemote delete a remote from the repository and delete the config

func (*Repository) Fetch 

func (r *Repository) Fetch(o *FetchOptions) error

Fetch fetches references along with the objects necessary to complete their histories, from the remote named as FetchOptions.RemoteName.

Returns nil if the operation is successful, NoErrAlreadyUpToDate if there are no changes to be fetched, or an error.

func (*Repository) FetchContext 

func (r *Repository) FetchContext(ctx context.Context, o *FetchOptions) error

FetchContext fetches references along with the objects necessary to complete their histories, from the remote named as FetchOptions.RemoteName.

Returns nil if the operation is successful, NoErrAlreadyUpToDate if there are no changes to be fetched, or an error.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

func (*Repository) Head 

func (r *Repository) Head() (*plumbing.Reference, error)

Head returns the reference where HEAD is pointing to.

func (*Repository) Log 

func (r *Repository) Log(o *LogOptions) (object.CommitIter, error)

Log returns the commit history from the given LogOptions.

func (*Repository) Notes 

func (r *Repository) Notes() (storer.ReferenceIter, error)

Notes returns all the References that are Branches.

func (*Repository) Object 

func (r *Repository) Object(t plumbing.ObjectType, h plumbing.Hash) (object.Object, error)

Object returns an Object with the given hash. If not found plumbing.ErrObjectNotFound is returned.

func (*Repository) Objects 

func (r *Repository) Objects() (*object.ObjectIter, error)

Objects returns an unsorted ObjectIter with all the objects in the repository.

func (*Repository) Prune 

func (r *Repository) Prune(opt PruneOptions) error

func (*Repository) Push 

func (r *Repository) Push(o *PushOptions) error

Push performs a push to the remote. Returns NoErrAlreadyUpToDate if the remote was already up-to-date, from the remote named as FetchOptions.RemoteName.

func (*Repository) PushContext 

func (r *Repository) PushContext(ctx context.Context, o *PushOptions) error

PushContext performs a push to the remote. Returns NoErrAlreadyUpToDate if the remote was already up-to-date, from the remote named as FetchOptions.RemoteName.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

func (*Repository) Reference 

func (r *Repository) Reference(name plumbing.ReferenceName, resolved bool) (
	*plumbing.Reference, error)

Reference returns the reference for a given reference name. If resolved is true, any symbolic reference will be resolved.

func (*Repository) References 

func (r *Repository) References() (storer.ReferenceIter, error)

References returns an unsorted ReferenceIter for all references.

Example 
r, _ := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{
	URL: "https://github.com/git-fixtures/basic.git",
})

// simulating a git show-ref
refs, _ := r.References()
refs.ForEach(func(ref *plumbing.Reference) error {
	if ref.Type() == plumbing.HashReference {
		fmt.Println(ref)
	}

	return nil
})

// Example Output:
// 6ecf0ef2c2dffb796033e5a02219af86ec6584e5 refs/remotes/origin/master
// e8d3ffab552895c19b9fcf7aa264d277cde33881 refs/remotes/origin/branch
// 6ecf0ef2c2dffb796033e5a02219af86ec6584e5 refs/heads/master

Output:

func (*Repository) Remote 

func (r *Repository) Remote(name string) (*Remote, error)

Remote return a remote if exists

func (*Repository) Remotes 

func (r *Repository) Remotes() ([]*Remote, error)

Remotes returns a list with all the remotes

func (*Repository) RepackObjects 

func (r *Repository) RepackObjects(cfg *RepackConfig) (err error)

func (*Repository) ResolveRevision 

func (r *Repository) ResolveRevision(rev plumbing.Revision) (*plumbing.Hash, error)

ResolveRevision resolves revision to corresponding hash.

Implemented resolvers : HEAD, branch, tag, heads/branch, refs/heads/branch, refs/tags/tag, refs/remotes/origin/branch, refs/remotes/origin/HEAD, tilde and caret (HEAD~1, master~^, tag~2, ref/heads/master~1, ...), selection by text (HEAD^{/fix nasty bug})

func (*Repository) TagObject 

func (r *Repository) TagObject(h plumbing.Hash) (*object.Tag, error)

TagObject returns a Tag with the given hash. If not found plumbing.ErrObjectNotFound is returned. This method only returns annotated Tags, no lightweight Tags.

func (*Repository) TagObjects 

func (r *Repository) TagObjects() (*object.TagIter, error)

TagObjects returns a unsorted TagIter that can step through all of the annotated tags in the repository.

func (*Repository) Tags 

func (r *Repository) Tags() (storer.ReferenceIter, error)

Tags returns all the References from Tags. This method returns all the tag types, lightweight, and annotated ones.

func (*Repository) TreeObject 

func (r *Repository) TreeObject(h plumbing.Hash) (*object.Tree, error)

TreeObject return a Tree with the given hash. If not found plumbing.ErrObjectNotFound is returned

func (*Repository) TreeObjects 

func (r *Repository) TreeObjects() (*object.TreeIter, error)

TreeObjects returns an unsorted TreeIter with all the trees in the repository

func (*Repository) Worktree 

func (r *Repository) Worktree() (*Worktree, error)

Worktree returns a worktree based on the given fs, if nil the default worktree will be used.

type ResetMode 

type ResetMode int8

ResetMode defines the mode of a reset operation. 

const (
	// MixedReset resets the index but not the working tree (i.e., the changed
	// files are preserved but not marked for commit) and reports what has not
	// been updated. This is the default action.
	MixedReset ResetMode = iota
	// HardReset resets the index and working tree. Any changes to tracked files
	// in the working tree are discarded.
	HardReset
	// MergeReset resets the index and updates the files in the working tree
	// that are different between Commit and HEAD, but keeps those which are
	// different between the index and working tree (i.e. which have changes
	// which have not been added).
	//
	// If a file that is different between Commit and the index has unstaged
	// changes, reset is aborted.
	MergeReset
	// SoftReset does not touch the index file or the working tree at all (but
	// resets the head to <commit>, just like all modes do). This leaves all
	// your changed files "Changes to be committed", as git status would put it.
	SoftReset
)

type ResetOptions 

type ResetOptions struct {
	// Commit, if commit is pressent set the current branch head (HEAD) to it.
	Commit plumbing.Hash
	// Mode, form resets the current branch head to Commit and possibly updates
	// the index (resetting it to the tree of Commit) and the working tree
	// depending on Mode. If empty MixedReset is used.
	Mode ResetMode
}

ResetOptions describes how a reset operation should be performed.

func (*ResetOptions) Validate 

func (o *ResetOptions) Validate(r *Repository) error

Validate validates the fields and sets the default values.

type Status 

type Status map[string]*FileStatus

Status represents the current status of a Worktree. The key of the map is the path of the file.

func (Status) File 

func (s Status) File(path string) *FileStatus

File returns the FileStatus for a given path, if the FileStatus doesn't exists a new FileStatus is added to the map using the path as key.

func (Status) IsClean 

func (s Status) IsClean() bool

IsClean returns true if all the files aren't in Unmodified status.

func (Status) String 

func (s Status) String() string

type StatusCode 

type StatusCode byte

StatusCode status code of a file in the Worktree 

const (
	Unmodified         StatusCode = ' '
	Untracked          StatusCode = '?'
	Modified           StatusCode = 'M'
	Added              StatusCode = 'A'
	Deleted            StatusCode = 'D'
	Renamed            StatusCode = 'R'
	Copied             StatusCode = 'C'
	UpdatedButUnmerged StatusCode = 'U'
)

type Submodule 

type Submodule struct {
	// contains filtered or unexported fields
}

Submodule a submodule allows you to keep another Git repository in a subdirectory of your repository.

func (*Submodule) Config 

func (s *Submodule) Config() *config.Submodule

Config returns the submodule config

func (*Submodule) Init 

func (s *Submodule) Init() error

Init initialize the submodule reading the recorded Entry in the index for the given submodule

func (*Submodule) Repository 

func (s *Submodule) Repository() (*Repository, error)

Repository returns the Repository represented by this submodule

func (*Submodule) Status 

func (s *Submodule) Status() (*SubmoduleStatus, error)

Status returns the status of the submodule.

func (*Submodule) Update 

func (s *Submodule) Update(o *SubmoduleUpdateOptions) error

Update the registered submodule to match what the superproject expects, the submodule should be initialized first calling the Init method or setting in the options SubmoduleUpdateOptions.Init equals true

func (*Submodule) UpdateContext 

func (s *Submodule) UpdateContext(ctx context.Context, o *SubmoduleUpdateOptions) error

UpdateContext the registered submodule to match what the superproject expects, the submodule should be initialized first calling the Init method or setting in the options SubmoduleUpdateOptions.Init equals true.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

type SubmoduleRescursivity 

type SubmoduleRescursivity uint

SubmoduleRescursivity defines how depth will affect any submodule recursive operation. 

const (
	// DefaultRemoteName name of the default Remote, just like git command.
	DefaultRemoteName = "origin"

	// NoRecurseSubmodules disables the recursion for a submodule operation.
	NoRecurseSubmodules SubmoduleRescursivity = 0
	// DefaultSubmoduleRecursionDepth allow recursion in a submodule operation.
	DefaultSubmoduleRecursionDepth SubmoduleRescursivity = 10
)

type SubmoduleStatus 

type SubmoduleStatus struct {
	Path     string
	Current  plumbing.Hash
	Expected plumbing.Hash
	Branch   plumbing.ReferenceName
}

SubmoduleStatus contains the status for a submodule in the worktree

func (*SubmoduleStatus) IsClean 

func (s *SubmoduleStatus) IsClean() bool

IsClean is the HEAD of the submodule is equals to the expected commit

func (*SubmoduleStatus) String 

func (s *SubmoduleStatus) String() string

String is equivalent to `git submodule status <submodule>`

This will print the SHA-1 of the currently checked out commit for a submodule, along with the submodule path and the output of git describe fo the SHA-1. Each SHA-1 will be prefixed with - if the submodule is not initialized, + if the currently checked out submodule commit does not match the SHA-1 found in the index of the containing repository.

type SubmoduleUpdateOptions 

type SubmoduleUpdateOptions struct {
	// Init, if true initializes the submodules recorded in the index.
	Init bool
	// NoFetch tell to the update command to not fetch new objects from the
	// remote site.
	NoFetch bool
	// RecurseSubmodules the update is performed not only in the submodules of
	// the current repository but also in any nested submodules inside those
	// submodules (and so on). Until the SubmoduleRescursivity is reached.
	RecurseSubmodules SubmoduleRescursivity
	// Auth credentials, if required, to use with the remote repository.
	Auth transport.AuthMethod
}

SubmoduleUpdateOptions describes how a submodule update should be performed.

type Submodules 

type Submodules []*Submodule

Submodules list of several submodules from the same repository.

func (Submodules) Init 

func (s Submodules) Init() error

Init initializes the submodules in this list.

func (Submodules) Status 

func (s Submodules) Status() (SubmodulesStatus, error)

Status returns the status of the submodules.

func (Submodules) Update 

func (s Submodules) Update(o *SubmoduleUpdateOptions) error

Update updates all the submodules in this list.

func (Submodules) UpdateContext 

func (s Submodules) UpdateContext(ctx context.Context, o *SubmoduleUpdateOptions) error

UpdateContext updates all the submodules in this list.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

type SubmodulesStatus 

type SubmodulesStatus []*SubmoduleStatus

SubmodulesStatus contains the status for all submodiles in the worktree

func (SubmodulesStatus) String 

func (s SubmodulesStatus) String() string

String is equivalent to `git submodule status`

type TagMode 

type TagMode int
const (
	InvalidTagMode TagMode = iota
	// TagFollowing any tag that points into the histories being fetched is also
	// fetched. TagFollowing requires a server with `include-tag` capability
	// in order to fetch the annotated tags objects.
	TagFollowing
	// AllTags fetch all tags from the remote (i.e., fetch remote tags
	// refs/tags/* into local tags with the same name)
	AllTags
	//NoTags fetch no tags from the remote at all
	NoTags
)

type Worktree 

type Worktree struct {
	// Filesystem underlying filesystem.
	Filesystem billy.Filesystem
	// contains filtered or unexported fields
}

Worktree represents a git worktree.

func (*Worktree) Add 

func (w *Worktree) Add(path string) (plumbing.Hash, error)

Add adds the file contents of a file in the worktree to the index. if the file is already staged in the index no error is returned. If a file deleted from the Workspace is given, the file is removed from the index. If a directory given, adds the files and all his sub-directories recursively in the worktree to the index. If any of the files is already staged in the index no error is returned. When path is a file, the blob.Hash is returned.

func (*Worktree) AddGlob 

func (w *Worktree) AddGlob(pattern string) error

AddGlob adds all paths, matching pattern, to the index. If pattern matches a directory path, all directory contents are added to the index recursively. No error is returned if all matching paths are already staged in index.

func (*Worktree) Checkout 

func (w *Worktree) Checkout(opts *CheckoutOptions) error

Checkout switch branches or restore working tree files.

func (*Worktree) Clean 

func (w *Worktree) Clean(opts *CleanOptions) error

Clean the worktree by removing untracked files.

func (*Worktree) Commit 

func (w *Worktree) Commit(msg string, opts *CommitOptions) (plumbing.Hash, error)

Commit stores the current contents of the index in a new commit along with a log message from the user describing the changes.

func (*Worktree) Grep 

func (w *Worktree) Grep(opts *GrepOptions) ([]GrepResult, error)

Grep performs grep on a worktree.

func (*Worktree) Move 

func (w *Worktree) Move(from, to string) (plumbing.Hash, error)

Move moves or rename a file in the worktree and the index, directories are not supported.

func (*Worktree) Pull 

func (w *Worktree) Pull(o *PullOptions) error

Pull incorporates changes from a remote repository into the current branch. Returns nil if the operation is successful, NoErrAlreadyUpToDate if there are no changes to be fetched, or an error.

Pull only supports merges where the can be resolved as a fast-forward.

func (*Worktree) PullContext 

func (w *Worktree) PullContext(ctx context.Context, o *PullOptions) error

PullContext incorporates changes from a remote repository into the current branch. Returns nil if the operation is successful, NoErrAlreadyUpToDate if there are no changes to be fetched, or an error.

Pull only supports merges where the can be resolved as a fast-forward.

The provided Context must be non-nil. If the context expires before the operation is complete, an error is returned. The context only affects to the transport operations.

func (*Worktree) Remove 

func (w *Worktree) Remove(path string) (plumbing.Hash, error)

Remove removes files from the working tree and from the index.

func (*Worktree) RemoveGlob 

func (w *Worktree) RemoveGlob(pattern string) error

RemoveGlob removes all paths, matching pattern, from the index. If pattern matches a directory path, all directory contents are removed from the index recursively.

func (*Worktree) Reset 

func (w *Worktree) Reset(opts *ResetOptions) error

Reset the worktree to a specified state.

func (*Worktree) Status 

func (w *Worktree) Status() (Status, error)

Status returns the working tree status.

func (*Worktree) Submodule 

func (w *Worktree) Submodule(name string) (*Submodule, error)

Submodule returns the submodule with the given name

func (*Worktree) Submodules 

func (w *Worktree) Submodules() (Submodules, error)

Submodules returns all the available submodules

Source Files

View all Source files

Directories

Path Synopsis
branch
checkout
clone
commit
context
custom_http
log
open
progress
pull
push
remotes
revision
showcase
tag
cli
go-git
client module
Package config contains the abstraction of multiple config files
 Package config contains the abstraction of multiple config files
file module
http module
internal module
revision
Package revision extracts git revision from string More informations about revision : https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html
 Package revision extracts git revision from string More informations about revision : https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html
common Module
package plumbing implement the core interfaces and structs used by go-git
 package plumbing implement the core interfaces and structs used by go-git
cache
filemode
format/config
Package config implements encoding and decoding of git config files.
 Package config implements encoding and decoding of git config files.
format/diff
format/gitignore
Package gitignore implements matching file system paths to gitignore patterns that can be automatically read from a git repository tree in the order of definition priorities.
 Package gitignore implements matching file system paths to gitignore patterns that can be automatically read from a git repository tree in the order of definition priorities.
format/idxfile
Package idxfile implements encoding and decoding of packfile idx files.
 Package idxfile implements encoding and decoding of packfile idx files.
format/index
Package index implements encoding and decoding of index format files.
 Package index implements encoding and decoding of index format files.
format/objfile
Package objfile implements encoding and decoding of object files.
 Package objfile implements encoding and decoding of object files.
format/packfile
Package packfile implements encoding and decoding of packfile format.
 Package packfile implements encoding and decoding of packfile format.
format/pktline
Package pktline implements reading payloads form pkt-lines and encoding pkt-lines from payloads.
 Package pktline implements reading payloads form pkt-lines and encoding pkt-lines from payloads.
object
Package object contains implementations of all Git objects and utility functions to work with them.
 Package object contains implementations of all Git objects and utility functions to work with them.
protocol/packp
protocol/packp/capability
Package capability defines the server and client capabilities.
 Package capability defines the server and client capabilities.
protocol/packp/sideband
Package sideband implements a sideband mutiplex/demultiplexer
 Package sideband implements a sideband mutiplex/demultiplexer
revlist
Package revlist provides support to access the ancestors of commits, in a similar way as the git-rev-list command.
 Package revlist provides support to access the ancestors of commits, in a similar way as the git-rev-list command.
storer
Package storer defines the interfaces to store objects, references, etc.
 Package storer defines the interfaces to store objects, references, etc.
transport
Package transport includes the implementation for different transport protocols.
 Package transport includes the implementation for different transport protocols.
transport/client
Package client contains helper function to deal with the different client protocols.
 Package client contains helper function to deal with the different client protocols.
transport/file
Package file implements the file transport protocol.
 Package file implements the file transport protocol.
transport/git
Package git implements the git transport protocol.
 Package git implements the git transport protocol.
transport/http
Package http implements the HTTP transport protocol.
 Package http implements the HTTP transport protocol.
transport/internal/common
Package common implements the git pack protocol with a pluggable transport.
 Package common implements the git pack protocol with a pluggable transport.
transport/server
Package server implements the git server protocol.
 Package server implements the git server protocol.
transport/ssh
Package ssh implements the SSH transport protocol.
 Package ssh implements the SSH transport protocol.
transport/test
Package test implements common test suite for different transport implementations.
 Package test implements common test suite for different transport implementations.
server module
filesystem
Package filesystem is a storage backend base on filesystems
 Package filesystem is a storage backend base on filesystems
filesystem/internal/dotgit
https://github.com/git/git/blob/master/Documentation/gitrepository-layout.txt
 https://github.com/git/git/blob/master/Documentation/gitrepository-layout.txt
memory
Package memory is a storage backend base on memory
 Package memory is a storage backend base on memory
test
utils
binary
Package binary implements sintax-sugar functions on top of the standard library binary package
 Package binary implements sintax-sugar functions on top of the standard library binary package
diff
Package diff implements line oriented diffs, similar to the ancient Unix diff command.
 Package diff implements line oriented diffs, similar to the ancient Unix diff command.
ioutil
Package ioutil implements some I/O utility functions.
 Package ioutil implements some I/O utility functions.
merkletrie
Package merkletrie provides support for n-ary trees that are at the same time Merkle trees and Radix trees (tries).
 Package merkletrie provides support for n-ary trees that are at the same time Merkle trees and Radix trees (tries).
merkletrie/filesystem
merkletrie/index
merkletrie/internal/frame
merkletrie/internal/fsnoder
Package fsnoder allows to create merkletrie noders that resemble file systems, from human readable string descriptions.
 Package fsnoder allows to create merkletrie noders that resemble file systems, from human readable string descriptions.
merkletrie/noder
Package noder provide an interface for defining nodes in a merkletrie, their hashes and their paths (a noders and its ancestors).
 Package noder provide an interface for defining nodes in a merkletrie, their hashes and their paths (a noders and its ancestors).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.