github

Documentation

Index

• Constants
• func GetTaskLink(baseURI, productName, pipelineName, displayName string, ...) string
• func UIType(pipelineType config.PipelineType) string
• type CIStatus
• type Client
  • func GetGithubAppClientByOwner(appID int, appKey, owner, proxy string) (*Client, error)
  • func NewClient(accessToken, proxyAddress string) *Client
  • func (c *Client) CompleteGitCheck(gitCheckID int64, status CIStatus, check *GitCheck) error
  • func (c *Client) StartGitCheck(check *GitCheck) (int64, error)
  • func (c *Client) UpdateCheckStatus(opt *StatusOptions) error
  • func (c *Client) UpdateGitCheck(gitCheckID int64, check *GitCheck) error
• type GitCheck
  • func (gc *GitCheck) DetailsURL() string
• type StatusOptions

Constants

const (
	StatusQueued     = "queued"
	StatusInProgress = "in_progress"
	StatusCompleted  = "completed"
)

const (
	StateError   = "error"
	StateFailure = "failure"
	StatePending = "pending"
	StateSuccess = "success"
)

Functions

func GetTaskLink

func GetTaskLink(baseURI, productName, pipelineName, displayName string, pipelineType config.PipelineType, taskID int64) string

func UIType

func UIType(pipelineType config.PipelineType) string

Types

type CIStatus

type CIStatus string

const (
	CIStatusSuccess   CIStatus = "success"
	CIStatusFailure   CIStatus = "failure"
	CIStatusNeutral   CIStatus = "neutral"
	CIStatusCancelled CIStatus = "cancelled"
	CIStatusTimeout   CIStatus = "timed_out"
	CIStatusError     CIStatus = "error"
)

type Client

type Client struct {
	*github.Client
}

func GetGithubAppClientByOwner

func GetGithubAppClientByOwner(appID int, appKey, owner, proxy string) (*Client, error)

func NewClient

func NewClient(accessToken, proxyAddress string) *Client

func (*Client) CompleteGitCheck

func (c *Client) CompleteGitCheck(gitCheckID int64, status CIStatus, check *GitCheck) error

https://developer.github.com/v3/checks/runs/#update-a-check-run

func (*Client) StartGitCheck

func (c *Client) StartGitCheck(check *GitCheck) (int64, error)

https://developer.github.com/v3/checks/runs/#create-a-check-run

func (*Client) UpdateCheckStatus

func (c *Client) UpdateCheckStatus(opt *StatusOptions) error

func (*Client) UpdateGitCheck

func (c *Client) UpdateGitCheck(gitCheckID int64, check *GitCheck) error

https://developer.github.com/v3/checks/runs/#update-a-check-run

type GitCheck

type GitCheck struct {
	Owner  string
	Repo   string
	Branch string // The name of the branch to perform a check against. (Required.)
	Ref    string // The SHA of the commit. (Required.)
	IsPr   bool

	AslanURL    string
	PipeName    string
	DisplayName string
	ProductName string
	PipeType    config.PipelineType
	TaskID      int64
	TestReports []*types.TestSuite
}

func (*GitCheck) DetailsURL

func (gc *GitCheck) DetailsURL() string

DetailsURL ...

type StatusOptions

type StatusOptions struct {
	Owner       string
	Repo        string
	Ref         string
	State       string
	Description string

	AslanURL    string
	PipeName    string
	DisplayName string
	ProductName string
	PipeType    config.PipelineType
	TaskID      int64
}