[Docs]: add CI Failures troubleshooting guide for contributors#1259
[Docs]: add CI Failures troubleshooting guide for contributors#1259lishunyang12 wants to merge 2 commits intovllm-project:mainfrom
Conversation
Signed-off-by: lishunyang <lishunyang12@163.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 90d780a1b5
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
docs/contributing/ci/failures.md
Outdated
| | Check | Platform | What it does | | ||
| | ----- | -------- | ------------ | | ||
| | **pre-commit** | GitHub Actions | Runs linting (Ruff), formatting, spell-checking (typos), and YAML validation. | | ||
| | **Build Wheel** | GitHub Actions | Builds Python wheels for Python 3.11 and 3.12 on Ubuntu. | |
There was a problem hiding this comment.
Correct Build Wheel trigger description
This row says Build Wheel is one of the checks that run automatically on PRs, but the workflow currently skips docs/markdown-only changes via paths-ignore in .github/workflows/build_wheel.yml (pull request trigger lines 20-26), so contributors following this guide can be confused when the check never appears for documentation PRs. Please clarify that Build Wheel is conditional on changed paths rather than always present.
Useful? React with 👍 / 👎.
Signed-off-by: lishunyang <lishunyang12@163.com>
docs/contributing/ci/failures.mdstub with a guide for diagnosing and resolvingCI failures on PRs
fix it