Unverified Commit 6e4bef1b authored by Harry Mellor's avatar Harry Mellor Committed by GitHub
Browse files

[Doc] Remove extra whitespace from CI failures doc (#20565)


Signed-off-by: default avatarHarry Mellor <19981378+hmellor@users.noreply.github.com>
parent 4ff79a13
...@@ -6,9 +6,9 @@ the failure? ...@@ -6,9 +6,9 @@ the failure?
- Check the dashboard of current CI test failures: - Check the dashboard of current CI test failures:
👉 [CI Failures Dashboard](https://github.com/orgs/vllm-project/projects/20) 👉 [CI Failures Dashboard](https://github.com/orgs/vllm-project/projects/20)
- If your failure **is already listed**, it's likely unrelated to your PR. - If your failure **is already listed**, it's likely unrelated to your PR.
Help fixing it is always welcome! Help fixing it is always welcome!
- Leave comments with links to additional instances of the failure. - Leave comments with links to additional instances of the failure.
- React with a 👍 to signal how many are affected. - React with a 👍 to signal how many are affected.
- If your failure **is not listed**, you should **file an issue**. - If your failure **is not listed**, you should **file an issue**.
...@@ -19,25 +19,25 @@ the failure? ...@@ -19,25 +19,25 @@ the failure?
👉 [New CI Failure Report](https://github.com/vllm-project/vllm/issues/new?template=450-ci-failure.yml) 👉 [New CI Failure Report](https://github.com/vllm-project/vllm/issues/new?template=450-ci-failure.yml)
- **Use this title format:** - **Use this title format:**
``` ```
[CI Failure]: failing-test-job - regex/matching/failing:test [CI Failure]: failing-test-job - regex/matching/failing:test
``` ```
- **For the environment field:** - **For the environment field:**
``` ```
Still failing on main as of commit abcdef123 Still failing on main as of commit abcdef123
``` ```
- **In the description, include failing tests:** - **In the description, include failing tests:**
``` ```
FAILED failing/test.py:failing_test1 - Failure description FAILED failing/test.py:failing_test1 - Failure description
FAILED failing/test.py:failing_test2 - Failure description FAILED failing/test.py:failing_test2 - Failure description
https://github.com/orgs/vllm-project/projects/20 https://github.com/orgs/vllm-project/projects/20
https://github.com/vllm-project/vllm/issues/new?template=400-bug-report.yml https://github.com/vllm-project/vllm/issues/new?template=400-bug-report.yml
FAILED failing/test.py:failing_test3 - Failure description FAILED failing/test.py:failing_test3 - Failure description
``` ```
- **Attach logs** (collapsible section example): - **Attach logs** (collapsible section example):
...@@ -45,17 +45,17 @@ the failure? ...@@ -45,17 +45,17 @@ the failure?
<summary>Logs:</summary> <summary>Logs:</summary>
```text ```text
ERROR 05-20 03:26:38 [dump_input.py:68] Dumping input data ERROR 05-20 03:26:38 [dump_input.py:68] Dumping input data
--- Logging error --- --- Logging error ---
Traceback (most recent call last): Traceback (most recent call last):
File "/usr/local/lib/python3.12/dist-packages/vllm/v1/engine/core.py", line 203, in execute_model File "/usr/local/lib/python3.12/dist-packages/vllm/v1/engine/core.py", line 203, in execute_model
return self.model_executor.execute_model(scheduler_output) return self.model_executor.execute_model(scheduler_output)
... ...
FAILED failing/test.py:failing_test1 - Failure description FAILED failing/test.py:failing_test1 - Failure description
FAILED failing/test.py:failing_test2 - Failure description FAILED failing/test.py:failing_test2 - Failure description
FAILED failing/test.py:failing_test3 - Failure description FAILED failing/test.py:failing_test3 - Failure description
``` ```
</details> </details>
## Logs Wrangling ## Logs Wrangling
...@@ -78,7 +78,7 @@ tail -525 ci_build.log | wl-copy ...@@ -78,7 +78,7 @@ tail -525 ci_build.log | wl-copy
## Investigating a CI Test Failure ## Investigating a CI Test Failure
1. Go to 👉 [Buildkite main branch](https://buildkite.com/vllm/ci/builds?branch=main) 1. Go to 👉 [Buildkite main branch](https://buildkite.com/vllm/ci/builds?branch=main)
2. Bisect to find the first build that shows the issue. 2. Bisect to find the first build that shows the issue.
3. Add your findings to the GitHub issue. 3. Add your findings to the GitHub issue.
4. If you find a strong candidate PR, mention it in the issue and ping contributors. 4. If you find a strong candidate PR, mention it in the issue and ping contributors.
...@@ -97,9 +97,9 @@ CI test failures may be flaky. Use a bash loop to run repeatedly: ...@@ -97,9 +97,9 @@ CI test failures may be flaky. Use a bash loop to run repeatedly:
If you submit a PR to fix a CI failure: If you submit a PR to fix a CI failure:
- Link the PR to the issue: - Link the PR to the issue:
Add `Closes #12345` to the PR description. Add `Closes #12345` to the PR description.
- Add the `ci-failure` label: - Add the `ci-failure` label:
This helps track it in the [CI Failures GitHub Project](https://github.com/orgs/vllm-project/projects/20). This helps track it in the [CI Failures GitHub Project](https://github.com/orgs/vllm-project/projects/20).
## Other Resources ## Other Resources
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment