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] Add markdown linter #11857

Merged
merged 17 commits into from
Jan 12, 2025
Merged

Conversation

rafvasq
Copy link
Contributor

@rafvasq rafvasq commented Jan 8, 2025

As a follow up to #10427 and related to #10366, this PR introduces markdown linting.

Rules currently modified in pyproject.toml:

Copy link

github-actions bot commented Jan 8, 2025

👋 Hi! Thank you for contributing to the vLLM project.
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 do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@mergify mergify bot added ci/build documentation Improvements or additions to documentation labels Jan 8, 2025
@rafvasq rafvasq marked this pull request as ready for review January 8, 2025 22:22
@DarkLight1337
Copy link
Member

Is it possible to add this to format.sh so we can run this locally as well?

Copy link

mergify bot commented Jan 9, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @rafvasq.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

Copy link

mergify bot commented Jan 9, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @rafvasq.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Jan 9, 2025
rafvasq added 11 commits January 9, 2025 14:57
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
@mergify mergify bot removed the needs-rebase label Jan 9, 2025
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq
Copy link
Contributor Author

rafvasq commented Jan 9, 2025

@DarkLight1337 I've made some changes to a python-based linter so it's a more seamless change, similar to how sphinx-lint was being used before.

Copy link

mergify bot commented Jan 10, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @rafvasq.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Jan 10, 2025
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
@DarkLight1337
Copy link
Member

Thanks for the cleanup!

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) January 11, 2025 15:28
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jan 11, 2025
@simon-mo simon-mo disabled auto-merge January 12, 2025 08:17
@simon-mo simon-mo merged commit 43f3d9e into vllm-project:main Jan 12, 2025
88 of 92 checks passed
hmellor pushed a commit to hmellor/vllm that referenced this pull request Jan 12, 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