git

Documentation

Index

• func CommitsBetween(repoPath string, cfg Range) ([]string, error)
• func FirstCommit(repoPath string) (string, error)
• func HeadCommit(repoPath string) (string, error)
• func HeadTag(repoPath string) (string, error)
• func HeadTagOrCommit(repoPath string) (string, error)
• func IsRepository(path string) bool
• func RemoteURL(p string) (string, error)
• type Interface
  • func New(repoPath string) (Interface, error)
• type MockInterface
  • func (m MockInterface) CommitsBetween(_ Range) ([]string, error)
  • func (m MockInterface) FirstCommit() (string, error)
  • func (m MockInterface) HeadTag() (string, error)
  • func (m MockInterface) HeadTagOrCommit() (string, error)
  • func (m MockInterface) RemoteURL() (string, error)
  • func (m MockInterface) SearchForTag(_ string) (*Tag, error)
  • func (m MockInterface) TagsFromLocal() ([]Tag, error)
• type Range
• type Reference
• type Tag
  • func SearchForTag(repoPath, tagRef string) (*Tag, error)
  • func TagsFromLocal(repoPath string) ([]Tag, error)

Functions

func CommitsBetween

func CommitsBetween(repoPath string, cfg Range) ([]string, error)

func FirstCommit

func FirstCommit(repoPath string) (string, error)

func HeadCommit

func HeadCommit(repoPath string) (string, error)

func HeadTag

func HeadTag(repoPath string) (string, error)

func HeadTagOrCommit

func HeadTagOrCommit(repoPath string) (string, error)

func IsRepository

func IsRepository(path string) bool

func RemoteURL

func RemoteURL(p string) (string, error)

TODO: can't use r.Config for same validation reasons

Types

type Interface

type Interface interface {
	FirstCommit() (string, error)
	HeadTagOrCommit() (string, error)
	HeadTag() (string, error)
	RemoteURL() (string, error)
	SearchForTag(tagRef string) (*Tag, error)
	TagsFromLocal() ([]Tag, error)
	CommitsBetween(Range) ([]string, error)
}

func New

func New(repoPath string) (Interface, error)

type MockInterface

type MockInterface struct {
	MockHeadOrTagCommit string
	MockHeadTag         string
	MockTags            []string
	MockRemoteURL       string
	MockSearchTag       string
	MockCommitsBetween  []string
	MockFirstCommit     string
}

func (MockInterface) CommitsBetween

func (m MockInterface) CommitsBetween(_ Range) ([]string, error)

func (MockInterface) FirstCommit

func (m MockInterface) FirstCommit() (string, error)

func (MockInterface) HeadTag

func (m MockInterface) HeadTag() (string, error)

func (MockInterface) HeadTagOrCommit

func (m MockInterface) HeadTagOrCommit() (string, error)

func (MockInterface) RemoteURL

func (m MockInterface) RemoteURL() (string, error)

func (MockInterface) SearchForTag

func (m MockInterface) SearchForTag(_ string) (*Tag, error)

func (MockInterface) TagsFromLocal

func (m MockInterface) TagsFromLocal() ([]Tag, error)

type Range

type Range struct {
	SinceRef     string
	UntilRef     string
	IncludeStart bool
	IncludeEnd   bool
}

type Reference

type Reference struct {
	Commit string
	Tags   []string
}

type Tag

type Tag struct {
	Name      string
	Timestamp time.Time
	Commit    string
	Annotated bool
}

func SearchForTag

func SearchForTag(repoPath, tagRef string) (*Tag, error)

func TagsFromLocal

func TagsFromLocal(repoPath string) ([]Tag, error)