git

Documentation

Index

• type Commit
  • func (commit *Commit) FullCommitMessage() string
  • func (commit *Commit) Set(record []string)
• type CommitIterator
  • func GetCommitIterator() *CommitIterator
  • func GetLogs(from string, to string) *CommitIterator
  • func (ci *CommitIterator) Next() *Commit
  • func (ci *CommitIterator) PrintAll()
  • func (ci *CommitIterator) Push(commit Commit)
  • func (ci *CommitIterator) Reset()
  • func (ci *CommitIterator) Size() int
• type LogOptions

Types

type Commit

type Commit struct {
	CommitHash hash
	Author     user
	Subject    string
	Body       string
}

Commit structure (Check https://git-scm.com/docs/pretty-formats)

func (*Commit) FullCommitMessage

func (commit *Commit) FullCommitMessage() string

FullCommitMessage gets full commit message

func (*Commit) Set

func (commit *Commit) Set(record []string)

Set sets commit value from records

type CommitIterator

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

CommitIterator provides interator to run through available commits

func GetCommitIterator

func GetCommitIterator() *CommitIterator

GetCommitIterator gets a new log iterator

func GetLogs

func GetLogs(from string, to string) *CommitIterator

GetLogs gets logs

func (*CommitIterator) Next

func (ci *CommitIterator) Next() *Commit

Next returns item in the log iterator

func (*CommitIterator) PrintAll

func (ci *CommitIterator) PrintAll()

PrintAll prints all commit messages

func (*CommitIterator) Push

func (ci *CommitIterator) Push(commit Commit)

Push adds a new item to LogIterator

func (*CommitIterator) Reset

func (ci *CommitIterator) Reset()

Reset resets the iterator to point to beginning

func (*CommitIterator) Size

func (ci *CommitIterator) Size() int

Size returns the number of log items in the iterator

type LogOptions

type LogOptions struct {
	CommitID bool
	From     string
	To       string
}

LogOptions helps user to specify structure of log Message