[doc] improve ci doc #19307
[doc] improve ci doc #19307
Conversation
Signed-off-by: reidliu41 <reid201711@gmail.com>
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
There was a problem hiding this comment.
Hello @reidliu41, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
Hello team, Gemini here with a summary of this pull request. This PR aims to improve the documentation around handling CI failures by introducing dedicated bash scripts for common debugging tasks and updating the ci-failures.md document to reference these new scripts. Specifically, it adds scripts for cleaning CI logs (stripping timestamps and color codes) and for repeatedly rerunning a specific test. The documentation is updated to guide users to use these scripts instead of inline commands and also adds a link to the wl-clipboard tool, addressing the point that it's not installed by default.
Highlights
- Documentation Improvement: Updates the
docs/contributing/ci-failures.mdfile to provide clearer instructions for debugging CI failures. - New Utility Scripts: Introduces two new bash scripts in
.buildkite/scripts/: one for cleaning CI logs (ci-clean-log.sh) and one for rerunning specific tests (rerun-test.sh). - Script Relocation: Moves the logic for cleaning logs and rerunning tests into dedicated, version-controlled scripts within the
.buildkite/scriptsdirectory. - External Tool Mention: Adds a link to the
wl-clipboardtool in the documentation, acknowledging that it might not be installed by default.
Changelog
- .buildkite/scripts/ci-clean-log.sh
- Added a new bash script to strip timestamps and color codes from a given log file using
sed.
- Added a new bash script to strip timestamps and color codes from a given log file using
- .buildkite/scripts/rerun-test.sh
- Added a new bash script to repeatedly run a specified
pytesttest until it passes.
- Added a new bash script to repeatedly run a specified
- docs/contributing/ci-failures.md
- Replaced inline
sedcommands for log cleaning with a reference to the newci-clean-log.shscript. - Replaced the inline bash loop for rerunning tests with a reference to the new
rerun-test.shscript. - Added a link to the
wl-clipboardtool.
- Replaced inline
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request improves the CI failure documentation by introducing helper scripts for common tasks like cleaning log files and rerunning tests, and by adding a helpful link for wl-copy. These changes make the documentation more user-friendly and the CI debugging process potentially smoother. The introduction of dedicated scripts is a good step towards better organization.
I've found a couple of issues in the documentation update that need addressing, primarily an incorrect script reference and a script name mismatch in an example command.
Summary of Findings
- Incorrect Script Link in Documentation: In
docs/contributing/ci-failures.md, the section for rerunning tests incorrectly links to theci-clean-log.shscript via the<gh-file>tag instead of thererun-test.shscript. This was flagged as ahighseverity issue and a review comment was added. - Script Naming Inconsistency in Documentation Example: The example command in
docs/contributing/ci-failures.mdforrerun-test.shusesrerun_test.sh(with an underscore), while the actual script is namedrerun-test.sh(with a hyphen). This could lead to user error. This was flagged as amediumseverity issue and a review comment was added. - Bash Script Robustness: The new bash scripts (
.buildkite/scripts/ci-clean-log.sh,.buildkite/scripts/rerun-test.sh) could be made more robust by addingset -euo pipefailat the beginning. This is alowseverity suggestion and was not commented on directly due to review settings. - Usage Comment Inconsistency in Scripts: The static usage comments within the bash scripts (
ci-clean-log.shline 2,rerun-test.shline 3) use filenames with underscores (e.g.,ci_clean_log.sh), while the actual script files are named with hyphens (e.g.,ci-clean-log.sh). While the dynamic$0in error messages will be correct, these static comments are misleading. This is alowseverity suggestion and was not commented on directly due to review settings.
Merge Readiness
The pull request introduces valuable improvements to the CI documentation. However, there is a high severity issue (incorrect script link) and a medium severity issue (script name mismatch in an example) that should be addressed before merging to ensure the documentation is accurate and helpful. Once these changes are made, the PR should be in good shape. As a reviewer, I am not authorized to approve the pull request; please ensure further review and approval from authorized maintainers.
Signed-off-by: reidliu41 <reid201711@gmail.com>
Essential Elements of an Effective PR Description Checklist
Purpose
.buildkite/scriptsto manageTest Plan
Test Result