Skip to content

Improve docs clear command to remove ignored files#18949

Merged
harupy merged 1 commit intomlflow:masterfrom
harupy:docs/improve-clear-command
Nov 21, 2025
Merged

Improve docs clear command to remove ignored files#18949
harupy merged 1 commit intomlflow:masterfrom
harupy:docs/improve-clear-command

Conversation

@harupy
Copy link
Member

@harupy harupy commented Nov 21, 2025

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Updated the npm clear command in docs/package.json to use git clean -Xdf docs/ to automatically remove all ignored files in the docs directory. This prevents conflicts with the Docusaurus redirect plugin caused by stale generated files like *-ipynb.mdx and .DS_Store files.

How is this PR tested?

  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

Update the npm clear command to use git clean -Xdf to remove all ignored
files in the docs/ directory. This prevents conflicts with the Docusaurus
redirect plugin caused by stale generated files like *-ipynb.mdx and
.DS_Store files.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
@github-actions
Copy link
Contributor

@harupy Thank you for the contribution! Could you fix the following issue(s)?

⚠ Invalid PR template

This PR does not appear to have been filed using the MLflow PR template. Please copy the PR template from here and fill it out.

"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"clear": "docusaurus clear && git clean -Xdf docs/",
Copy link
Member Author

Choose a reason for hiding this comment

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

I lost an hour due to an ignored .mdx file generated from conflicting with the redirect plugin...

@harupy harupy requested a review from daniellok-db November 21, 2025 07:02
@github-actions
Copy link
Contributor

Documentation preview for 4cc633f is available at:

More info
  • Ignore this comment if this PR does not change the documentation.
  • The preview is updated when a new commit is pushed to this PR.
  • This comment was created by this workflow run.
  • The documentation was built by this workflow run.

@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Nov 21, 2025
@harupy harupy added the team-review Trigger a team review request label Nov 21, 2025
Copy link
Member

@kevin-lyn kevin-lyn left a comment

Choose a reason for hiding this comment

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

LGTM

@harupy harupy added this pull request to the merge queue Nov 21, 2025
Merged via the queue into mlflow:master with commit b444515 Nov 21, 2025
63 of 67 checks passed
@harupy harupy deleted the docs/improve-clear-command branch November 21, 2025 08:49
kevin-wangg pushed a commit to kevin-wangg/mlflow that referenced this pull request Nov 21, 2025
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>
Signed-off-by: Kevin Wang <kevinwang2040@gmail.com>
jimilp7 pushed a commit to backspace-org/mlflow that referenced this pull request Nov 21, 2025
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>
Tian-Sky-Lan pushed a commit to Tian-Sky-Lan/mlflow that referenced this pull request Nov 24, 2025
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>
Signed-off-by: Tian Lan <sky.blue266000@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation issues rn/none List under Small Changes in Changelogs. team-review Trigger a team review request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants