Reproducible Beffroi diagnostics and reporting workspace, pinning the collector, report archive and renderer into one workflow.
Go to file
Dandaedre 69240d276e
Beffroi Reporting CI All checks passed and encrypted report archives were built.
Beffroi/beffroi-reporting/pipeline/head This commit looks good Details
Make publication paths portable on CI
2026-09-16 20:54:26 +02:00
docs Run PDF parity checks without Poppler on CI 2026-09-16 20:51:39 +02:00
reporter@70f763a65a Make publication paths portable on CI 2026-09-16 20:54:26 +02:00
reports@21cf355d73 Make publication paths portable on CI 2026-09-16 20:54:26 +02:00
scripts Make publication paths portable on CI 2026-09-16 20:54:26 +02:00
.gitignore Gitignore 2026-09-16 20:11:36 +02:00
.gitmodules Integrate diagnostic plugin and retire analysis submodule 2026-09-16 18:03:05 +02:00
AGENT-TASKS.md Plan content-only reports and unified Reportist build 2026-09-16 20:43:19 +02:00
Jenkinsfile Route publications through independent renderer plugins 2026-09-16 20:08:22 +02:00
LICENSE.md New licences 2026-09-15 15:05:13 +02:00
README.md Route publications through independent renderer plugins 2026-09-16 20:08:22 +02:00
beffroi.sh Route publications through independent renderer plugins 2026-09-16 20:08:22 +02:00
bootstrap.sh Integrate diagnostic plugin and retire analysis submodule 2026-09-16 18:03:05 +02:00

README.md

Beffroi Reporting

Beffroi Reporting builds PDF reports from authored YAML/JSON and raw WinDiagnostics captures. The report and diagnostic plugins own their document structure separately. Both import the visual elements and palettes in reporter/visual.

Render one report

./beffroi.sh report reports/reports/2026-09-04-clevo-handoff.yaml report.pdf

Authored reports use organization, theme, metadata, summary, sections, findings, actions, and any report-specific fields. Available named palettes are default, cic, and eridani; a custom theme dictionary is also accepted. The report plugin is in reporter/plugins/report.

Render one diagnostic

./beffroi.sh diagnostic-pdf reports/diagnostics/windows_system_report_DESKTOP-SAU019H_20260915_121057.json diagnostic.pdf

diagnostic-pdf and capture-pdf accept raw WinDiagnostics JSON v1 or v2. Set DIAGNOSTICS_THEME=default, cic, or eridani, and optionally DIAGNOSTICS_AUTHOR, before rendering. The diagnostic plugin is in reports/plugins/diagnostics. Its PDF renderer uses the raw capture directly; its separate analyzer can also emit normalized diagnostic JSON v1 for evidence processing:

./beffroi.sh diagnostic CAPTURE.json EVIDENCE_ROOT NEW_OUTPUT_DIR REFERENCE_TIME [AUTHOR] [THEME]

That command writes diagnostic.json and report.pdf.

Build the publication

./beffroi.sh all build/publication
./beffroi.sh all build/publication --replace --include-json

The build creates seven authored report PDFs and ten diagnostic PDFs from the stored sources. --include-json exports authored report JSON and copies raw diagnostic JSON alongside the PDFs. --replace stages a complete build before replacing an existing output directory.

Run ./beffroi.sh test to test the plugins and compare every published PDF with the original Typst renderer. When legacy/typst_reporter/build is present, the comparison checks extracted text, page counts, and rasterized pages. Without that local reference, it checks recorded original text hashes and page counts.

Commands

./beffroi.sh report INPUT.yaml|json OUTPUT.pdf [--force]
./beffroi.sh diagnostic-pdf CAPTURE.json OUTPUT.pdf
./beffroi.sh capture-pdf CAPTURE.json OUTPUT.pdf
./beffroi.sh diagnostic CAPTURE EVIDENCE_ROOT OUTPUT_DIR REFERENCE_TIME [AUTHOR] [THEME]
./beffroi.sh all OUTPUT_DIR [--include-json] [--replace]
./beffroi.sh package BUILD_DIR ARTIFACT_DIR
./beffroi.sh test
./beffroi.sh bootstrap
./beffroi.sh doctor

See docs/development.md for implementation details.