github

type Author ¶ added in v1.1.7

type Author struct {
	Name githubv4.String
}

Author represents the information about the commit author

type CheckSuite ¶ added in v1.1.0

type CheckSuite struct {
	Conclusion githubv4.String
}

CheckSuite represents the information about the check suite obtained from Github

type CheckSuiteNode ¶ added in v1.1.0

type CheckSuiteNode struct {
	WorkflowRun WorkflowRun
}

CheckSuiteNode represents the information about the check suite information of the Node.

It deliberately does not select the nested checkRuns connection. Check runs are read from statusCheckRollup.contexts instead: nesting checkRuns under checkSuites multiplied the query's node count by suites × runs for every commit, and made whether a run was visible at all depend on where its suite happened to sort. This selection is only needed for a required name that is the name of a *workflow* rather than of an individual run.

type CheckSuites ¶ added in v1.1.0

type CheckSuites struct {
	TotalCount githubv4.Int
	PageInfo   PageInfo
	Nodes      []CheckSuiteNode
}

CheckSuites represents the information about the check suite of a slice of Nodes

type Commit ¶

type Commit struct {
	SHA           string
	Message       string
	Parents       []Commit
	StatusSuccess bool
	// ChecksSummary explains, one line per required check name, why
	// StatusSuccess came out the way it did. Empty when no specific check names
	// were requested and the GitHub status rollup was used instead.
	ChecksSummary       []string
	AuthoredDate        time.Time
	AuthorName          string
	SpecificCheckPassed bool
	// contains filtered or unexported fields
}

Commit represents a specific GitHub commit

func PickFirstParentCommits(fullCommitsList []Commit) []Commit

func (c *Commit) ChecksTruncated() bool

type CommitContextsQuery ¶ added in v1.1.11

type CommitContextsQuery struct {
	Repository struct {
		Object struct {
			Commit struct {
				StatusCheckRollup struct {
					Contexts StatusCheckRollupContexts `graphql:"contexts(first: $contextsNumber, after: $contextsAfter)"`
				}
			} `graphql:"... on Commit"`
		} `graphql:"object(oid: $oid)"`
	} `graphql:"repository(owner: $owner, name: $name)"`
}

CommitContextsQuery fetches one further page of a single commit's status-check rollup contexts.

type CommitSuitesQuery ¶ added in v1.1.11

type CommitSuitesQuery struct {
	Repository struct {
		Object struct {
			Commit struct {
				CheckSuites CheckSuites `graphql:"checkSuites(first: $checkSuitesNumber, after: $suitesAfter)"`
			} `graphql:"... on Commit"`
		} `graphql:"object(oid: $oid)"`
	} `graphql:"repository(owner: $owner, name: $name)"`
}

CommitSuitesQuery fetches one further page of a single commit's check suites.

type Context ¶ added in v1.1.0

type Context struct {
	Context githubv4.String
	State   githubv4.String
}

Context represents the information about the Context

type Edge ¶ added in v1.1.0

type Edge struct {
	Node EdgeRootNode
}

Edge represents the information about a edge element

type EdgeNode ¶ added in v1.1.0

type EdgeNode struct {
	Oid     githubv4.String
	Message githubv4.String
}

EdgeNode represents the information about an edge node

type EdgeParent ¶ added in v1.1.0

type EdgeParent struct {
	Node EdgeNode
}

EdgeParent represents the information about a parent node

type EdgeRootNode ¶ added in v1.1.0

type EdgeRootNode struct {
	Parents           ParentsEdge `graphql:"parents(first: $parentsNumber)"`
	Oid               githubv4.String
	Message           githubv4.String
	AuthoredDate      githubv4.DateTime
	Author            Author
	StatusCheckRollup StatusCheckRollup
	CheckSuites       CheckSuites `graphql:"checkSuites(first: $checkSuitesNumber)"`
	Status            NodeStatus
}

EdgeRootNode represents the information about a edge root node

type Error ¶

type Error struct {
	Message       string
	PreviousError error
}

Error represents a specific error in commit check

func (e Error) Error() string

type History ¶ added in v1.1.0

type History struct {
	Edges []Edge
}

History represents the information about a slice of Edges

type Manager ¶ added in v1.1.0

type Manager struct {
	Context    context.Context
	Client     *githubv4.Client
	HTTPClient *http.Client
}

Manager represents the information necessary in Github to manage the repository

func New(githubAccessToken string) *Manager

func (gm *Manager) ChangeBranchHead(owner, repo, branch, sha string, force bool) error

func (gm *Manager) GetCommits(owner, repo, branch string, lastCommitsNumber int, specificChecksNames string, sep string, acceptSkippedChecks bool, contextsNumber, checkSuitesNumber int) ([]Commit, error)

func (gm *Manager) TopUpChecks(owner, repo string, c *Commit) error

type NodeStatus ¶ added in v1.1.0

type NodeStatus struct {
	Contexts []Context
}

NodeStatus represents the information about a slice of Contexts.

Commit.status.contexts is a plain list rather than a connection, so this is always the complete set of classic commit statuses — there is nothing to paginate.

type PageInfo ¶ added in v1.1.11

type PageInfo struct {
	HasNextPage githubv4.Boolean
	EndCursor   githubv4.String
}

PageInfo carries a connection's cursor so the pages that did not fit can be fetched on demand.

type ParentsEdge ¶ added in v1.1.0

type ParentsEdge struct {
	Edges []EdgeParent
}

ParentsEdge represents the information about the parents edge

type Query ¶ added in v1.1.0

type Query struct {
	Repository Repository `graphql:"repository(owner: $owner, name: $name)"`
}

Query represents the information obtained in a Github Query

type Ref ¶ added in v1.1.0

type Ref struct {
	Target Target
}

Ref represents the information about a ref element

type Repository ¶ added in v1.1.0

type Repository struct {
	Ref Ref `graphql:"ref(qualifiedName: $branch)"`
}

Repository represents the information obtained about a repository in a Github Query

type RollupCheckRun ¶ added in v1.1.11

type RollupCheckRun struct {
	Name       githubv4.String
	Status     githubv4.String
	Conclusion githubv4.String
}

RollupCheckRun is the CheckRun member of the statusCheckRollup contexts union.

type RollupContext ¶ added in v1.1.11

type RollupContext struct {
	Typename      githubv4.String     `graphql:"__typename"`
	StatusContext RollupStatusContext `graphql:"... on StatusContext"`
	CheckRun      RollupCheckRun      `graphql:"... on CheckRun"`
}

RollupContext is one entry of statusCheckRollup.contexts, a union of StatusContext and CheckRun. Typename says which member is populated.

type RollupStatusContext ¶ added in v1.1.11

type RollupStatusContext struct {
	Context githubv4.String
	State   githubv4.String
}

RollupStatusContext is the StatusContext member of the statusCheckRollup contexts union: a classic commit status, as reported through the rollup.

type StatusCheckRollup ¶ added in v1.1.0

type StatusCheckRollup struct {
	State    githubv4.String
	Contexts StatusCheckRollupContexts `graphql:"contexts(first: $contextsNumber)"`
}

StatusCheckRollup represents the information about the status check of rollup

type StatusCheckRollupContexts ¶ added in v1.1.0

type StatusCheckRollupContexts struct {
	TotalCount githubv4.Int
	PageInfo   PageInfo
	Nodes      []RollupContext
}

StatusCheckRollupContexts represents the information about the status check of rollup contexts.

This is where check runs are read from. GitHub returns the latest run per check name here, so re-runs of the same check arrive as one entry rather than one per attempt, and the list is flat rather than grouped by suite.

type Target ¶ added in v1.1.0

type Target struct {
	Commit TargetCommit `graphql:"... on Commit"`
}

Target represents the target of a specific commit

type TargetCommit ¶ added in v1.1.0

type TargetCommit struct {
	History History `graphql:"history(first: $commitsNumber)"`
}

TargetCommit represents the information about a commit history

type Workflow ¶ added in v1.1.0

type Workflow struct {
	Name githubv4.String
}

Workflow represents the information of the Github Workflow

type WorkflowRun ¶ added in v1.1.0

type WorkflowRun struct {
	Workflow   Workflow
	CheckSuite CheckSuite
}

WorkflowRun represents the information about the workflow run execution