Skip to content

fix: clear stale enriched docs before docs build#1128

Merged
makhnatkin merged 1 commit intoci/docs-extensionsfrom
codex/pr-1067-build-fix
May 6, 2026
Merged

fix: clear stale enriched docs before docs build#1128
makhnatkin merged 1 commit intoci/docs-extensionsfrom
codex/pr-1067-build-fix

Conversation

@makhnatkin
Copy link
Copy Markdown
Collaborator

@makhnatkin makhnatkin commented May 6, 2026

Summary by Sourcery

Bug Fixes:

  • Remove any existing enriched docs directory before generating documentation to avoid stale content being included in builds.

@makhnatkin makhnatkin requested a review from d3m1d0v as a code owner May 6, 2026 15:39
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 6, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a pre-build cleanup step to remove stale enriched documentation artifacts before running the docs generation pipeline.

File-Level Changes

Change Details Files
Introduce a pre-build cleanup step to remove stale enriched docs before running the docs pipeline.
  • Add clearEnrichedDocs helper that removes the DOCS_GEN_DIR/enriched directory if it exists, logging the operation.
  • Invoke clearEnrichedDocs at the start of runBuild so cleanup happens before generate/extract/assemble steps.
scripts/docs/index.mjs

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@makhnatkin makhnatkin merged commit c65ebba into ci/docs-extensions May 6, 2026
7 of 8 checks passed
@makhnatkin makhnatkin deleted the codex/pr-1067-build-fix branch May 6, 2026 15:40
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • 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.
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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@gravity-ui
Copy link
Copy Markdown

gravity-ui Bot commented May 6, 2026

Storybook Deployed

@gravity-ui
Copy link
Copy Markdown

gravity-ui Bot commented May 6, 2026

🎭 Playwright Report

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant