From c53ff34d4285e4b982692325afb507e7697dbefc Mon Sep 17 00:00:00 2001 From: mergify-ci-bot Date: Mon, 28 Sep 2026 11:11:18 +0000 Subject: [PATCH] docs(ci-insights): documents the gha-mergify-ci job_name input for matrix job naming --- .../docs/ci-insights/setup/github-actions.mdx | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/content/docs/ci-insights/setup/github-actions.mdx b/src/content/docs/ci-insights/setup/github-actions.mdx index 1cd835e2e7..54c6314772 100644 --- a/src/content/docs/ci-insights/setup/github-actions.mdx +++ b/src/content/docs/ci-insights/setup/github-actions.mdx @@ -174,6 +174,20 @@ jobs: reports the same name. A step's `env` applies to that step alone, so a name set on the step that runs your tests never reaches the upload step. + When the upload goes through `gha-mergify-ci`, the action's `job_name` input + sets the name reported with that step's results: + + ```yaml + - uses: mergifyio/gha-mergify-ci@@@GHA_MERGIFY_CI_VERSION@@ + with: + token: ${{ secrets.MERGIFY_TOKEN }} + report_path: test-results-*.xml + job_name: test (${{ matrix.version }}) + ``` + + `job_name` takes precedence over `MERGIFY_TEST_JOB_NAME` when both are set. + Leave it out and the name set on the job applies. + ### Key Environment Variables - `MERGIFY_TOKEN`: Application key with `ci` scope for uploading test results to Test Insights