Integrate Reports source syntax check
Beffroi Reporting CI All checks passed and encrypted report archives were built.
Beffroi/beffroi-reporting/pipeline/head This commit looks good
Details
Beffroi Reporting CI All checks passed and encrypted report archives were built.
Beffroi/beffroi-reporting/pipeline/head This commit looks good
Details
This commit is contained in:
parent
eb1c88a673
commit
2b277586e0
|
|
@ -18,9 +18,9 @@ flowchart LR
|
|||
|
||||
**Reports** stores authored YAML reports in `reports/reports/` and raw
|
||||
WinDiagnostics JSON captures in `reports/diagnostics/`. The raw captures are
|
||||
source evidence for the diagnostic renderer. This repository contains no
|
||||
plugin, analyzer, visual asset, test runner, or Jenkinsfile. Source provenance
|
||||
is documented in `reports/docs/preserved-source.md`.
|
||||
source evidence for the diagnostic renderer. It has a small syntax checker and
|
||||
Jenkins job, but no plugin, analyzer, or visual asset. Source provenance is
|
||||
documented in `reports/docs/preserved-source.md`.
|
||||
|
||||
**Reportist** is the rendering engine. Its public entry point is
|
||||
`reporter/build.sh`; see its [CLI contract](../reporter/docs/build-cli.md).
|
||||
|
|
@ -57,6 +57,9 @@ are routed explicitly in `reporter/build.sh`; there is no automatic registry.
|
|||
|
||||
## Verification
|
||||
|
||||
`uv run --script reports/check_sources.py` checks the YAML and JSON source
|
||||
syntax. Reports CI runs this check on its own repository.
|
||||
|
||||
`./beffroi.sh test` runs the component suites, a diagnostic analysis workflow,
|
||||
and a full publication build. The parity checker verifies the set of 17 PDFs,
|
||||
recorded text hashes, and page counts. When original PDFs and Poppler are
|
||||
|
|
|
|||
|
|
@ -50,7 +50,8 @@ builds the publication, creates password-protected AES ZIP archives, archives
|
|||
them as CI artifacts, and copies `Reports.zip` and `Diagnostics.zip` to its
|
||||
configured deployment directory. Jenkins supplies `REPORT_ZIP_PASSWORD` from
|
||||
credentials. The password must not be committed or printed. The standalone
|
||||
Reportist Jenkinsfile runs plugin tests; Reports has no Jenkinsfile.
|
||||
Reportist Jenkinsfile runs plugin tests. Reports Jenkinsfile checks YAML and
|
||||
JSON syntax only.
|
||||
|
||||
`./beffroi.sh package BUILD_DIR ARTIFACT_DIR` runs the same packaging locally
|
||||
when `REPORT_ZIP_PASSWORD` is set. It requires `uv` and pinned `pyzipper`.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ visual language without sharing a forced document schema.
|
|||
| Repository | Owns | Does not own |
|
||||
| --- | --- | --- |
|
||||
| Beffroi Reporting (macro) | Editing workspace, pinned components, integration checks, publication staging, encrypted archives, deployment CI | Report layouts or diagnostic rules |
|
||||
| Beffroi Reports | Authored YAML/JSON and raw diagnostic captures, with editorial provenance | Executable rendering or analysis code |
|
||||
| Beffroi Reports | Authored YAML/JSON and raw diagnostic captures, with editorial provenance and syntax checks | Executable rendering or analysis code |
|
||||
| Reportist (`reporter/` here) | Standalone renderers, diagnostic analysis, validation, shared graphical elements, themes, plugin tests, and `build.sh` | The production source collection or publication destination |
|
||||
|
||||
A Reportist plugin owns its input format, interpretation, validation, and
|
||||
|
|
@ -35,7 +35,7 @@ Plugin-specific composition remains in `reporter/plugins/<name>/`.
|
|||
- Changes to existing renderers must preserve approved output. The current
|
||||
regression baseline covers seven authored reports and ten diagnostics.
|
||||
- The macro Jenkins pipeline is the publishing authority. Reportist's CI tests
|
||||
its own code; the Reports repository contains content and has no renderer CI.
|
||||
its own code; Reports CI checks source syntax without rendering.
|
||||
|
||||
See [architecture](architecture.md) for the component boundaries and
|
||||
[operations](operations.md) for the editing and publishing workflow. New
|
||||
|
|
|
|||
2
reports
2
reports
|
|
@ -1 +1 @@
|
|||
Subproject commit 39de436eac70b3a76148f70085faae668ab55c38
|
||||
Subproject commit ed93983cc741e97fee8313ee5ba1a5b4b7d5a830
|
||||
|
|
@ -8,6 +8,7 @@ for command in git typst python3 uv; do
|
|||
exit 1
|
||||
}
|
||||
done
|
||||
uv run --script reports/check_sources.py
|
||||
reporter/tests/test.sh
|
||||
python3 -m unittest discover -s scripts/tests -p 'test_*.py' -v
|
||||
work=$(mktemp -d "${TMPDIR:-/tmp}/beffroi-check.XXXXXXXX")
|
||||
|
|
|
|||
Loading…
Reference in New Issue