github

Documentation

Index

• func ActionRequiredCheckRun(installationID, repositoryNodeID, headSHA, name, text string)
• func CompletedCheckRun(installationID, repositoryNodeID, runID string, ...) error
• func CreateCheckRun(installationID, repositoryNodeID, headSHA, name string) (string, error)
• func InProgressCheckRun(installationID, repositoryNodeID, runID string) error
• func QueuedCheckRun(installationID, repositoryNodeID, runID, buildID, logURL string) error
• type CheckConclusionState
• type CheckRun
• type GraphqlData
• type GraphqlError
• type GraphqlRes
• type PullRequest
  • func GetAssociatedPullRequests(installationID, repoFullName, headBranch string) ([]PullRequest, error)
  • func GetPullRequests(installationID, repoFullName string) ([]PullRequest, error)

Functions

func ActionRequiredCheckRun

func ActionRequiredCheckRun(installationID, repositoryNodeID, headSHA, name, text string)

ActionRequiredCheckRun create ACTION_REQUIRED CheckRun for invalid build

func CompletedCheckRun

func CompletedCheckRun(installationID, repositoryNodeID, runID string, conclusion CheckConclusionState, completedAt, summary, text string) error

CompletedCheckRun update CheckRun status to COMPLETED

func CreateCheckRun

func CreateCheckRun(installationID, repositoryNodeID, headSHA, name string) (string, error)

CreateCheckRun create CheckRun for build, return CheckRun ID

func InProgressCheckRun

func InProgressCheckRun(installationID, repositoryNodeID, runID string) error

InProgressCheckRun update CheckRun status to IN_PROGESS

func QueuedCheckRun

func QueuedCheckRun(installationID, repositoryNodeID, runID, buildID, logURL string) error

QueuedCheckRun update CheckRun status to QUEUED

Types

type CheckConclusionState

type CheckConclusionState string

CheckConclusionState CheckConclusionState

const (
	// CheckCancelled CheckConclusionState CANCELLED
	CheckCancelled CheckConclusionState = "CANCELLED"
	// CheckFailure CheckConclusionState FAILURE
	CheckFailure CheckConclusionState = "FAILURE"
	// CheckSuccess CheckConclusionState SUCCESS
	CheckSuccess CheckConclusionState = "SUCCESS"
	// CheckTimeout CheckConclusionState TIMED_OUT
	CheckTimeout CheckConclusionState = "TIMED_OUT"
)

type CheckRun

type CheckRun struct {
	ID string `json:"id"`
}

CheckRun Github CheckRun

type GraphqlData

type GraphqlData struct {
	Repository struct {
		Ref struct {
			AssociatedPullRequests struct {
				Nodes []PullRequest `json:"nodes"`
			} `json:"associatedPullRequests"`
		} `json:"ref"`

		PullRequests struct {
			Nodes []PullRequest `json:"nodes"`
		} `json:"pullRequests"`
	} `json:"repository"`

	CreateCheckRun struct {
		ClientMutationID string   `json:"clientMutationId"`
		CheckRun         CheckRun `json:"checkRun"`
	} `json:"createCheckRun"`

	UpdateCheckRun struct {
		ClientMutationID string   `json:"clientMutationId"`
		CheckRun         CheckRun `json:"checkRun"`
	} `json:"updateCheckRun"`
}

GraphqlData graphql data

type GraphqlError

type GraphqlError struct {
	Message string `json:"message"`
}

GraphqlError graphql error

type GraphqlRes

type GraphqlRes struct {
	Data   GraphqlData    `json:"data"`
	Errors []GraphqlError `json:"errors"`
}

GraphqlRes graphql response

type PullRequest

type PullRequest struct {
	ID          string `json:"id"`
	Number      int    `json:"number"`
	BaseRefName string `json:"baseRefName"`
}

PullRequest pull request

func GetAssociatedPullRequests

func GetAssociatedPullRequests(installationID, repoFullName, headBranch string) ([]PullRequest, error)

GetAssociatedPullRequests get associated pull request list

func GetPullRequests

func GetPullRequests(installationID, repoFullName string) ([]PullRequest, error)

GetPullRequests get pull request list