github

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(user, token string) *Client
  • func (c *Client) CommentError(ctx context.Context, owner, repoName string, prNumber int, prOwner string, ...) error
  • func (c *Client) CommentOnPR(ctx context.Context, owner, repoName string, prNumber int, body string) error
  • func (c *Client) CreatePeacockCommitStatus(ctx context.Context, owner, repoName, ref string, state domain.State, ...) error
  • func (c *Client) DeleteUsersComments(ctx context.Context, owner, repoName string, prNumber int) error
  • func (c *Client) GetFileFromBranch(ctx context.Context, owner, repoName, branch, path string) ([]byte, error)
  • func (c *Client) GetLatestCommitSHAInBranch(ctx context.Context, owner, repoName, branch string) (string, error)
  • func (c *Client) GetPRComments(ctx context.Context, owner, repoName string, prNumber int) ([]*github.IssueComment, error)
  • func (c *Client) GetPRCommentsByUser(ctx context.Context, owner, repoName string, prNumber int) ([]*github.IssueComment, error)
  • func (c *Client) GetPullRequestBodyFromCommit(ctx context.Context, owner, repoName, sha string) (*string, error)
  • func (c *Client) GetPullRequestBodyFromPRNumber(ctx context.Context, owner, repoName string, prNumber int) (*string, error)
  • func (c *Client) HandleError(ctx context.Context, statusContext, owner, repoName string, prNumber int, ...) error

Constants

const (
	ValidationContext = "peacock-validation"
	ReleaseContext    = "peacock-release"
)

Variables

var (
	RepoStatus = map[string]*github.RepoStatus{
		ValidationContext: {
			State:       nil,
			Description: utils.NewPtr("Validates the PR body against the feathers"),
			Context:     utils.NewPtr(ValidationContext),
		},
		ReleaseContext: {
			State:       nil,
			Description: utils.NewPtr("Sends the messages to the Teams outlined in the PR body"),
			Context:     utils.NewPtr(ReleaseContext),
		},
	}
)

RepoStatus Base repository statuses to use for creating a commit status

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(user, token string) *Client

func (*Client) CommentError

func (c *Client) CommentError(ctx context.Context, owner, repoName string, prNumber int, prOwner string, err error) error

func (*Client) CommentOnPR

func (c *Client) CommentOnPR(ctx context.Context, owner, repoName string, prNumber int, body string) error

func (*Client) CreatePeacockCommitStatus

func (c *Client) CreatePeacockCommitStatus(ctx context.Context, owner, repoName, ref string, state domain.State, statusContext string) error

func (*Client) DeleteUsersComments

func (c *Client) DeleteUsersComments(ctx context.Context, owner, repoName string, prNumber int) error

func (*Client) GetFileFromBranch

func (c *Client) GetFileFromBranch(ctx context.Context, owner, repoName, branch, path string) ([]byte, error)

func (*Client) GetLatestCommitSHAInBranch

func (c *Client) GetLatestCommitSHAInBranch(ctx context.Context, owner, repoName, branch string) (string, error)

func (*Client) GetPRComments

func (c *Client) GetPRComments(ctx context.Context, owner, repoName string, prNumber int) ([]*github.IssueComment, error)

func (*Client) GetPRCommentsByUser

func (c *Client) GetPRCommentsByUser(ctx context.Context, owner, repoName string, prNumber int) ([]*github.IssueComment, error)

func (*Client) GetPullRequestBodyFromCommit

func (c *Client) GetPullRequestBodyFromCommit(ctx context.Context, owner, repoName, sha string) (*string, error)

func (*Client) GetPullRequestBodyFromPRNumber

func (c *Client) GetPullRequestBodyFromPRNumber(ctx context.Context, owner, repoName string, prNumber int) (*string, error)

func (*Client) HandleError

func (c *Client) HandleError(ctx context.Context, statusContext, owner, repoName string, prNumber int, headSHA, prOwner string, err error) error