commenter

package

v0.1.3 Latest Latest Go to latest Published: Nov 8, 2023 License: MIT Imports: 9 Imported by: 2

Details

This section is empty.

This section is empty.

This section is empty.

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

AbuseRateLimitError return when the GitHub abuse rate limit is hit

func (e AbuseRateLimitError) Error() string

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

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

func (e CommentAlreadyWrittenError) Error() string

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

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

func (e CommentNotValidError) Error() string

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

Commenter is the main commenter struct

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

NewCommenter creates a Commenter for updating PR with comments

func NewEnterpriseCommenter(token, baseUrl, uploadUrl, owner, repo string, prNumber int) (*Commenter, error)

NewEnterpriseCommenter creates a Commenter for updating PR with comments in an Enterprise Github Server

func (c *Commenter) WriteGeneralComment(comment string) error

func (c *Commenter) WriteLineComment(file, comment string, line int) error

WriteLineComment writes a single review line on a file of the github PR

func (c *Commenter) WriteMultiLineComment(file, comment string, startLine, endLine int) error

WriteMultiLineComment writes a multiline review on a file in the github PR

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

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

func (e PrDoesNotExistError) Error() string