Validation¶
Canonical command¶
This is the single entry point for all local validation. Run it before committing to catch issues early.
Dispatch architecture¶
validate_local.sh uses a dispatch architecture that separates common
validation (shared across repositories) from repository-specific checks:
- Common checks — Sourced from
standard-toolingvia the sync mechanism. These include markdownlint, shellcheck, and other universal validations. - Custom checks — Repository-specific validations defined locally, such as actionlint for this repository's workflow files.
The standard-tooling package provides the common validation scripts via
st-* CLI commands. The standards-compliance action checks script freshness
in CI to ensure local copies stay in sync with the canonical versions.
Docs-only validation¶
For changes that only affect documentation:
This runs a subset of checks relevant to documentation changes (primarily markdownlint).
Tooling dependencies¶
Validation requires the following tools to be installed:
actionlint— GitHub Actions workflow lintingshellcheck— Shell script static analysismarkdownlint— Markdown formatting
See Environment and Tooling for installation instructions.