docs: verify clean integration bootstrap
Beffroi Reporting CI Beffroi Reporting integration CI failed.
Beffroi/beffroi-reporting/pipeline/head There was a failure building this commit Details

This commit is contained in:
Dandaedre 2026-09-15 23:17:43 +02:00
parent f5c2e69ea9
commit c25f01d3a0
Signed by: Dandaedre
GPG Key ID: 440C6592E8A26D99
2 changed files with 35 additions and 4 deletions

View File

@ -131,7 +131,7 @@ Depends on a working end-to-end slice from Passes 2–4. Work in beffroi-reporti
- [x] P5.5 Invoke component checks and the integration test from Jenkins; report actual validation coverage, tool versions, and artifacts accurately.
- Component contract suites are wired through `make check` and Jenkins; the
complete analysis, diagnostic-to-report, and PDF-rendering path is included.
- [ ] P5.6 Pin the tested component commits intentionally and document external dependencies plus clean-checkout reproduction commands; verify `git clone --recursive` followed by bootstrap and integration testing.
- [x] P5.6 Pin the tested component commits intentionally and document external dependencies plus clean-checkout reproduction commands; verify `git clone --recursive` followed by bootstrap and integration testing.
Exit: a pinned integration revision runs the sanitized pipeline reproducibly,
subject to documented system dependencies, while each component stays standalone.
@ -163,10 +163,15 @@ reports remain understandable/recreatable and individual tools need no macro rep
- The integration suite now exercises `scripts/workflow.sh all` itself, producing
a diagnostic artifact, immutable generation, and PDF in a fresh temporary run.
Explicit reference time and report metadata prevent clock/account defaults.
- Validation: 62 component tests plus the complete workflow pipeline pass.
- Validation: 62 component tests plus the complete workflow pipeline pass. A clean
local clone initialized all five recorded gitlinks, ran bootstrap, repeated the
suite, and remained clean. Local source URLs replaced HTTPS only to keep this
reproducibility check offline; the recorded public URLs were unchanged.
- Documented the tested Git/uv/Python/Typst versions, fonts, optional Poppler tools,
network boundary, exact reproduction commands, and PDF byte limitations.
Native Windows collection remains outside the current Linux validation.
- Next: verify bootstrap from a clean recursive clone and document exact external
dependencies/pins under P5.6, then address remaining component migration work.
- Next: align the three active submodule paths under P5.1, then address remaining
component migration work.
### 2026-09-15 — Standalone renderer pass complete

View File

@ -55,6 +55,32 @@ checks Git, uv, and Typst, and prepares isolated Python 3.11 environments under
packages, but it does not install system packages. Use `./bootstrap.sh --check`
for a read-only dependency and pinned-revision check.
### External dependencies
| Tool | Supported/tested use |
| --- | --- |
| Bash, Git, Make | Workspace scripts, pinned submodules, and high-level commands |
| uv 0.12.13 | Creates Python 3.11 environments and installs locked dependencies |
| Python 3.11.14 | Tested component runtime, selected through uv |
| Typst 0.15.1 | PDF compilation; Reportist supports Typst 0.15 or newer |
| DejaVu Sans / Sans Mono | Fonts selected by the bundled synthetic examples |
| Poppler `pdfinfo` / `pdftotext` | Optional pagination/text inspection in Reportist tests |
The first bootstrap may require network access for HTTPS submodules, Python, and
locked packages. Recreate and verify a pinned checkout with:
```bash
git clone --recursive <repository-url>
cd beffroi-reporting
./bootstrap.sh
make check
./bootstrap.sh --check
```
`git submodule status` prints the exact component revisions. A historical root
commit therefore selects its recorded compatible tool set rather than remote
branch heads. Exact PDF bytes can still vary with the Typst binary and font files.
## Run the workflow
`make help` lists the high-level commands. Each delegates to the pinned component