Skip to content

docs(ci-insights): documents the gha-mergify-ci job_name input for matrix job naming #13039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 1 commit into from
Sep 28, 2026
+14 −0
Merged

docs(ci-insights): documents the gha-mergify-ci job_name input for matrix job naming #13039

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/content/docs/ci-insights/setup/github-actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading