git

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2026 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CommitsOptions 

type CommitsOptions struct {
	// Limit is maximum number of commits to retrieve.
	// 0 means no limit.
	Limit uint32

	Before plumbing.Hash
	After  plumbing.Hash
}

type CommitsPageMeta 

type CommitsPageMeta struct {
	HasNextPage bool
	HasPrevPage bool
}

type GitRepo 

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

func Open 

func Open(path string, ref string) (*GitRepo, error)

func (*GitRepo) Branches 

func (g *GitRepo) Branches() ([]*plumbing.Reference, error)

func (*GitRepo) Commits 

func (g *GitRepo) Commits(opts CommitsOptions) ([]*object.Commit, CommitsPageMeta, error)

func (*GitRepo) Diff 

func (g *GitRepo) Diff() (*NiceDiff, error)

func (*GitRepo) File 

func (g *GitRepo) File(path string) (*object.File, error)

func (*GitRepo) FileTree 

func (g *GitRepo) FileTree(path string) ([]NiceTree, error)

func (*GitRepo) FindMainBranch 

func (g *GitRepo) FindMainBranch(branches []string) (string, error)

func (*GitRepo) Head 

func (g *GitRepo) Head() plumbing.Hash

Head returns hash of the tip. This is same to the hash of a commit object returned by LastCommit() method.

func (*GitRepo) LastCommit 

func (g *GitRepo) LastCommit() (*object.Commit, error)

func (*GitRepo) Tags 

func (g *GitRepo) Tags() ([]*TagReference, error)

func (*GitRepo) WriteTar 

func (g *GitRepo) WriteTar(w io.Writer, prefix string) error

WriteTar writes itself from a tree into a binary tar file format. prefix is root folder to be appended.

type NiceDiff 

type NiceDiff struct {
	Commit *object.Commit
	Parent *object.Commit
	Stat   struct {
		FilesChanged int
		Insertions   int
		Deletions    int
	}
	Files []*gitdiff.File
}

A nicer git diff representation.

type NiceTree 

type NiceTree struct {
	Name      string
	Mode      string
	Size      int64
	IsFile    bool
	IsSubtree bool
}

A nicer git tree representation.

type TagList 

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

func (*TagList) Len 

func (self *TagList) Len() int

func (*TagList) Less 

func (self *TagList) Less(i, j int) bool

sorting tags in reverse chronological order

func (*TagList) Swap 

func (self *TagList) Swap(i, j int)

type TagReference 

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

TagReference is used to list both tag and non-annotated tags. Non-annotated tags should only contains a reference. Annotated tags should contain its reference and its tag information.

func (*TagReference) Message 

func (t *TagReference) Message() string

func (*TagReference) Name 

func (t *TagReference) Name() string

Source Files

View all Source files

Directories

Path Synopsis

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.