[doc] improve ci doc by reidliu41 · Pull Request #19307 · vllm-project/vllm (original) (raw)
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. Using Gemini Code Assist
- Replaced inline
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. ↩