Skip to content

Let Summary pass when the VM matrix is skipped - #791

Merged
ejc3 merged 1 commit into
mainfrom
fix-summary-skipped
Aug 10, 2026
Merged

ejc3 merged 1 commit into
mainfrom
fix-summary-skipped

Conversation

@ejc3

@ejc3 ejc3 commented Aug 10, 2026 •

Copy link
Copy Markdown
Owner

Making Summary run on every PR (#787) so it can be a required check means it now runs for PRs where the changes job skips the VM matrix. Two of its steps consume that matrix's artifacts, and analyze_ci_vms.py exits non-zero on an empty directory.

So the very first docs-only PR after #787 merged — #785, which touches only .github/workflows/claude*.yml — produced:

Changes             pass
actionlint          pass
Lint                skipping
Host-*/Container-*  skipping
Summary             FAIL      <- at "Analyze CI run"

Every gating job behaved exactly as designed and the required check still failed. A required check that cannot pass for a whole class of PR blocks that class outright — worse than the hole #787 closed.

Both artifact steps now carry the same changes gate the matrix does. Summary's own "fail if a gating job did not succeed" step is untouched and still treats skipped as non-failure, failure as failure.

Test evidence (red first)

$ git checkout .github/workflows/ci.yml   # drop the gate
$ cargo nextest run --test test_ci_workflow_coverage -E 'test(summary_artifact_steps)'
  FAIL summary_artifact_steps_are_gated_on_the_changes_job
$ # restore
  11 tests run: 11 passed, 0 skipped

actionlint -shellcheck= and cargo fmt --check both clean.

The new guard asserts it found at least two artifact-consuming steps before checking them, so a rename cannot make it pass vacuously.

Summary by CodeRabbit

  • Bug Fixes

    • CI summaries now skip artifact processing and test analysis for documentation-only or other non-code changes.
    • Prevented unnecessary CI analysis when the self-hosted test matrix is skipped.
  • Tests

    • Added coverage to verify that summary processing runs only for code changes.

Making Summary run on every PR, so it can be a required check, means it
now runs for PRs where the `changes` job skips the VM matrix. Two of its
steps consume that matrix's artifacts, and `analyze_ci_vms.py` exits
non-zero on an empty directory. So on the first docs-only PR after that
change - #785, which touches only `.github/workflows/claude*.yml` - the
gate reported:

    Changes            pass
    actionlint         pass
    Lint               skipping
    Host-*/Container-* skipping
    Summary            FAIL     <- at "Analyze CI run"

Every gating job behaved correctly and the required check still failed.
A required check that cannot pass for a whole class of PR blocks that
class outright, which is worse than the hole it replaced.

Both artifact steps now carry the same `changes` gate the matrix does.
Summary's own "fail if a gating job did not succeed" step is unchanged
and still treats skipped as non-failure and failure as failure.

Tested (red first):
  $ git checkout .github/workflows/ci.yml   # drop the gate
  $ cargo nextest run --test test_ci_workflow_coverage -E 'test(summary_artifact_steps)'
    FAIL summary_artifact_steps_are_gated_on_the_changes_job
  $ # restore
    11 tests run: 11 passed, 0 skipped
  $ actionlint -shellcheck=   ->  clean
  $ cargo fmt --check          ->  clean
@coderabbitai

coderabbitai Bot commented Aug 10, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6b9023ff-37c7-4994-8aeb-8fcecdb17281

📥 Commits

Reviewing files that changed from the base of the PR and between 148a86f and 9be3b7e.

📒 Files selected for processing (2)
  • .github/workflows/ci.yml
  • tests/test_ci_workflow_coverage.rs

📝 Walkthrough

Walkthrough

The Summary job now processes VM artifacts and CI results only when the changes job reports code changes. A coverage test verifies the condition for both affected steps.

Changes

CI Summary gating

Layer / File(s) Summary
Gate Summary artifact processing
.github/workflows/ci.yml, tests/test_ci_workflow_coverage.rs
Summary artifact download and CI analysis require needs.changes.outputs.code == 'true'. The coverage test verifies both steps use this gate.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main workflow change: allowing Summary to pass when the VM matrix is skipped.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-summary-skipped

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.

❤️ Share

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

@ejc3
ejc3 merged commit 46c6967 into main Aug 10, 2026
21 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant