Skip to content

docs(ci): explain the nested testsuite workflow refs - #1077

Merged
castrojo merged 1 commit into
testingfrom
fix/nested-testsuite-refs
Aug 24, 2026
Merged

docs(ci): explain the nested testsuite workflow refs#1077
castrojo merged 1 commit into
testingfrom
fix/nested-testsuite-refs

Conversation

@castrojo

@castrojo castrojo commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

What problem are you solving?

Stable-promotion triage can read test_ref: v1 as proof that every testsuite fix is current. It is not. A reusable workflow carries two independent refs:

  • uses selects the workflow definition — including workflow-level fixes such as VM disk sizing
  • test_ref selects the test tree that workflow checks out

They move separately, so a managed test_ref beside a pinned uses leaves half the stack stale while the caller looks managed.

Changes

  • adds the triage row: tests update but E2E setup stays stale → compare the reusable workflow uses ref with its test checkout ref
  • adds a section explaining the two refs and the promotion trap, directing triage to the nested workflow shown in the run log rather than the ref written in the caller

One file, 13 added lines.

Relationship to #1014

This supersedes #1014, which carried the same insight but could no longer be merged: its branch had accumulated 16 conflicts against main — Containerfile, five workflows, build_files/, unit tests, renovate.json — for a change that touches one documentation file. Resolving those to land a docs addition would have produced a diff nobody could review against the change it claims to make, so it is re-cut from current main instead. Authorship is preserved in the commit trailer.

The content was also re-checked against main: failure-modes.md has grown a lot since #1014 was opened, but nothing in it covers the nested-ref distinction, so the contribution is still needed.

Testing

  • python3 .github/scripts/validate-docs.pydocumentation ok: 13 skills, 41 Markdown files

Refs #929

@castrojo
castrojo requested a review from a team as a code owner August 9, 2026 18:46
Stable-promotion triage reads `test_ref: v1` as proof that the testsuite is
current. It is not: a reusable workflow carries two independent refs, and
`uses` -- which selects the workflow body, including fixes like VM disk sizing
-- moves separately from the test tree `test_ref` checks out. Pinning one and
managing the other leaves half the stack stale while the caller looks managed.

Adds the triage row and the explanation to the CI failure-mode reference.

Supersedes #1014, whose branch could no longer be merged: it had accumulated
16 conflicts against main -- workflows, Containerfile, unit tests -- for a
change that touches one documentation file. Re-cut from current main so the
diff is the change.

Refs #929
Co-authored-by: Brian Ketelsen <bketelsen@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Signed-off-by: castrojo <castrojo@users.noreply.github.com>
(cherry picked from commit f05a382)
@castrojo
castrojo changed the base branch from main to testing August 9, 2026 18:48
@castrojo
castrojo force-pushed the fix/nested-testsuite-refs branch from f05a382 to ba3484a Compare August 9, 2026 18:49

@hanthor hanthor left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Small, accurate docs addition: uses (workflow definition) and test_ref (test tree) on a reusable testsuite workflow do move independently, so a managed test_ref next to a pinned uses is a real trap — workflow-level fixes (VM sizing, runner setup) don't arrive just because the test tree ref is current. Good judgement re-cutting this from current main instead of resolving 16 unrelated conflicts on the superseded #1014, with authorship preserved in the trailer. One file, 13 lines, no workflow behavior changed. CI is green.


Generated by Claude Code

@castrojo
castrojo merged commit 08aeddc into testing Aug 24, 2026
5 checks passed
@castrojo
castrojo deleted the fix/nested-testsuite-refs branch August 24, 2026 16:31
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.

2 participants