Skip to content

Commit 6e4bef1

Browse files
authored
[Doc] Remove extra whitespace from CI failures doc (#20565)
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
1 parent 4ff79a1 commit 6e4bef1

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

docs/contributing/ci-failures.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ the failure?
66
- Check the dashboard of current CI test failures:
77
👉 [CI Failures Dashboard](https://github.com/orgs/vllm-project/projects/20)
88

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.
1212
- React with a 👍 to signal how many are affected.
1313

1414
- If your failure **is not listed**, you should **file an issue**.
@@ -19,43 +19,43 @@ the failure?
1919
👉 [New CI Failure Report](https://github.com/vllm-project/vllm/issues/new?template=450-ci-failure.yml)
2020

2121
- **Use this title format:**
22-
22+
2323
```
2424
[CI Failure]: failing-test-job - regex/matching/failing:test
2525
```
2626
2727
- **For the environment field:**
28-
28+
2929
```
3030
Still failing on main as of commit abcdef123
3131
```
3232
3333
- **In the description, include failing tests:**
34-
34+
3535
```
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
4141
```
4242
4343
- **Attach logs** (collapsible section example):
4444
<details>
4545
<summary>Logs:</summary>
4646
4747
```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
4949
--- Logging error ---
5050
Traceback (most recent call last):
5151
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)
5353
...
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
5757
```
58-
58+
5959
</details>
6060
6161
## Logs Wrangling
@@ -78,7 +78,7 @@ tail -525 ci_build.log | wl-copy
7878

7979
## Investigating a CI Test Failure
8080

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)
8282
2. Bisect to find the first build that shows the issue.
8383
3. Add your findings to the GitHub issue.
8484
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:
9797

9898
If you submit a PR to fix a CI failure:
9999

100-
- Link the PR to the issue:
100+
- Link the PR to the issue:
101101
Add `Closes #12345` to the PR description.
102-
- Add the `ci-failure` label:
102+
- Add the `ci-failure` label:
103103
This helps track it in the [CI Failures GitHub Project](https://github.com/orgs/vllm-project/projects/20).
104104

105105
## Other Resources

0 commit comments

Comments
 (0)