ci: DX glue + config/docs lint (.editorconfig, pre-commit, yamllint, markdownlint, lychee)#122
Merged
Merged
Conversation
…markdownlint, lychee) (#118) Rounds out the non-shell tooling around RigForge's existing shellcheck/shfmt + kcov core, finishing the tooling epic (#116). - .editorconfig: encodes the whitespace house style (shfmt -i 4, LF, final newline) so editors match CI. - pre-commit: .pre-commit-config.yaml now orchestrates `make lint` (shellcheck + shfmt via the Makefile's SHELL_FILES — single source of truth, no duplicated list), the existing gitleaks hook, and freebie hygiene hooks (detect-private-key, check-added-large-files, end-of-file-fixer, trailing-whitespace). - yamllint + markdownlint: new CI jobs in ci.yml (and `make lint-yaml` / `make lint-md`), each with a tuned config (.yamllint, .markdownlint-cli2.yaml) matching the repo's house style. Pinned via pipx / npx like diff-cover/zizmor. - lychee: new scheduled workflow (links.yml) + `make lint-links`, kept off the PR path since external links are flaky-by-nature. Pinned + checksum-verified binary. - docs: small fixes to satisfy the structural markdown rules (blank lines around headings/lists/fences via --fix; code-fence languages; fenced donation block; README hero subtitle as <h3> to keep the heading hierarchy clean). - CONTRIBUTING: document the hooks + the config/docs lint targets. Validated locally: yamllint --strict, markdownlint, zizmor (online), lychee (198 links OK), and `pre-commit run --all-files` all green. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This was referenced Jun 18, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #118. Finishes the tooling epic #116 (companion to #117, already merged).
Rounds out the non-shell tooling around RigForge's existing shellcheck/shfmt + kcov core. Mirrors the repo's conventions throughout: Makefile = single source of truth, pinned tool versions, and
local == CI.What's added
.editorconfigEncodes the whitespace house style (
shfmt -i 4, LF,insert_final_newline, andtrim_trailing_whitespace— off for*.mdso two-space line breaks survive) so editors match CI without per-editor setup.pre-commit (extends the #117 seed)
.pre-commit-config.yamlnow runs, on every commit:make lint(shellcheck + shfmt) as alocalhook — reuses the Makefile'sSHELL_FILESso there's no duplicated file list.pre-commit-hooks:detect-private-key,check-added-large-files,end-of-file-fixer,trailing-whitespace(with--markdown-linebreak-ext=md).yamllint + markdownlint — new CI gates
Lint (yamllint)andLint (markdownlint)jobs inci.yml, plusmake lint-yaml/make lint-mdfor local runs..yamllint,.markdownlint-cli2.yaml) that respect the repo's deliberate style (long explanatory lines,*asterisk*emphasis, Keep-a-Changelog duplicate headings,<details>HTML) while keeping the structural rules (blank lines around headings/lists/fences, code-fence languages, heading increments).pipx(yamllint 1.38.0) andnpx(markdownlint-cli2 0.22.1), same approach as the existingdiff-cover/zizmorinstalls.lychee — scheduled link check
links.ymlworkflow +make lint-links. Kept off the PR path (external links are flaky-by-nature, per the issue) — runs weekly + on demand. Pinned + checksum-verified binary, like the gitleaks/shellcheck installs.Docs
Small fixes so the structural markdown rules pass: blank lines around headings/lists/fences (via
markdownlint --fix), code-fence languages in the bug-report template, the README donation address as a fenced block, and the README hero subtitle as<h3>(keeps the look, clears the#→###heading jump).Acceptance (#118)
.editorconfigcommittedCONTRIBUTING.mdupdatedValidation (ran locally)
--strict— clean across all 8 YAML fileslinks.yml+ci.ymljobspre-commit run --all-files— all six hooks pass; the freebie fixers made no changes (repo already clean)Note
The two new PR gates (
Lint (yamllint),Lint (markdownlint)) should be added todevelop's required status checks — I'll do that once they report green here.🤖 Generated with Claude Code