Reproducible Beffroi diagnostics and reporting workspace, pinning the collector, report archive and renderer into one workflow.
Go to file
Dandaedre 2356e2c7a5
workflow: add unified reporting entry point
2026-09-16 02:03:19 +02:00
diagnostics@bf331f6bdb workflow: add unified reporting entry point 2026-09-16 02:03:19 +02:00
docs ci: build and publish encrypted report archives 2026-09-16 01:55:34 +02:00
reporter@79179b2f68 workflow: add unified reporting entry point 2026-09-16 02:03:19 +02:00
reports@5cf1945f56 workflow: add unified reporting entry point 2026-09-16 02:03:19 +02:00
scripts workflow: add unified reporting entry point 2026-09-16 02:03:19 +02:00
.gitignore Adds all gitignores & READMEs 2026-09-15 15:15:36 +02:00
.gitmodules chore: remove legacy reference repositories 2026-09-16 01:38:33 +02:00
Jenkinsfile workflow: add unified reporting entry point 2026-09-16 02:03:19 +02:00
LICENSE.md New licences 2026-09-15 15:05:13 +02:00
README.md workflow: add unified reporting entry point 2026-09-16 02:03:19 +02:00
beffroi.sh workflow: add unified reporting entry point 2026-09-16 02:03:19 +02:00
bootstrap.sh ci: build and publish encrypted report archives 2026-09-16 01:55:34 +02:00

README.md

Beffroi Reporting

Beffroi Reporting turns structured reports and Windows diagnostic captures into PDFs. The root beffroi.sh command is the main entry point.

Generate one personal report

Write a Reportist YAML or JSON file, then run:

./beffroi.sh report my-report.yaml my-report.pdf

See reporter/examples for complete inputs.

Generate one diagnostic report

./beffroi.sh diagnostic \
  capture.json /path/to/evidence /path/to/new-output \
  2026-09-15T12:00:00Z 'Diagnostic review' 'Reviewer Name' 2026-09-15

The output contains the normalized diagnostic, evidence-backed draft generation, and rendered PDF.

Generate every stored PDF

Add report YAML files under reports/reports or diagnostic JSON captures under reports/diagnostics, commit them with the reports submodule update, and run:

./beffroi.sh all build/publication

Jenkins runs the same build and publishes encrypted report archives from main.

Commands

./beffroi.sh report INPUT OUTPUT.pdf
./beffroi.sh diagnostic CAPTURE EVIDENCE_ROOT OUTPUT_DIR REFERENCE_TIME TITLE AUTHOR DATE
./beffroi.sh all NEW_OUTPUT_DIR
./beffroi.sh package BUILD_DIR ARTIFACT_DIR
./beffroi.sh test
./beffroi.sh bootstrap
./beffroi.sh doctor

The command reports missing tools for the requested operation. See docs/development.md for repository structure, testing, publication details, and component development.