commenter

Documentation

Index

• Constants
• Variables
• type AbuseRateLimitError
  • func (e AbuseRateLimitError) Error() string
• type CommentAlreadyWrittenError
  • func (e CommentAlreadyWrittenError) Error() string
• type CommentNotValidError
  • func (e CommentNotValidError) Error() string
• type Commenter
  • func NewCommenter(token, owner, repo string, prNumber int) (*Commenter, error)
  • func (c *Commenter) CreateDraftPRReviewComments(comments []PRReviewComment) []*github.DraftReviewComment
  • func (c *Commenter) WritePRReview(comments []*github.DraftReviewComment, event string) error
• type CommitFileInfo
• type PRDoesNotExistError
  • func (e PRDoesNotExistError) Error() string
• type PRReviewComment

Constants

const (
	Approve        = "APPROVE"
	RequestChanges = "REQUEST_CHANGES"
)

const (
	CommenterName = "github-actions[bot]"
)

Variables

var (
	ApproveBody        = "Approve:tada:"
	RequestChangesBody = "Request changes:rotating_light:"
)

Types

type AbuseRateLimitError

type AbuseRateLimitError struct {
	BackoffInSeconds int
	// contains filtered or unexported fields
}

AbuseRateLimitError return when the GitHub abuse rate limit is hit

func (AbuseRateLimitError) Error

func (e AbuseRateLimitError) Error() string

type CommentAlreadyWrittenError

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

CommentAlreadyWrittenError returned when the error can't be written as it already exists

func (CommentAlreadyWrittenError) Error

func (e CommentAlreadyWrittenError) Error() string

type CommentNotValidError

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

CommentNotValidError returned when the comment is for a file or line not in the pr

func (CommentNotValidError) Error

func (e CommentNotValidError) Error() string

type Commenter

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

Commenter is the main commenter struct

func NewCommenter

func NewCommenter(token, owner, repo string, prNumber int) (*Commenter, error)

NewCommenter creates a Commenter for updating PR with comments

func (*Commenter) CreateDraftPRReviewComments

func (c *Commenter) CreateDraftPRReviewComments(comments []PRReviewComment) []*github.DraftReviewComment

func (*Commenter) WritePRReview

func (c *Commenter) WritePRReview(comments []*github.DraftReviewComment, event string) error

type CommitFileInfo

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

type PRDoesNotExistError

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

PRDoesNotExistError returned when the PR can't be found, either as 401 or not existing

func (PRDoesNotExistError) Error

func (e PRDoesNotExistError) Error() string

type PRReviewComment

type PRReviewComment struct {
	FileName  string
	StartLine int
	EndLine   int
	Body      string
}