Repository navigation
Enables the README stage at error - #254
Merged
Merged
Conversation
The ex_quality dev dependency moves to ~> 0.16 (mix.lock resolves 0.16.0 from Hex), and .quality.exs gains readme: [enabled: :auto, severity: :error], so a README that loses a part of the introduction or map fails the gate. The stage passes on the current README with no wording change. The .quality.exs header and CLAUDE.md name the new stage and the new floor. docs/reference/ast.md joins the package files, and the README links it relatively like its siblings instead of by an absolute GitHub URL. Without the files entry the Doc links stage reports the link as not packaged, so the two changes go together. No lib/ change. Documentation and gate only: no changelog fragment. Refs: px-so77
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
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.
What
ex_qualitydev dependency:~> 0.15to~> 0.16;mix.lockresolves 0.16.0 from Hex (dev only, no runtime requirement moves)..quality.exs:readme: [enabled: :auto, severity: :error], with a comment saying what the stage checks and that findings fail the gate; the header comment lists the stage.mix.exs:docs/reference/ast.mdjoins the packagefiles:(it was already a docs extra in the Reference group).README.md: the AST reference link is relative, like its siblings.CLAUDE.md: the stated floor reads~> 0.16.No
lib/change; no version bump, tag or publish. No changelog fragment: quality gate and documentation only, as the earlier commit that added the analysing-expressions guide to the package files did.Checks
mix qualityis green on the committed tree: the README stage runs at error ("114 lines, every part present", under the 250-line ceiling in.claude/diataxis.md), Doc links checks 58 links, 3,043 tests pass. The commit was made from the tree the second green run covered, with the gate lock and a machine slot held throughout.files:entry fordocs/reference/ast.mdturns Doc links red (readme_not_packagedfor the README link at line 81); the file was restored byte-equal and the gate re-run green.origin/main.Direction check
Each claim was verified on main at c862342: the old floor was
~> 0.15inmix.exs(thedepslist) and in the CLAUDE.md "When a stage fails" paragraph;.quality.exshad noreadmekey;docs/reference/ast.mdwas indocs()extras and the Reference group but not inpackage()files; the README linked it by absolute URL. The stage's check list comes from the ex_quality 0.16.0 README stage, as observed in the gate output. Themix.exspackage comment (README-linked files must be in bothfiles:and extras) holds for the new entry.Provenance
docs/contributing.mddescribes the gate without naming stages or a floor; the plan documents underdocs/plans/are dated history and left alone.