mergifyio/gha-mergify-ci
The Mergify CI integration with GitHub Actions
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| action | The Mergify CI action: * junit-process: process JUnit XML files with Mergify CI Insights (Upload and Quarantine) * scopes: detect and upload pull requests scopes to Mergify Merge Queue * scopes-git-refs: return the base/head git references of the pull request in Merge Queue context * scopes-upload: upload pull requests scopes to Mergify Merge Queue * wait-jobs: wait for specified jobs to complete before proceeding | — | junit-process |
| token | Mergify CI token | — | — |
| mergify_api_url | URL of the Mergify API | — | https://api.mergify.com |
| job_name | Override the job name, must be used in case of matrix job to avoid having the same name for all jobs | — | — |
| report_path | Path of the files to upload | — | — |
| scopes | Comma separated list of scopes to upload | — | — |
| all_scopes | Declare that the pull request impacts all scopes (actions: scopes, scopes-upload). The Merge Queue treats such a pull request as a barrier: it conflicts with every scope, so it is never batched or merged in parallel with other pull requests. Typical use: a build-system or CI configuration change where enumerating every impacted scope is brittle. | — | false |
| mergify_config_path | Path to the Mergify configuration file | — | — |
| base | Base git reference for scope detection (action: scopes). Overrides the automatic push/pull-request detection. Leave unset to auto-detect. | — | — |
| head | Head git reference for scope detection (action: scopes). Defaults to HEAD. Leave unset to auto-detect. | — | — |
| test_step_outcome | Outcome of the test runner step (e.g. steps.<id>.outcome). Pass this to detect silent failures where the test runner crashed but the JUnit report appears clean. Values: 'success', 'failure', 'cancelled', 'skipped', or omit entirely. 'skipped' is treated the same as omitting this input. | — | — |
| jobs | List of jobs to wait for completion | — | — |
| mergify_cli_version | Version of mergify-cli to install. Use `latest` to install the latest released version without pinning. Leave unset to use the version pinned by Mergifyio/setup-cli. | — | — |
Outputs
| name | description |
|---|---|
| test_results_upload | Outcome of the JUnit test-results upload to Mergify Test Insights (action: junit-process): 'success', 'rejected' (the API refused the upload, e.g. a token without CI Insights access — no test data was recorded) or 'failed' (transient upload error). Empty when the junit-process step did not run or the installed mergify-cli predates this output. |
| scopes | stringified JSON mapping with names of all scopes matching any of the changed files |
| base | The Merge Queue-aware base SHA of the pull request |
| head | The Merge Queue-aware head SHA of the pull request |