github

package

v0.18.2 Latest Latest Go to latest Published: May 29, 2026 License: Apache-2.0 Imports: 14 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aquasecurity/go-git-pr-commenter

Links

Open Source Insights

Documentation ¶

Index ¶

func EmbedFingerprint(body, fp string) string
func ExtractFingerprint(body string) string
type AbuseRateLimitError
- func (e AbuseRateLimitError) Error() string
type CommentAlreadyWrittenError
- func (e CommentAlreadyWrittenError) Error() string
type CommentNotValidError
- func (e CommentNotValidError) Error() string
type Github
- func NewGithub(token, owner, repo string, prNumber int) (gh *Github, err error)
- func NewGithubServer(apiUrl, token, owner, repo string, prNumber int) (gh *Github, err error)
type PrDoesNotExistError
- func (e PrDoesNotExistError) Error() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func EmbedFingerprint ¶ added in v0.16.0

func EmbedFingerprint(body, fp string) string

func ExtractFingerprint ¶ added in v0.16.0

func ExtractFingerprint(body string) string

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 Github ¶

type Github struct {
	Token    string
	Owner    string
	Repo     string
	PrNumber int

	// GraphQLEndpoint is overridable for tests / future GHE support.
	GraphQLEndpoint string
	// contains filtered or unexported fields
}

func NewGithub ¶

func NewGithub(token, owner, repo string, prNumber int) (gh *Github, err error)

func NewGithubServer ¶ added in v0.8.2

func NewGithubServer(apiUrl, token, owner, repo string, prNumber int) (gh *Github, err error)

func (*Github) ReconcileAquaComments ¶ added in v0.16.0

func (c *Github) ReconcileAquaComments(marker string, current []commenter.Finding) error

func (*Github) RemovePreviousAquaComments ¶ added in v0.5.0

func (c *Github) RemovePreviousAquaComments(msg string) error

func (*Github) WriteLineComment ¶

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

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

func (*Github) WriteMultiLineComment ¶

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

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

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL