Reproducible Beffroi diagnostics and reporting workspace, pinning the collector, report archive and renderer into one workflow.
Go to file
Dandaedre 7ed97a36cf
Beffroi Reporting CI Beffroi Reporting workspace passed all currently implemented CI checks.
Beffroi/beffroi-reporting/pipeline/head This commit looks good Details
feat: pin validated v1 contracts and document recursive push
2026-09-15 16:32:36 +02:00
beffroi-reports@79f93e43d5 feat: pin validated v1 contracts and document recursive push 2026-09-15 16:32:36 +02:00
docs test: add reproducible synthetic legacy migration baseline 2026-09-15 16:09:27 +02:00
references chore: establish reporting migration workspace 2026-09-15 15:00:26 +02:00
reportist@e2ada627d0 feat: pin validated v1 contracts and document recursive push 2026-09-15 16:32:36 +02:00
scripts test: add reproducible synthetic legacy migration baseline 2026-09-15 16:09:27 +02:00
win-diagnostics@792d92d5ca feat: pin validated v1 contracts and document recursive push 2026-09-15 16:32:36 +02:00
.gitignore Adds all gitignores & READMEs 2026-09-15 15:15:36 +02:00
.gitmodules Tries to change the submodules 2026-09-15 15:36:53 +02:00
AGENTS-TASKS.md feat: pin validated v1 contracts and document recursive push 2026-09-15 16:32:36 +02:00
AGENTS.md Add AGENTS.md 2026-09-15 14:53:51 +02:00
Jenkinsfile Fix JK? 2026-09-15 15:44:25 +02:00
LICENSE.md New licences 2026-09-15 15:05:13 +02:00
README.md feat: pin validated v1 contracts and document recursive push 2026-09-15 16:32:36 +02:00

README.md

Beffroi Reporting

Beffroi Reporting is the integration workspace for the Beffroi diagnostics and reporting toolchain.

It brings the complete environment together as Git submodules:

beffroi-reporting
├── win-diagnostics/
├── beffroi-reports/
└── reportist/

The target layout uses diagnostics/, reports/, and reporter/ respectively. Renaming the current submodule paths is tracked in the migration roadmap.

During migration, the previous implementations are also available under references/ so developers and agents can inspect the complete old and new workflows from one workspace.

The target pipeline is:

Windows
   ↓
win-diagnostics
   ↓
diagnostic.json
   ↓
beffroi-reports
   ↓
report.yaml
   ↓
reportist
   ↓
PDF

Getting started

Clone the complete workspace with its submodules:

git clone --recursive <repository-url>
cd beffroi-reporting

For an existing checkout:

git submodule update --init --recursive

Push component commits and the workspace together

After committing changes inside each component and committing their updated submodule pins in this repository, run from the macro repository:

git push --recurse-submodules=on-demand

Git pushes the component commits needed by the macro commits before pushing the macro repository. If a required component push fails, the macro push stops. This uses each repository's configured remote/upstream; it does not commit files or push unrelated component branches. All current component main branches have an origin/main upstream. Unchanged reference submodules need no push.

To make that behavior the local default for this checkout:

git config push.recurseSubmodules on-demand

See the Git push documentation.

Migration status

🚧 Architecture migration in progress

AGENTS-TASKS.md tracks completed work, remaining migration passes, acceptance criteria, and the next-pass handoff. AGENTS.md defines repository ownership and rules for agents working across the workspace.

The first executable migration check is the synthetic legacy baseline. It records diagnostic behavior and renders example PDFs before extraction.

Version-1 diagnostic validation and report validation are now available independently in their component repositories. The new end-to-end pipeline remains in progress.

License

Root-level software and orchestration code is licensed under the MIT License.

Internal Beffroi data and content remain proprietary where applicable; see LICENSE-DATA.md.