Skip to content

[Docs]: add CI Failures troubleshooting guide for contributors#1259

Open
lishunyang12 wants to merge 2 commits intovllm-project:mainfrom
lishunyang12:cifailure
Open

[Docs]: add CI Failures troubleshooting guide for contributors#1259
lishunyang12 wants to merge 2 commits intovllm-project:mainfrom
lishunyang12:cifailure

Conversation

@lishunyang12
Copy link
Contributor

@lishunyang12 lishunyang12 commented Feb 7, 2026

  • Populated the empty docs/contributing/ci/failures.md stub with a guide for diagnosing and resolving
    CI failures on PRs
    • Covers all 5 CI checks (pre-commit, Build Wheel, DCO, Read the Docs, Buildkite) with platform info and fix commands
    • Includes a step-by-step workflow: identify the check, check for known issues, investigate locally, file an issue or
      fix it
    • Adds a quick-reference table for common failure patterns (ruff errors, DCO, MkDocs, OOM, timeouts, agent lost, etc.)
    • Cross-links to sibling docs (Markers for Tests, Test File Structure)

Signed-off-by: lishunyang <lishunyang12@163.com>
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 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".

| 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. |

Choose a reason for hiding this comment

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

P2 Badge 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 👍 / 👎.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Solved.

Signed-off-by: lishunyang <lishunyang12@163.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant