feat: support excluded documentation paths - #4
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds repository-configured documentation exclusion paths so validate-docs can skip generated/vendored trees (e.g., ui/node_modules) while walking Markdown files, without changing default behavior when no exclusions are configured.
Changes:
- Added
docs.exclude_pathsto repository policy configuration and applied it during theWalkDirtraversal invalidate_docs. - Implemented
is_excluded()to match exact directories and child paths against configured exclusions. - Documented the new policy key in
README.mdand added unit coverage for exclusion behavior.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/repository_checks.rs | Adds docs.exclude_paths handling to validate_docs, implements exclusion matching, and introduces unit tests. |
| README.md | Documents docs.exclude_paths in the repository policy example and explains intended usage. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+426
to
+430
| #[cfg(test)] | ||
| mod tests { | ||
| use super::is_excluded; | ||
| use std::path::Path; | ||
|
|
Comment on lines
+434
to
+438
| assert!(is_excluded( | ||
| root, | ||
| Path::new("/repo/ui/node_modules/pkg/readme.md"), | ||
| &["ui/node_modules".into()] | ||
| )); |
Comment on lines
+95
to
+96
| Use `docs.exclude_paths` for generated or vendored trees that are not | ||
| repository-owned Markdown. |
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 #3
Summary
docs.exclude_pathsto repository policyVerification
cargo fmt --checkcargo test --lockedgit diff --check