feat: add README tree drift check and wire into CI#5
Merged
Conversation
what: create scripts/check-readme-tree.py that parses the ## Repo Layout tree from README.md, extracts file paths, and compares against git ls-files why: the manually maintained repo tree in README silently drifts when files are added or removed; this check prevents that - Parses ASCII tree format tracking directory depth via indentation - Handles wildcard entries (*.md) by globbing the corresponding directory - Flags files in the tree but not tracked (stale) and tracked but not in tree (omitted) - Added scripts/check-version-consistency.py and scripts/check-readme-tree.py to README tree - Wired check-readme-tree.py into CI and validate-ci.py required commands
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.
Changes
Add a script that prevents the README's repo-layout tree from silently drifting when files are added or removed.
scripts/check-readme-tree.py— parses the## Repo Layouttree section from README.md, extracts file paths by tracking directory depth from ASCII tree indentation, resolves wildcard entries (*.md) by globbing the directory, and compares againstgit ls-filesscripts/check-version-consistency.pyandscripts/check-readme-tree.pyto the README tree (were missing after PR feat: add version metadata, consistency checker, and portability self-test #4)Verification