beffroi-tools/docs/development.md

1.6 KiB

Development and CI

tools/ contains the Python tools, src/ the Rust reporter trial, tests/ both regression suites, and scripts/ parity, packaging and badge utilities. Keep specialized documentation in docs/ and quick starts in the README.

Run Python checks from the repository root:

python3 -m unittest discover -s tests -v

Those tests mock external document tools. The Rust trial additionally runs real-media parity with FFmpeg, FFprobe and the Typst CLI. It checks identical JSON/Ontime output and generates all report formats. See the Rust development commands and coverage contract.

The Jenkins Multibranch Pipeline uses rust_no_docker, Python 3.11+, Rust, FFmpeg/FFprobe and Typst. It checks formatting, Clippy, documentation, Python and Rust tests, parity, and measured Rust line coverage. It installs pinned cargo-llvm-cov when needed. Cross/container builds happen outside Jenkins.

Cleanup archives the three version/test/coverage badges. Only non-PR main builds publish these mutable SVGs to the configured asset mount. Jenkins never creates tags or releases and does not archive release binaries.

The administrator must configure the actual Multibranch job, SCM credentials, worker dependencies and publication mount. For a Gitea-aware job, the webhook endpoint is the Jenkins base URL plus /gitea-webhook/post, with push events enabled. This repository does not create jobs, credentials or webhooks.

Every task that changes repository files ends with a commit after relevant checks; no push unless requested. Keep generated outputs out of Git.