Skip to content

Commit 31c333c

Browse files
jdclaude
andauthored
docs: add test_step_outcome input to CI upload step documentation (#10840)
Document the new `test_step_outcome` input added in Mergifyio/gha-mergify-ci#174. This option lets users pass the test runner step's outcome so Mergify can detect silent failures where the runner crashed but the JUnit report appears clean. Updated the shared upload step components and the quarantine setup partial so the new input appears across all test framework pages. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 4b69296 commit 31c333c

3 files changed

Lines changed: 18 additions & 3 deletions

File tree

‎src/components/MergifyCIUploadStep.astro‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ const { reportPath } = Astro.props;
1313
uses: mergifyio/gha-mergify-ci@v8
1414
with:
1515
token: \${{ secrets.MERGIFY_TOKEN }}
16-
report_path: ${reportPath}`}
16+
report_path: ${reportPath}
17+
test_step_outcome: \${{ steps.tests.outcome }}`}
1718
lang="yaml"
1819
theme="slack-ochin"
1920
/>
@@ -27,4 +28,11 @@ const { reportPath } = Astro.props;
2728
<Code code={`report_path: ${reportPath}`} inline lang="yaml" theme="slack-ochin" />: Points to
2829
where your JUnit file is located. Make sure it matches the path you set in your CI job.
2930
</li>
31+
<li>
32+
<Code code={`test_step_outcome: \${{ steps.tests.outcome }}`} inline lang="yaml" theme="slack-ochin" />:
33+
Passes the test runner step's outcome so Mergify can detect silent failures where the runner
34+
crashed but the JUnit report appears clean. Add an <Code code="id" inline lang="yaml" theme="slack-ochin" /> (such
35+
as <Code code="tests" inline lang="yaml" theme="slack-ochin" />) to your test runner step and
36+
update the <Code code="steps.<id>.outcome" inline lang="yaml" theme="slack-ochin" /> reference to match.
37+
</li>
3038
</ul>

‎src/components/MergifyCIUploadStepMatrix.astro‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ const { reportPath } = Astro.props;
3333
with:
3434
job_name: example_matrix (\${{ matrix.version }})
3535
token: \${{ secrets.MERGIFY_TOKEN }}
36-
report_path: ${reportPath}`}
36+
report_path: ${reportPath}
37+
test_step_outcome: \${{ steps.tests.outcome }}`}
3738
lang="yaml"
3839
theme="slack-ochin"
3940
/>
Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
In order to benefit from CI Insights Quarantine, you need to add `continue-on-error: true`
2-
in your GitHb Actions step that execute your tests and generates the JUnit file.
2+
in your GitHub Actions step that executes your tests and generates the JUnit file.
33
The step running the `gha-mergify-ci` action will determine the success or failure conclusion,
44
considering quarantined tests.
5+
6+
You should also pass `test_step_outcome: ${{ steps.tests.outcome }}` to the step that runs
7+
`mergifyio/gha-mergify-ci` (where `tests` is the `id` of your test runner step) to detect
8+
silent failures where the test runner crashed but the JUnit report appears clean. Without
9+
this input, a crash that produces a partial or empty report could be mistakenly treated as a
10+
success.

0 commit comments

Comments
 (0)