Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CI/Build] Auto-fix Markdown files #12941

Merged
merged 8 commits into from
Feb 8, 2025

Conversation

DarkLight1337
Copy link
Member

@DarkLight1337 DarkLight1337 commented Feb 8, 2025

Update the pre-commit hook for pymarkdown:

  • Use fix command instead of the default scan (source) to automatically fix lint errors
  • Remove the unnecessary docs/ filter so that the lint rules are applied to all Markdown files in the repository.

Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
@DarkLight1337 DarkLight1337 requested a review from hmellor February 8, 2025 06:50
Copy link

github-actions bot commented Feb 8, 2025

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
@mergify mergify bot added documentation Improvements or additions to documentation ci/build labels Feb 8, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
@hmellor hmellor self-assigned this Feb 8, 2025
@hmellor
Copy link
Collaborator

hmellor commented Feb 8, 2025

I tried removing the rule skip and the rocm docs do still render correctly. Maybe we simplify to run pymarkdown just once?

Copy link
Collaborator

@hmellor hmellor left a comment

Choose a reason for hiding this comment

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

I'm ok with whichever you choose, thanks for this improvement!

@DarkLight1337
Copy link
Member Author

I tried removing the rule skip and the rocm docs do still render correctly. Maybe we simplify to run pymarkdown just once?

Let's just run fix then

Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) February 8, 2025 11:42
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Feb 8, 2025
@simon-mo simon-mo merged commit 8a69e0e into vllm-project:main Feb 8, 2025
54 of 71 checks passed
@DarkLight1337 DarkLight1337 deleted the pymarkdown-fix branch February 8, 2025 12:25
AoyuQC pushed a commit to AoyuQC/vllm that referenced this pull request Feb 8, 2025
ShangmingCai pushed a commit to ShangmingCai/vllm that referenced this pull request Feb 10, 2025
SzymonOzog pushed a commit to SzymonOzog/vllm that referenced this pull request Feb 12, 2025
Signed-off-by: SzymonOzog <szymon.ozog@aleph-alpha.com>
panf2333 pushed a commit to yottalabsai/vllm that referenced this pull request Feb 18, 2025
kerthcet pushed a commit to kerthcet/vllm that referenced this pull request Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/build documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants