Reproducible Beffroi diagnostics and reporting workspace, pinning the collector, report archive and renderer into one workflow.
Go to file
Dandaedre 83529e3e05
Beffroi Reporting CI All checks passed and encrypted report archives were built.
Beffroi/beffroi-reporting/pipeline/head This commit looks good Details
chore: follow reportist root entrypoint
2026-09-16 02:13:39 +02:00
diagnostics@caa17cc575 test: pin simplified component dependencies 2026-09-16 02:05:00 +02:00
docs ci: build and publish encrypted report archives 2026-09-16 01:55:34 +02:00
reporter@d5ad5bb0e6 chore: follow reportist root entrypoint 2026-09-16 02:13:39 +02:00
reports@5cf1945f56 workflow: add unified reporting entry point 2026-09-16 02:03:19 +02:00
scripts chore: follow reportist root entrypoint 2026-09-16 02:13:39 +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 ci: restore uv managed zip packaging 2026-09-16 02:10:39 +02:00
LICENSE.md New licences 2026-09-15 15:05:13 +02:00
README.md ci: restore uv managed zip packaging 2026-09-16 02:10:39 +02:00
beffroi.sh chore: follow reportist root entrypoint 2026-09-16 02:13:39 +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 AES-encrypted Reports.zip and Diagnostics.zip 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.