[1/N][CI] Move linting system to pre-commits hooks #1256

Potabk · 2025-06-17T07:06:45Z

What this PR does / why we need it?

Follow vllm-project/vllm lint way: https://github.com/vllm-project/vllm/blob/main/.pre-commit-config.yaml

Enable pre-commit to avoid some low level error AMAP.

This pr is one step of #1241, The purpose is make linting system more clear and convenient, on this step, Mainly did the following things: yapf, actionlint, ruff, typos, isort, mypy, png-lint, signoff-commit, enforce-import-regex-instead-of-re.

TODO:

clang-format(check for csrc with google style)
need clean code, disable for now
pymarkdown
need clean code, disable for now
shellcheck
need clean code, disable for now

Does this PR introduce any user-facing change?

Only developer UX change:
https://vllm-ascend--1256.org.readthedocs.build/en/1256/developer_guide/contributing.html#run-lint-locally

pip install -r requirements-lint.txt && pre-commit install
bash format.sh

How was this patch tested?

CI passed with new added/existing test.

Co-authored-by: Yikun yikunkero@gmail.com
Co-authored-by: wangli wangli858794774@gmail.com

vLLM version: v0.9.1
vLLM main: vllm-project/vllm@5358cce

Potabk · 2025-06-18T02:34:38Z

cc @Yikun @wangxiyuan

github-actions · 2025-06-19T15:14:26Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Yikun · 2025-06-19T16:41:28Z

c8bb90f

Update format.sh to have two cmd format.sh and format.sh ci
Update the vllm-ascend doc
Add some note

After consideration, I didn't add mypy lint to format.sh, but added format.sh ci

Yikun · 2025-06-19T16:42:22Z

Need a rebase after #1293 resolved

Yikun · 2025-06-19T16:55:15Z

.github/workflows/vllm_ascend_test.yaml

 name: 'test'

 on:
-  schedule:


Why we remove the schedule here?

Ok, currently this is a per PR check, we can enable push trigger in future

github-actions · 2025-06-20T16:04:24Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

codecov · 2025-06-25T10:43:17Z

Codecov Report

❌ Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 54.48%. Comparing base (c30ddb8) to head (82053fe).
⚠️ Report is 613 commits behind head on main.

Files with missing lines	Patch %	Lines
vllm_ascend/ops/fused_moe.py	0.00%	4 Missing ⚠️
vllm_ascend/ops/vocab_parallel_embedding.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #1256       +/-   ##
===========================================
+ Coverage   27.39%   54.48%   +27.09%     
===========================================
  Files          56       79       +23     
  Lines        6191     9925     +3734     
===========================================
+ Hits         1696     5408     +3712     
- Misses       4495     4517       +22

Flag	Coverage Δ
unittests	`54.48% <0.00%> (+27.09%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Potabk · 2025-06-25T14:23:28Z

since we have new linting sys(typos), we don't need doc_codespell

Potabk · 2025-06-25T14:25:39Z

will enable clang-format, pymarkdown, shellcheck in the next step

github-actions · 2025-06-28T08:13:03Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

format.sh

Signed-off-by: wangli <wangli858794774@gmail.com>

wangxiyuan · 2025-07-10T06:16:46Z

.github/workflows/doc_codespell.yaml

@@ -1,33 +0,0 @@
-


doc change won't track lint check. This should not be removed. Or we need find another way. I'll do it in the next PR.

### What this PR does / why we need it? Follow vllm-project/vllm lint way: https://github.com/vllm-project/vllm/blob/main/.pre-commit-config.yaml Enable pre-commit to avoid some low level error AMAP. This pr is one step of vllm-project#1241, The purpose is make linting system more clear and convenient, on this step, Mainly did the following things: yapf, actionlint, ruff, typos, isort, mypy, png-lint, signoff-commit, enforce-import-regex-instead-of-re. TODO: - clang-format(check for csrc with google style) need clean code, disable for now - pymarkdown need clean code, disable for now - shellcheck need clean code, disable for now ### Does this PR introduce _any_ user-facing change? Only developer UX change: https://vllm-ascend--1256.org.readthedocs.build/en/1256/developer_guide/contributing.html#run-lint-locally ``` pip install -r requirements-lint.txt && pre-commit install bash format.sh ``` ### How was this patch tested? CI passed with new added/existing test. Co-authored-by: Yikun [yikunkero@gmail.com](mailto:yikunkero@gmail.com) Co-authored-by: wangli [wangli858794774@gmail.com](mailto:wangli858794774@gmail.com) - vLLM version: v0.9.1 - vLLM main: vllm-project/vllm@5358cce --------- Signed-off-by: wangli <wangli858794774@gmail.com>

github-actions bot added documentation Improvements or additions to documentation ci/build module:tests module:ops module:tools and removed documentation Improvements or additions to documentation module:tests module:ops labels Jun 17, 2025

Potabk force-pushed the lint-2 branch 2 times, most recently from 3313968 to b6b8bf3 Compare June 17, 2025 09:08

github-actions bot added documentation Improvements or additions to documentation module:tests module:ops labels Jun 17, 2025

Potabk force-pushed the lint-2 branch 2 times, most recently from 0ff0fa9 to e196c98 Compare June 18, 2025 01:35

github-actions bot added the merge-conflicts label Jun 19, 2025

Yikun force-pushed the lint-2 branch from 03fbbbe to 55f482a Compare June 19, 2025 15:26

github-actions bot removed the merge-conflicts label Jun 19, 2025

Yikun force-pushed the lint-2 branch from 55f482a to c8bb90f Compare June 19, 2025 16:36

Yikun force-pushed the lint-2 branch from c8bb90f to 11672c6 Compare June 19, 2025 17:03

Yikun reviewed Jun 19, 2025

View reviewed changes

Yikun approved these changes Jun 20, 2025

View reviewed changes

Yikun added the ready read for review label Jun 20, 2025

github-actions bot added merge-conflicts and removed ready read for review labels Jun 20, 2025

wangxiyuan approved these changes Jun 24, 2025

View reviewed changes

Yikun force-pushed the lint-2 branch from 11672c6 to 36e6d42 Compare June 25, 2025 10:28

github-actions bot removed the merge-conflicts label Jun 25, 2025

Yikun force-pushed the lint-2 branch 2 times, most recently from c1f868a to 9b07f5e Compare June 25, 2025 12:17

Yikun mentioned this pull request Jun 28, 2025

[RFC]: Doc enhancement #1248

Open

40 tasks

github-actions bot added the merge-conflicts label Jun 28, 2025

Potabk force-pushed the lint-2 branch from 1ca0957 to a5c23b9 Compare July 8, 2025 07:01

github-actions bot removed the merge-conflicts label Jul 8, 2025

Yikun reviewed Jul 8, 2025

View reviewed changes

format.sh Outdated Show resolved Hide resolved

Potabk added 8 commits July 9, 2025 15:04

format code

de63183

Signed-off-by: wangli <wangli858794774@gmail.com>

rebase

2d0a4cc

Signed-off-by: wangli <wangli858794774@gmail.com>

rm shell check

0bf21f1

Signed-off-by: wangli <wangli858794774@gmail.com>

add pr trigger

eaa57af

Signed-off-by: wangli <wangli858794774@gmail.com>

fix format

777c1a0

Signed-off-by: wangli <wangli858794774@gmail.com>

change mypy version

319955c

Signed-off-by: wangli <wangli858794774@gmail.com>

fix

816bc2d

Signed-off-by: wangli <wangli858794774@gmail.com>

rm tab

f93b215

Signed-off-by: wangli <wangli858794774@gmail.com>

Potabk force-pushed the lint-2 branch from 3a4a3b7 to f93b215 Compare July 9, 2025 07:15

trigger ci

82053fe

Signed-off-by: wangli <wangli858794774@gmail.com>

wangxiyuan approved these changes Jul 10, 2025

View reviewed changes

wangxiyuan merged commit c744643 into vllm-project:main Jul 10, 2025
21 checks passed

[1/N][CI] Move linting system to pre-commits hooks #1256

[1/N][CI] Move linting system to pre-commits hooks #1256

Uh oh!

Conversation

Potabk commented Jun 17, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it?

Does this PR introduce any user-facing change?

How was this patch tested?

Uh oh!

Potabk commented Jun 18, 2025

Uh oh!

github-actions bot commented Jun 19, 2025

Uh oh!

Yikun commented Jun 19, 2025

Uh oh!

Yikun commented Jun 19, 2025

Uh oh!

Yikun Jun 19, 2025

Choose a reason for hiding this comment

Uh oh!

Yikun Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 20, 2025

Uh oh!

codecov bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Potabk commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Potabk commented Jun 25, 2025

Uh oh!

github-actions bot commented Jun 28, 2025

Uh oh!

Uh oh!

wangxiyuan Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Potabk commented Jun 17, 2025 •

edited by github-actions bot

Loading

codecov bot commented Jun 25, 2025 •

edited

Loading

Potabk commented Jun 25, 2025 •

edited

Loading