githubdomain

Documentation

Index

• type CommitUser
• type DetailedCommitInfo
• type GetCommitInfo
• type GetSinglePullRequestResponse
• type GitUser
• type GithubError
• type GithubErrorResponse
  • func (r GithubErrorResponse) Error() string
• type Parent
• type RepoBase

Types

type CommitUser

type CommitUser struct {
	Name  string    `json:"name"`
	Email string    `json:"email"`
	Date  time.Time `json:"date"`
}

CommitUser has info about the user doing the commit

type DetailedCommitInfo

type DetailedCommitInfo struct {
	URL       string     `json:"url"`
	Author    CommitUser `json:"author"`
	Committer CommitUser `json:"committer"`
	Message   string     `json:"message"`
}

DetailedCommitInfo has more detailed info about the commit

type GetCommitInfo

type GetCommitInfo struct {
	URL           string                        `json:"url"`
	SHA           string                        `json:"sha"`
	Commit        DetailedCommitInfo            `json:"commit"`
	Author        GitUser                       `json:"author"`
	Committer     GitUser                       `json:"committer"`
	Parents       []Parent                      `json:"parents"`
	IsMergeCommit bool                          `json:"ismergecommit"` //not set by github, calculated later in code
	PRForMerge    *GetSinglePullRequestResponse `json:"pull"`          //not set by github
}

GetCommitInfo returns information about a commit

type GetSinglePullRequestResponse

type GetSinglePullRequestResponse struct {
	URL               string    `json:"url"`
	ID                int64     `json:"id"`
	Number            int64     `json:"number"`
	State             string    `json:"state"`
	Title             string    `json:"title"`
	CreatedAt         time.Time `json:"created_at"`
	UpdatedAt         time.Time `json:"updated_at"`
	ClosedAt          time.Time `json:"closed_at"`
	MergedAt          time.Time `json:"merged_at"`
	MergeCommitSHA    string    `json:"merge_commit_sha"`
	User              GitUser   `json:"user"`
	Assignee          GitUser   `json:"assignee"`
	Base              RepoBase  `json:"base"`
	AuthorAssociation string    `json:"author_association"`
	Draft             bool      `json:"draft"`
	Merged            bool      `json:"merged"`
	MergeableState    string    `json:"mergeable_state"`
	MergedBy          GitUser   `json:"merged_by"`
	Commits           int64     `json:"commits"`
}

GetSinglePullRequestResponse stores information about a single PR

type GitUser

type GitUser struct {
	Login     string `json:"login"`
	ID        int64  `json:"id"`
	Type      string `json:"type"`
	SiteAdmin bool   `json:"site_admin"`
}

GitUser stores info about a user Is referenced in both Pull Requests and Commits

type GithubError

type GithubError struct {
	Resource string `json:"resource"`
	Code     string `json:"code"`
	Field    string `json:"field"`
	Message  string `json:"message"`
}

GithubError holds details about a single error from Github

type GithubErrorResponse

type GithubErrorResponse struct {
	StatusCode       int           `json:"status_code"`
	Message          string        `json:"message"`
	DocumentationURL string        `json:"documentation_url"`
	Errors           []GithubError `json:"errors"`
}

GithubErrorResponse holds details about the errors received back from Github

func (GithubErrorResponse) Error

func (r GithubErrorResponse) Error() string

type Parent

type Parent struct {
	URL string `json:"url"`
	SHA string `json:"sha"`
}

Parent has information about the parent of the commit

type RepoBase

type RepoBase struct {
	Label string `json:"label"`
	Ref   string `json:"ref"`
	SHA   string `json:"sha"`
}

RepoBase stores info about the base of the repo