Lint & docs (lint-and-docs.yaml)

Lint & docs (lint-and-docs.yaml)

.github/workflows/lint-and-docs.yaml is the workflow named “Lint & docs”. It runs on a push to main, on every pull request, every Monday at 06:00 UTC to catch link rot, and by hand.¹ It has four read-only jobs:

• lint-scripts runs ShellCheck over the tree;
• lint-workflows runs actionlint;
• word-budgets fails when CONTRIBUTING.md passes 1000 words or SECURITY.md 900;
• validate-markdown runs markdownlint under .markdownlint-cli2.jsonc, lychee under lychee.toml with this repository’s links on main remapped to the checkout, and codespell over every tracked Markdown file.

Footnotes

1. .github/workflows/lint-and-docs.yaml, the header comment, the on key and the jobs ↩