Add checkbox for running test in GH build workflow #4246
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently when we run a build with limited set of boards that doesn't include OVA, the test job fails because the OVA artifact is missing. Add a checkbox for running tests and ensure that OVA artifact is built if it's enabled.
📝 WalkthroughWalkthroughAdds a run_tests boolean input to the workflow, parses it into runTests, conditionally injects the "ova" board into the build matrix when tests are enabled, and gates the Test OS image job to run on release events or when run_tests is true. Includes a log message when OVA is injected. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant U as User/Release
participant GH as GitHub Actions
participant MX as Matrix Setup
participant B as Build Job(s)
participant T as Test Job
U->>GH: Trigger workflow_dispatch (run_tests) or release
GH->>MX: Generate matrix
Note over MX: Parse inputs.run_tests -> runTests
alt runTests == true
MX->>MX: Ensure "ova" in boards
Note right of MX: Log OVA injection
else runTests == false
MX->>MX: Use original boards
end
GH->>B: Run build for matrix boards
alt event == release or run_tests == true
GH->>T: Run Test OS image job
else
GH--xT: Skip tests
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/workflows/build.yaml (1)
160-161: Prefer embedding a real boolean via toJSON (minor) and keep context usage consistentIn github-script, github.event.inputs.* values are strings. Your "=== 'true'" check works, but you can embed a proper boolean and simplify:
Apply this diff:
- const runTests = "${{ github.event.inputs.run_tests }}" === "true" + const runTests = ${{ toJSON(inputs.run_tests) }}Benefits:
- Avoids string comparison.
- Uses the same inputs context you already use elsewhere in the workflow for consistency.
</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** **Cache: Disabled due to data retention organization setting** **Knowledge Base: Disabled due to data retention organization setting** **💡 Knowledge Base configuration:** - MCP integration is disabled by default for public repositories - Jira integration is disabled by default for public repositories - Linear integration is disabled by default for public repositories You can enable these sources in your CodeRabbit configuration. <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between effe4d3e7365dc9492ac3076f1f1a0260a05ee5e and 218bbcb3d63fd22830182ecf22a269fcf6d2ae93. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `.github/workflows/build.yaml` (3 hunks) </details> <details> <summary>🔇 Additional comments (3)</summary><blockquote> <details> <summary>.github/workflows/build.yaml (3)</summary> `19-23`: **Add run_tests input: sensible and minimal** Introducing a boolean workflow_dispatch input to gate tests is appropriate and aligns with the PR goals. Defaulting to true preserves current behavior. --- `169-174`: **OVA injection logic is correct** The conditional OVA injection when tests are enabled is straightforward and solves the missing artifact issue for the tests. --- `427-427`: **Test workflow artifact expectations verified** - `.github/workflows/test.yaml` defines and uses the `version` input. - It downloads or retrieves `haos_ova-${{ inputs.version }}.qcow2.xz` via curl and `actions/download-artifact`. - No references to a raw `.ova` are needed—tests correctly consume the qcow2.xz artifact. All downstream artifact requirements are satisfied; no further changes required. </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Comment on lines
166
to
176
| console.log("Run partial build") | ||
| const boardSet = new Set(boardFilter.split(",")) | ||
| // if tests are enabled, we need to ensure the OVA board is included | ||
| if (runTests && !boardSet.has("ova")) { | ||
| console.log("Adding OVA board for integration tests") | ||
| boardSet.add("ova") | ||
| } | ||
| const buildBoards = boards.filter(b => boardSet.has(b.id)) | ||
| return { "board": buildBoards } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Trim user-provided board list to avoid mismatches and silent drops
If boards are provided with spaces (e.g., "generic-x86-64, ova"), current code will not match ids due to leading/trailing whitespace. This can silently drop boards from the build set. Normalize tokens before adding to the Set.
Apply this diff:
- const boardSet = new Set(boardFilter.split(","))
+ const boardSet = new Set(
+ boardFilter
+ .split(",")
+ .map((s) => s.trim())
+ .filter(Boolean)
+ )Optional follow-up (outside the selected range): you may also warn on unknown boards to surface typos:
const buildBoards = boards.filter(b => boardSet.has(b.id))
const known = new Set(boards.map(b => b.id))
const unknown = [...boardSet].filter(id => !known.has(id))
if (unknown.length) {
console.log(`Warning: unknown board(s) ignored: ${unknown.join(", ")}`)
}
Member
Author
There was a problem hiding this comment.
Unrelated to the scope of the PR.
There was a problem hiding this comment.
@sairon You're absolutely right - that suggestion about trimming board names is outside the scope of this PR, which is specifically focused on adding the test checkbox functionality. I'll keep my feedback focused on the changes being made. Thanks for keeping the scope tight!
sairon
added a commit
that referenced
this pull request
Aug 26, 2025
Currently when we run a build with limited set of boards that doesn't include OVA, the test job fails because the OVA artifact is missing. Add a checkbox for running tests and ensure that OVA artifact is built if it's enabled. (cherry picked from commit 71d222a)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently when we run a build with limited set of boards that doesn't include OVA, the test job fails because the OVA artifact is missing. Add a checkbox for running tests and ensure that OVA artifact is built if it's enabled.
Summary by CodeRabbit
Tests
Chores