githubactions

package
v0.380.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 12, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

README

GitHub Actions Output Renderer

Renders audit findings as GitHub Actions workflow commands for inline PR/CI annotations.

Files

File Responsibility
render.go Formats findings as ::error, ::warning, and ::notice workflow commands
render_test.go Verifies level mapping, location/file formatting, escaping, unsupported notices, and explain-command text

Exports

  • Render(report.Result, Options) ([]byte, error)
  • Options — carries renderer configuration (Path source file path; when empty, annotations omit the file parameter)

Annotation Shape

Finding annotations are self-contained so a reviewer can triage without opening raw logs:

  • Title: [<level>] <rule_id> (e.g. title=[blocker] dml.where.require).
  • Message: the finding message, an optional Suggestion: line when the finding explanation carries one, and a trailing Explain: deltascope rules explain <rule_id> line.
  • Command: level maps to the workflow command — blocker → ::error, warning → ::warning, notice → ::notice.
  • Location: file/line/col are included when location and/or path are available; file is omitted when Options.Path is empty.

Unsupported statements render as ::notice and do not gain an explain command, because unsupported statements have no rule id.

Notes

  • The renderer preserves GitHub workflow-command escaping: % → %25, newline → %0A, carriage return → %0D.
  • level (blocker/warning/notice) is the only public priority concept. No severity field exists here.
  • The renderer never emits raw SQL beyond what an existing finding message already carries.

Documentation

Overview

Package githubactions renders audit results as GitHub Actions workflow commands. input: internal report results from the audit application flow output: GitHub Actions annotation commands for CI pipeline integration pos: infrastructure output adapter for the GitHub Actions CI-native renderer note: if this file changes, update this header and module README.md.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Render 

func Render(result report.Result, options Options) ([]byte, error)

Render formats an audit result into GitHub Actions annotation commands.

Types

type Options added in v0.47.0 

type Options struct {
	// Path is the source file path. When empty, annotations omit the file parameter.
	Path string
}

Options carries renderer configuration.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.