commits

Documentation

Index

• type Author
• type Commit
• type CommitWithoutComments
  • func New(rawJSON []byte) ([]CommitWithoutComments, error)

Types

type Author

type Author interface {
	GitHubID() string
	Email() string
	Name() string
	String() string
}

An Author contains information relating to a commit as seen on GitHub

type Commit

type Commit interface {
	CommitWithoutComments
	Comments() []comments.Comment
}

A Commit represents basic information about a commit including comments

type CommitWithoutComments

type CommitWithoutComments interface {
	Author() Author
	Date() time.Time
	SHA() string
	ParentSHAs() []string
	CommentsURL() string
	String() string
}

A CommitWithoutComments provides basic information relating to a commit

func New

func New(rawJSON []byte) ([]CommitWithoutComments, error)

New returns a list of CommitWithoutComments from raw JSON