summary

package
v1.3.10 Latest Latest
Warning

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

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

Documentation

Overview

Package summary implements a rendering driver that outputs the evaluation results as a single traffic-light line, suitable for compact destinations such as the GitHub Actions step summary.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Driver

type Driver struct{}

Driver renders evaluation results as a single line

func New

func New() *Driver

New returns a new summary driver

func (*Driver) RenderResult

func (d *Driver) RenderResult(w io.Writer, result *papi.Result) error

RenderResult writes the policy result as a single line

func (*Driver) RenderResultGroup

func (d *Driver) RenderResultGroup(w io.Writer, group *papi.ResultGroup) error

RenderResultGroup writes the group result as a single line

func (*Driver) RenderResultSet

func (d *Driver) RenderResultSet(w io.Writer, rset *papi.ResultSet) error

RenderResultSet writes the whole resultset as a single line. Sets with a single policy or group render as that unit's line; larger sets lead with the first failing (or softfailing) unit and a failure count.

Jump to

Keyboard shortcuts

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