README
¶
Output Infrastructure Module
Rendering adapters for turning internal audit results into transport-friendly formats.
Files
| File | Responsibility |
|---|---|
| markdown/README.md | Documents the Markdown renderer module |
| json/README.md | Documents the JSON renderer module |
| githubactions/README.md | Documents the GitHub Actions annotation renderer module |
| githubsummary/README.md | Documents the GitHub Actions job-summary renderer module |
Exports
- Package boundary only; concrete renderers live in child modules
Dependencies
- Upstream:
internal/interfaces/cli, future HTTP API and MCP adapters - Downstream:
internal/domain/report,internal/domain/rule,internal/domain/rule/catalog
Update Rule
- If members/interfaces/dependencies change, update this file in same change.
Documentation
¶
Overview ¶
Package output provides shared output formatting utilities.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetBuilder ¶
GetBuilder returns a strings.Builder from the pool.
func PutBuilder ¶
PutBuilder resets and returns a strings.Builder to the pool.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package githubactions renders audit results as GitHub Actions workflow commands.
|
Package githubactions renders audit results as GitHub Actions workflow commands. |
|
Package githubsummary renders concise GitHub Actions job summaries.
|
Package githubsummary renders concise GitHub Actions job summaries. |
|
Package gitlabcodequality renders audit results as GitLab Code Quality JSON.
|
Package gitlabcodequality renders audit results as GitLab Code Quality JSON. |
|
Package jsonrender renders audit results as machine-oriented JSON.
|
Package jsonrender renders audit results as machine-oriented JSON. |
|
Package markdown renders audit results as human-readable Markdown.
|
Package markdown renders audit results as human-readable Markdown. |
|
Package sarif renders audit results as SARIF 2.1.0 JSON.
|
Package sarif renders audit results as SARIF 2.1.0 JSON. |
Click to show internal directories.
Click to hide internal directories.