fix(raycicmd): add skip to commandStepAllowedKeys#332
fix(raycicmd): add skip to commandStepAllowedKeys#332thomasdesr wants to merge 1 commit intomainfrom
Conversation
The skip key is valid in Buildkite command steps but was missing from the allowed keys list, causing pipeline validation to fail with "unsupported step key 'skip'" errors.
Summary of ChangesHello @thomasdesr, 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! This pull request addresses a validation issue in Buildkite pipelines where the "skip" key was incorrectly identified as an unsupported step key. By incorporating "skip" into the list of allowed keys for command steps, the change ensures that pipelines utilizing this valid Buildkite schema element can pass validation without errors, thereby improving the accuracy and robustness of pipeline definition checks. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
There was a problem hiding this comment.
Code Review
This pull request correctly adds the skip key to the list of allowed keys for command steps, fixing a validation issue where pipelines using skip would fail. The change is straightforward and correct. I have added one suggestion to improve code maintainability by sorting the list of keys. With that minor improvement, the change is ready to be merged.
| "command", "commands", "priority", "parallelism", "if", "skip", | ||
| "label", "name", "key", "depends_on", "soft_fail", "matrix", | ||
| "allow_dependency_failure", "concurrency", "concurrency_group", | ||
| "timeout_in_minutes", |
There was a problem hiding this comment.
For better maintainability and readability, consider sorting these keys alphabetically. A sorted list makes it easier to check for the existence of a key and to avoid adding duplicates in the future.
| "command", "commands", "priority", "parallelism", "if", "skip", | |
| "label", "name", "key", "depends_on", "soft_fail", "matrix", | |
| "allow_dependency_failure", "concurrency", "concurrency_group", | |
| "timeout_in_minutes", | |
| "allow_dependency_failure", "command", "commands", "concurrency", "concurrency_group", | |
| "depends_on", "if", "key", "label", "matrix", | |
| "name", "parallelism", "priority", "skip", "soft_fail", | |
| "timeout_in_minutes", |
There was a problem hiding this comment.
Pull request overview
This PR fixes a validation bug by adding the skip key to the list of allowed keys for command steps in the pipeline configuration. The skip key is a valid Buildkite feature but was missing from the validation list, causing false "unsupported step key" errors.
Key Changes:
- Added
skiptocommandStepAllowedKeysarray in pipeline validation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
aslonnie
left a comment
There was a problem hiding this comment.
while this is fine. the common convention for skipping in rayci is to add a disabled tag.
using disabled tag is often better because rayci will actually remove the step and all the steps that depends on that step when performing tag selection operations.
that said, since if is allowed.. so one can always skip with if: "false", which is kind of equivalent.
please add a unit test?
andrew-anyscale
left a comment
There was a problem hiding this comment.
+1 to what's been said here. raycicmd has forked a bit of Buildkite defaults in favor of reducing waste where possible (both compute and Canvas space). This is one of those cases, as we can use tag-based filtering to never have that step appear in the first place
Best way is to use a disabled tag:
- name: hello test
tags: disabled # this will never run
depends_on: hello
job_env: hello
command: cat /opt/app/hello.txt
That said, let us know if there is some functionality that adding skip would enable, and we can figure out best next steps!
Summary
skipto the allowed keys for command steps in pipeline validationskipkey is valid per Buildkite schema but was missing fromcommandStepAllowedKeys, causing "unsupported step key" errorsTest plan
skipkey