fix: clear stale enriched docs before docs build#1128
Merged
makhnatkin merged 1 commit intoci/docs-extensionsfrom May 6, 2026
Merged
fix: clear stale enriched docs before docs build#1128makhnatkin merged 1 commit intoci/docs-extensionsfrom
makhnatkin merged 1 commit intoci/docs-extensionsfrom
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a pre-build cleanup step to remove stale enriched documentation artifacts before running the docs generation pipeline. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider using
path.join(DOCS_GEN_DIR, 'enriched')instead of string concatenation forenrichedDirto avoid potential path issues across platforms. - If other steps may introduce additional stale subdirectories under
DOCS_GEN_DIRin the future, it might be more robust to generalizeclearEnrichedDocs(e.g., aclearStaleDocshelper) so similar cleanup logic can be reused.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider using `path.join(DOCS_GEN_DIR, 'enriched')` instead of string concatenation for `enrichedDir` to avoid potential path issues across platforms.
- If other steps may introduce additional stale subdirectories under `DOCS_GEN_DIR` in the future, it might be more robust to generalize `clearEnrichedDocs` (e.g., a `clearStaleDocs` helper) so similar cleanup logic can be reused.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Summary by Sourcery
Bug Fixes: