A high-throughput and memory-efficient inference and serving engine for LLMs
Mirrored from https://github.com/tduncan-lum/Nvidia-Optimization-Stack---VLLM.git
Synced Nov 15, 03:30 UTC
[Doc] Remove extra whitespace from CI failures doc (#20565)
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Harry Mellor committed
Jul 7, 2025 at 11:35 UTC
6e4bef1bea89c06100699bad4d4ad27ef0519e7f
1 file changed
+20
-20
docs/contributing/ci-failures.md
+20
-20
@@ -6,9 +6,9 @@ the failure?
6
- Check the dashboard of current CI test failures:
7
👉 [CI Failures Dashboard](https://github.com/orgs/vllm-project/projects/20)
8
9
-- If your failure **is already listed**, it's likely unrelated to your PR.
10
- Help fixing it is always welcome!
11
- - Leave comments with links to additional instances of the failure.
9
+- If your failure **is already listed**, it's likely unrelated to your PR.
10
+ Help fixing it is always welcome!
11
+ - Leave comments with links to additional instances of the failure.
12
- React with a 👍 to signal how many are affected.
13
14
- If your failure **is not listed**, you should **file an issue**.
@@ -19,25 +19,25 @@ the failure?
19
👉 [New CI Failure Report](https://github.com/vllm-project/vllm/issues/new?template=450-ci-failure.yml)
20
21
- **Use this title format:**
22
-
22
+
23
```
24
[CI Failure]: failing-test-job - regex/matching/failing:test
25
```
26
27
- **For the environment field:**
28
-
28
+
29
```
30
Still failing on main as of commit abcdef123
31
```
32
33
- **In the description, include failing tests:**
34
-
34
+
35
```
36
- FAILED failing/test.py:failing_test1 - Failure description
37
- FAILED failing/test.py:failing_test2 - Failure description
38
- https://github.com/orgs/vllm-project/projects/20
39
- https://github.com/vllm-project/vllm/issues/new?template=400-bug-report.yml
40
- FAILED failing/test.py:failing_test3 - Failure description
36
+ FAILED failing/test.py:failing_test1 - Failure description
37
+ FAILED failing/test.py:failing_test2 - Failure description
38
+ https://github.com/orgs/vllm-project/projects/20
39
+ https://github.com/vllm-project/vllm/issues/new?template=400-bug-report.yml
40
+ FAILED failing/test.py:failing_test3 - Failure description
41
```
42
43
- **Attach logs** (collapsible section example):
@@ -45,17 +45,17 @@ the failure?
45
<summary>Logs:</summary>
46
47
```text
48
- ERROR 05-20 03:26:38 [dump_input.py:68] Dumping input data
48
+ ERROR 05-20 03:26:38 [dump_input.py:68] Dumping input data
49
--- Logging error ---
50
Traceback (most recent call last):
51
File "/usr/local/lib/python3.12/dist-packages/vllm/v1/engine/core.py", line 203, in execute_model
52
- return self.model_executor.execute_model(scheduler_output)
52
+ return self.model_executor.execute_model(scheduler_output)
53
...
54
- FAILED failing/test.py:failing_test1 - Failure description
55
- FAILED failing/test.py:failing_test2 - Failure description
56
- FAILED failing/test.py:failing_test3 - Failure description
54
+ FAILED failing/test.py:failing_test1 - Failure description
55
+ FAILED failing/test.py:failing_test2 - Failure description
56
+ FAILED failing/test.py:failing_test3 - Failure description
57
```
58
-
58
+
59
</details>
60
61
## Logs Wrangling
@@ -78,7 +78,7 @@ tail -525 ci_build.log | wl-copy
78
79
## Investigating a CI Test Failure
80
81
-1. Go to 👉 [Buildkite main branch](https://buildkite.com/vllm/ci/builds?branch=main)
81
+1. Go to 👉 [Buildkite main branch](https://buildkite.com/vllm/ci/builds?branch=main)
82
2. Bisect to find the first build that shows the issue.
83
3. Add your findings to the GitHub issue.
84
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
98
If you submit a PR to fix a CI failure:
99
100
-- Link the PR to the issue:
100
+- Link the PR to the issue:
101
Add `Closes #12345` to the PR description.
102
-- Add the `ci-failure` label:
102
+- Add the `ci-failure` label:
103
This helps track it in the [CI Failures GitHub Project](https://github.com/orgs/vllm-project/projects/20).
104
105
## Other Resources