Repository navigation
Turns on the Docs and Doc links gate stages - #168
Merged
Merged
Conversation
mix quality becomes the pre-publish check for this package's docs, locally and in CI. ex_quality 0.15 ships the Doc links stage; the dev dependency requirement moves from ~> 0.14 to ~> 0.15 with its options unchanged, and mix.lock moves ex_quality alone (0.14.0 to 0.15.0, via mix deps.update ex_quality). .quality.exs enables both stages at enabled: :auto, with the reason at the setting: the Docs stage fails on any ExDoc warning, and the Doc links stage fails on the link rules ExDoc accepts silently. No threshold moves. The full gate is green with both stages run and passing. No package version change; no changelog fragment (changelog.d/README.md excludes quality gate changes). Refs: sui-pk0h
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
1 participant
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.
Bead: sui-pk0h
mix qualitybecomes the pre-publish check for this package's docs, locally and in CI: the Docs and Doc links stages of ex_quality are switched on.What changes
{:ex_quality, "~> 0.14", only: :dev, runtime: false}to{:ex_quality, "~> 0.15", only: :dev, runtime: false}, options unchanged. ex_quality 0.15.0 is the release that ships the Doc links stage;mix hex.info ex_qualitylists it under recent releases as0.15.0 (2026-09-24)(hex.pm's date).mix deps.update ex_qualityonly; the lock diff moves ex_quality alone (0.14.0 to 0.15.0), no other dependency.docs: [enabled: :auto]anddoc_links: [enabled: :auto], with the reason at the setting (quoted below), and the file's header line listing what the full gate runs now names the two stages. No threshold moves.No package version change and no changelog fragment:
changelog.d/README.mdexcludes "quality gate, CI, or agent tooling changes".The reason comment, quoted
Gate change justification
This repository treats gate settings as decisions, each carrying its reason at the setting (CLAUDE.md, Conventions), and holds moving a threshold for the operator (
.claude/wurk/commit.md, "Gate thresholds are a human's call"). This change moves no number: it enables two stages, and the reason sits beside them. Enabling these two docs stages is authorized by the operator's standing consent for this work, relayed verbatim to the agent that made the change.mix.lock and mix.exs diff
git diff --stat (against main at 7c51d40)
Gate
Full
mix qualityon the committed tree, quoted whole (the dependency compile lines come first because the worktree was fresh). Docs and Doc links are both reported as run and passing, not skipped; the two skipped stages are the repo's two permanent ones (Gettext, Sobelow), declared ingate.not_applicable_skips.mix quality.verifythen attested a second full run on the same tree: "Full gate green: scope all, no profile, 11 stages considered."The Doc links stage reported no finding on main's docs, so no link fix was needed in this PR; the README and guide fixes landed earlier in 7c51d40.
Review (in-turn)
I re-read the diff against the bead and its notes. Each acceptance criterion: the requirement is
~> 0.15withonly: :dev, runtime: falseunchanged (mix.exs deps list); mix.lock resolves ex_quality 0.15.0 and the lock diff above moves no other entry;.quality.exscarries both settings atenabled: :autowith the reason comment beside them; the full gate is green with Docs ("No warnings") and Doc links ("9 links checked") both run; no@versionchange and nochangelog.d/file; the diff stat touches only mix.exs, mix.lock and .quality.exs. The reason comment's link rules were checked against the stage table in ex_quality 0.15.0's README (Doc links: "fails on a relative link HexDocs or hex.pm would break") and match the bead's wording.test/packaging_test.exsstays green inside the Tests stage (1,208 of 1,208)..quality.exsis outside the formatter'sinputs, and its existing blank lines between keyword entries are the file's house style, kept.Provenance
.quality.exslists what the full gate runs; it now names the docs build and doc links. This is a comment-only edit in a file the bead already names, so the diff stat is unchanged in file count.