timothyswan/vale repository overview

Vale⁠ is a configurable prose linter for technical documentation. Apply Microsoft Style Guide, Google Style, Mozilla Writing Style, the alex inclusive-language rules, or write-good — or your org's own style — to Markdown, AsciiDoc, reStructuredText, Org-mode, and any other plain-text format that ships in your repo.

This image builds Vale from upstream source on hi/go:latest-builder and lands on hi/core-runtime (Red Hat Hardened). The binary is cosign-signed with a CycloneDX SBOM and SLSA Level 3 provenance attestation attached.

⁠Usage

# Lint all Markdown in a repo against the in-repo .vale.ini config
podman run --rm -v "$(pwd):/repo:ro,Z" vale:<version>-rhhi --output=JSON .

# Use the Microsoft Style Guide pack (assumes styles already vendored at .github/styles/)
podman run --rm -v "$(pwd):/repo:ro,Z" vale:<version>-rhhi --output=line --no-exit docs/

# Filter by severity
podman run --rm -v "$(pwd):/repo:ro,Z" vale:<version>-rhhi --minAlertLevel=warning .

⁠Style configuration

Vale reads .vale.ini from the repo root. A minimal example:

StylesPath = .github/styles
MinAlertLevel = suggestion

Packages = Microsoft, alex

[*.md]
BasedOnStyles = Vale, Microsoft, alex

Vendored style packs go under StylesPath (typically .github/styles/). Available packs are listed at https://github.com/errata-ai/styles⁠.

⁠Supply chain

• Base images: registry.access.redhat.com/hi/go:latest-builder (build) → registry.access.redhat.com/hi/core-runtime (runtime)
• Built from: upstream source at the pinned commit
• Tier: 1 (Go, built from source)
• Signed: cosign key-only signature (no Rekor transparency log)
• SBOM: CycloneDX JSON attached as OCI attestation
• Provenance: SLSA Level 3 attached as OCI attestation