githubutils

Documentation

Index

• Constants
• func BasicLocationFormat(d *rdf.Diagnostic) string
• func LinkedMarkdownDiagnostic(owner, repo, sha string, d *rdf.Diagnostic) string
• func PathLink(owner, repo, sha, path string, line int) (string, error)
• func ReportAsGitHubActionsLog(toolName, defaultLevel string, d *rdf.Diagnostic)
• func WarnTooManyAnnotationOnce()
• type GitHubActionLogWriter
  • func NewGitHubActionLogWriter(level string) *GitHubActionLogWriter
  • func (lw *GitHubActionLogWriter) Flush(_ context.Context) error
  • func (lw *GitHubActionLogWriter) Post(_ context.Context, c *reviewdog.Comment) error

Constants

const MaxLoggingAnnotationsPerStep = 10

Functions

func BasicLocationFormat

func BasicLocationFormat(d *rdf.Diagnostic) string

BasicLocationFormat format a diagnostic to %f|%l col %c| errorformat.

func LinkedMarkdownDiagnostic

func LinkedMarkdownDiagnostic(owner, repo, sha string, d *rdf.Diagnostic) string

LinkedMarkdownDiagnostic returns Markdown string which contains a link to the location in the diagnostic and the diagnostic content itself.

func PathLink

func PathLink(owner, repo, sha, path string, line int) (string, error)

PathLink build a link to GitHub path to given sha, file, and line.

func ReportAsGitHubActionsLog

func ReportAsGitHubActionsLog(toolName, defaultLevel string, d *rdf.Diagnostic)

ReportAsGitHubActionsLog reports results via logging command to create annotations. https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#example-5

func WarnTooManyAnnotationOnce

func WarnTooManyAnnotationOnce()

Types

type GitHubActionLogWriter

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

GitHubActionLogWriter reports results via logging command to create annotations. https://help.github.com/en/actions/automating-your-workflow-with-github-actions/development-tools-for-github-actions#example-5

func NewGitHubActionLogWriter

func NewGitHubActionLogWriter(level string) *GitHubActionLogWriter

NewGitHubActionLogWriter returns new GitHubActionLogWriter.

func (*GitHubActionLogWriter) Flush

func (lw *GitHubActionLogWriter) Flush(_ context.Context) error

Flush checks overall error at last.

func (*GitHubActionLogWriter) Post

func (lw *GitHubActionLogWriter) Post(_ context.Context, c *reviewdog.Comment) error