feat: pin validated v1 contracts and document recursive push
Beffroi Reporting CI Beffroi Reporting workspace passed all currently implemented CI checks.
Beffroi/beffroi-reporting/pipeline/head This commit looks good
Details
Beffroi Reporting CI Beffroi Reporting workspace passed all currently implemented CI checks.
Beffroi/beffroi-reporting/pipeline/head This commit looks good
Details
This commit is contained in:
parent
6763fb99f5
commit
7ed97a36cf
|
|
@ -13,7 +13,7 @@ Component implementation belongs in its own repository. Commit component changes
|
|||
there, then intentionally update the integration repository's gitlinks once the
|
||||
combination has been verified. Do not follow remote HEAD automatically.
|
||||
|
||||
## Current baseline — 2026-09-15
|
||||
## Initial baseline — 2026-09-15
|
||||
|
||||
Component task details and handoffs are maintained in:
|
||||
|
||||
|
|
@ -66,9 +66,9 @@ incident evidence mapping remain open under P0.5 and component tasks.
|
|||
|
||||
Depends on P0.5–P0.6 for the selected slice.
|
||||
|
||||
- [ ] P1.1 **win-diagnostics:** define `schemas/diagnostic.schema.json`, schema versioning, metadata, collection status, observations, findings, warnings, and evidence references. Distinguish missing/failed checks from healthy results.
|
||||
- [ ] P1.2 **win-diagnostics:** document how legacy capture schemas 1 and 2 map to the new diagnostic artifact, including unsupported versions and retained raw evidence.
|
||||
- [ ] P1.3 **reportist:** define `schema/report.schema.json` and versioned YAML/JSON input, required/optional fields, generic content blocks, external branding/assets, and actionable validation errors. Map useful legacy report fields explicitly.
|
||||
- [x] P1.1 **win-diagnostics:** define `schemas/diagnostic.schema.json`, schema versioning, metadata, collection status, observations, findings, warnings, and evidence references. Distinguish missing/failed checks from healthy results.
|
||||
- [x] P1.2 **win-diagnostics:** document how legacy capture schemas 1 and 2 map to the new diagnostic artifact, including unsupported versions and retained raw evidence.
|
||||
- [x] P1.3 **reportist:** define `schema/report.schema.json` and versioned YAML/JSON input, required/optional fields, generic content blocks, external branding/assets, and actionable validation errors. Map useful legacy report fields explicitly.
|
||||
- [ ] P1.4 **beffroi-reports:** define the adapter mapping and incident structure; distinguish machine findings, human analysis, and recipient-facing conclusions. Specify how regeneration preserves human edits.
|
||||
- [ ] P1.5 **components:** document independent CLI input/output paths, exit codes, dependencies, and schema compatibility. Add synthetic valid/invalid contract examples and validation checks in their owning repositories.
|
||||
|
||||
|
|
@ -171,3 +171,12 @@ reports remain understandable/recreatable and individual tools need no macro rep
|
|||
- Preserved concurrent component checkout updates that renamed instructions to `AGENT.md` and corrected reports CI license paths. References remain unchanged.
|
||||
- Limits: no native Windows collection (PowerShell unavailable), migrated engine/renderer/adapter, private historical rendering, full pagination review, or advisory revalidation. P0.5 remains open for the remaining detailed historical/packaging inventory.
|
||||
- Next: implement WD1/RT1 versioned schemas and synthetic validation examples; finish BR0.5 claim/evidence mapping before moving private incidents.
|
||||
|
||||
### 2026-09-15 — Versioned contract pass and push workflow
|
||||
|
||||
- Completed P1.1–P1.3: two independent v1 schemas/validators, synthetic examples, invalid-input tests, evidence-reference validation, documented compatibility, and pinned dependency files.
|
||||
- Added concrete report-adapter mapping and incident/provenance layout. P1.4 remains open for exact draft ownership/conflict/recovery behavior; P1.5 remains open for collection/analysis/render command contracts beyond the implemented validators.
|
||||
- Documented `git push --recurse-submodules=on-demand`; verified current branches have upstreams. No push or local Git configuration change was performed.
|
||||
- Validation: 10 diagnostic and eight report unittest cases pass independently on Python 3.11; initial core suites also passed on Python 3.14. Component copies run without macro, sibling or reference repositories. CI now invokes those tests; Jenkins itself was not executed.
|
||||
- Limits: no collector/analyzer, generic renderer, adapter, full pipeline, or private historical baseline is claimed. Existing reference sources and legacy fixtures remain unchanged.
|
||||
- Next: finish executable collection/analysis/render CLI contracts and draft regeneration policy, then extract the first diagnostic and generic rendering slices against the preserved baseline.
|
||||
|
|
|
|||
29
README.md
29
README.md
|
|
@ -49,7 +49,30 @@ For an existing checkout:
|
|||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
## Status
|
||||
## 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:
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
git config push.recurseSubmodules on-demand
|
||||
```
|
||||
|
||||
See the [Git push documentation](https://git-scm.com/docs/git-push#Documentation/git-push.txt---recurse-submodulescheckon-demandonlyno).
|
||||
|
||||
## Migration status
|
||||
|
||||
🚧 **Architecture migration in progress**
|
||||
|
||||
|
|
@ -60,6 +83,10 @@ repository ownership and rules for agents working across the workspace.
|
|||
The first executable migration check is the [synthetic legacy baseline](docs/migration-baseline.md).
|
||||
It records diagnostic behavior and renders example PDFs before extraction.
|
||||
|
||||
Version-1 [diagnostic validation](win-diagnostics/docs/diagnostic-contract.md) and
|
||||
[report validation](reportist/docs/report-contract.md) 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**.
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Subproject commit 10c59ddaa3d22730244416a7dcd1842d1e00e6e3
|
||||
Subproject commit 79f93e43d5917e5b2d22c647c6e73dc98b6c3108
|
||||
|
|
@ -1 +1 @@
|
|||
Subproject commit 3b73d1a03c25c1d9ac56959768b894c64b607980
|
||||
Subproject commit e2ada627d0e55f57a1dc4b47e2e06eabb1ad7246
|
||||
|
|
@ -1 +1 @@
|
|||
Subproject commit c0d7f42e8ca31e7f8de4f3475211a52b8db9e3d4
|
||||
Subproject commit 792d92d5ca1e24dd4c7b330f58144b1c3012b6c8
|
||||
Loading…
Reference in New Issue