Reproducible Beffroi diagnostics and reporting workspace, pinning the collector, report archive and renderer into one workflow.
Go to file
Dandaedre a769b936d7
Beffroi Reporting CI All checks passed and encrypted report archives were built.
Beffroi/beffroi-reporting/pipeline/head This commit looks good Details
feat: control publication JSON artifacts
2026-09-16 04:09:39 +02:00
diagnostics@59691960ae chore: use diagnostics bulk entrypoint 2026-09-16 03:16:52 +02:00
docs ci: build and publish encrypted report archives 2026-09-16 01:55:34 +02:00
reporter@d4b0f9f175 fix: reproduce legacy diagnostic publications 2026-09-16 03:30:10 +02:00
reports@a7cfd8b3f9 fix: update report conversion for current Typst 2026-09-16 04:04:37 +02:00
scripts feat: control publication JSON artifacts 2026-09-16 04:09:39 +02:00
.gitignore chore: keep legacy reporter as local reference 2026-09-16 02:34:38 +02:00
.gitmodules chore: follow renamed diagnostics repository 2026-09-16 03:05:58 +02:00
Jenkinsfile ci: publish archives to work reports directory 2026-09-16 02:20:30 +02:00
LICENSE.md New licences 2026-09-15 15:05:13 +02:00
README.md feat: control publication JSON artifacts 2026-09-16 04:09:39 +02:00
beffroi.sh feat: control publication JSON artifacts 2026-09-16 04:09: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-pdf capture.json diagnostic.pdf

This renders the capture directly with the established diagnostic layout. For the evidence-backed analysis workflow, run:

./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

Converted Reportist JSON is temporary and removed after a successful build. Use --keep-intermediates to retain it for troubleshooting:

./beffroi.sh all build/publication --keep-intermediates

Use --include-json to place the structured report JSON beside report PDFs and the original diagnostic JSON beside diagnostic PDFs. Packaging includes these JSON files, which is useful for downstream automation:

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

Jenkins runs the same build and publishes AES-encrypted Reports.zip and Diagnostics.zip archives from main into the dedicated work_reports destination.

Commands

./beffroi.sh report INPUT OUTPUT.pdf
./beffroi.sh diagnostic-pdf CAPTURE OUTPUT.pdf
./beffroi.sh diagnostic CAPTURE EVIDENCE_ROOT OUTPUT_DIR REFERENCE_TIME TITLE AUTHOR DATE
./beffroi.sh all NEW_OUTPUT_DIR [--keep-intermediates] [--include-json]
./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.