Skip to content

feat: allow to add a query-planner-skip label to ignore engine checks#2255

Merged
alepane21 merged 6 commits intomainfrom
ale/eng-8214-add-label-to-skip-query-planner
Oct 3, 2025
Merged

feat: allow to add a query-planner-skip label to ignore engine checks#2255
alepane21 merged 6 commits intomainfrom
ale/eng-8214-add-label-to-skip-query-planner

Conversation

@alepane21
Copy link
Copy Markdown
Contributor

@alepane21 alepane21 commented Oct 2, 2025

Summary by CodeRabbit

  • Chores
    • CI job renamed to "check-labels-and-engine-changes" and unified label/engine-change gating.
    • CI now detects a “query-planner-skip” label and exposes a skip flag (has_skip_label) to skip non-essential jobs.
    • Skip-aware gate propagated across build, test, release, and notification jobs.
    • Conditional checks updated to guard on has_skip_label and standardized boolean output handling; minor workflow formatting cleanup.

Checklist

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 2, 2025

Walkthrough

Renames the CI gating job to check-labels-and-engine-changes, adds a check_label_skip step that exposes has_skip_label, wires that output through dependent jobs' needs/outputs, and updates conditional expressions to skip steps when has_skip_label is 'true'. Minor YAML formatting tweaks.

Changes

Cohort / File(s) Change summary
Workflow gating and downstream wiring
.github/workflows/query-planner-ci.yaml
Renamed job check-label-and-engine-changescheck-labels-and-engine-changes; added check_label_skip step using github-script to detect query-planner-skip and expose has_skip_label; added has_skip_label to job outputs and propagated it to downstream needs/outputs; updated dependent jobs (build-router, build-cli, cli-release-url, build_test, get_pr_url, comment-on-failure, comment-on-success, etc.) to depend on the renamed job; adjusted if conditions to guard with has_skip_label != 'true' and standardized boolean output string checks; minor spacing/quote formatting changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly describes the primary feature introduced by this changeset, namely the ability to use a query-planner-skip label to bypass engine checks, matching both the intent and the modifications in the workflow configuration.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Comment @coderabbitai help to get the list of available commands and usage tips.

@alepane21 alepane21 marked this pull request as ready for review October 2, 2025 09:56
@alepane21 alepane21 requested review from a team as code owners October 2, 2025 09:56
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.github/workflows/query-planner-ci.yaml (1)

156-156: Fix the stale needs reference to the renamed job.

check-label-and-engine-changes no longer exists, so the workflow will fail to even start. Update every needs entry that still uses the old id before merging.

-    needs: [ build-router, build-cli, cli-release-url, check-label-and-engine-changes ]
+    needs: [ build-router, build-cli, cli-release-url, check-labels-and-engine-changes ]
...
-    needs: [ build_test, check-label-and-engine-changes ]
+    needs: [ build_test, check-labels-and-engine-changes ]

Also applies to: 179-179

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 32483b8 and 015701b.

📒 Files selected for processing (1)
  • .github/workflows/query-planner-ci.yaml (9 hunks)
🧰 Additional context used
🪛 actionlint (1.7.7)
.github/workflows/query-planner-ci.yaml

55-55: the runner of "actions/github-script@v6" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)


126-126: input "with_tests" is not defined in action "Build and Push Image (PR only)" defined at "./.github/actions/build-push-image". available inputs are "docker_build_target", "docker_context", "docker_password", "docker_username", "dockerfile", "image_description", "image_name", "image_platforms", "load_Image", "push", "token"

(action)


162-162: property "check-labels-and-engine-changes" is not defined in object type {build-cli: {outputs: {wgc: string}; result: string}; build-router: {outputs: {image_ref: string}; result: string}; cli-release-url: {outputs: {wgc: string}; result: string}}

(expression)


162-162: property "check-labels-and-engine-changes" is not defined in object type {build-cli: {outputs: {wgc: string}; result: string}; build-router: {outputs: {image_ref: string}; result: string}; cli-release-url: {outputs: {wgc: string}; result: string}}

(expression)


162-162: property "check-labels-and-engine-changes" is not defined in object type {build-cli: {outputs: {wgc: string}; result: string}; build-router: {outputs: {image_ref: string}; result: string}; cli-release-url: {outputs: {wgc: string}; result: string}}

(expression)


181-181: property "check-labels-and-engine-changes" is not defined in object type {build_test: {outputs: {workflow_id: string; workflow_url: string}; result: string}}

(expression)


181-181: property "check-labels-and-engine-changes" is not defined in object type {build_test: {outputs: {workflow_id: string; workflow_url: string}; result: string}}

(expression)


181-181: property "check-labels-and-engine-changes" is not defined in object type {build_test: {outputs: {workflow_id: string; workflow_url: string}; result: string}}

(expression)

Comment thread .github/workflows/query-planner-ci.yaml
Comment thread .github/workflows/query-planner-ci.yaml Outdated
@alepane21
Copy link
Copy Markdown
Contributor Author

@coderabbitai full review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 2, 2025

✅ Actions performed

Full review triggered.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 300ed0f and 58ab906.

📒 Files selected for processing (1)
  • .github/workflows/query-planner-ci.yaml (9 hunks)

Comment thread .github/workflows/query-planner-ci.yaml
@alepane21 alepane21 merged commit fdaa24d into main Oct 3, 2025
16 checks passed
@alepane21 alepane21 deleted the ale/eng-8214-add-label-to-skip-query-planner branch October 3, 2025 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants