Contributor scripts

View Source

Run from the repository root. See Contributing for setup and testing for requirements. Paths below are relative to scripts/.

PathPurpose
quality-matrixSupported-runtime checks, then latest-runtime performance
test-quality-matrixOrchestration tests using simulated containers and Mix commands
check-performanceBenchmarks with CI's VM settings
performance-regression.exsGuarded workloads and fixed-baseline comparisons
benchmarks/Focused rendering/image benchmarks
fixtures/Browser sheets and PNG/PDF cases
data/HTML entities, quotation data and licenses
examples/Documented HTML/PDF examples

Common commands

TaskCommand
Full matrix, two concurrent lanes./scripts/quality-matrix
Serial matrix for smaller hostsQUALITY_MATRIX_JOBS=1 ./scripts/quality-matrix
Validate/print runtime config without Docker./scripts/quality-matrix --matrix-json
Performancemise exec -- ./scripts/check-performance
Browser sheetsMIX_ENV=test mise exec -- mix run scripts/fixtures/build-browser-sheets.exs
HTML/PDF examplesmise exec -- mix run scripts/examples/generate-html-to-pdf.exs

Raise QUALITY_MATRIX_JOBS for additional runtimes only when resources allow.

Regeneration rules

ConcernRule
PrerequisitesRead the generator header for required inputs and tools
Reference inputsReview regenerated bytes and retain provenance
Performance identityKeep workload IDs, logical input keys, hashes and guard membership; input_sources records current paths
Moved inputsMoving a file never resets reduction, timing or size baselines
Temporary workExperiments in tmp/; validation evidence in .quality/
Script namesUse the operation and feature