StackGuardian / StackGuardian/tirith

feat(output): HTML report — `--output-html`

Open
#328 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
165
Forks
42
Avg merge
1d 3h
Merged PRs (30d)
11

Description

Today results only print to the CLI. Emit a self-contained HTML report (inline CSS, no external
assets) from the same result model as --output-json/--output-markdown and SARIF: verdict
summary, per-policy sections, per-resource rows with address/action/attribute, severity colouring.
Design language to match the Tirith logo. Many testing tools ship exactly this artefact, and it is
what CI systems archive.

Acceptance. tirith … --output-html report.html renders offline in a browser; the Action and
the GitLab component upload it as a pipeline artifact.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the CLI entry points for --output-json, --output-markdown, and SARIF, and trace how they consume the shared result model. Define the HTML output boundary and check how the Action and GitLab component handle report files. Done means --output-html produces an offline, self-contained report with the listed verdict, policy, resource, and severity details that CI can upload.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.