Ginkgo Integration with Mergify

This guide shows how to generate a JUnit report from your Ginkgo specs and upload it to Test Engine from your CI workflow.

For tests written with Go’s testing package alone, see the Go guide.

The ginkgo command writes a JUnit report when you pass --junit-report:

ginkgo -r --keep-going --junit-report=junit.xml

-r runs every suite under the current directory, and Ginkgo merges their results into one junit.xml at the root. Do not drop --keep-going: without it, Ginkgo stops after the first suite that fails, and the suites it did not run are missing from the report.

Run the specs in a step with an id, and let the upload step decide the job’s result:

- name: Install Ginkgo
  run: go install github.com/onsi/ginkgo/v2/ginkgo

- name: Run Ginkgo Specs
  id: tests
  continue-on-error: true
  run: ginkgo -r --keep-going --junit-report=junit.xml

Installing ginkgo from your module, as above, keeps the command at the version of Ginkgo your go.mod requires.

- name: Mergify CI Upload
  if: success() || failure()
  uses: mergifyio/gha-mergify-ci@v27
  with:
    token: ${{ secrets.MERGIFY_TOKEN }}
    report_path: junit.xml
    test_step_outcome: ${{ steps.tests.outcome }}

Key Points:

• if: success() || failure(): Runs the upload step even if tests fail, ensuring Test Engine has the full report.
• report_path: junit.xml: Points to where your JUnit file is located. Make sure it matches the path you set in your CI job.
• test_step_outcome: ${{ steps.tests.outcome }}: Passes the test runner step's outcome so Mergify can detect silent failures where the runner crashed but the JUnit report appears clean. Add an id (such as tests) to your test runner step and update the steps.<id>.outcome reference to match.
• On pull requests from forks and from Dependabot, MERGIFY_TOKEN is empty and this step fails: skip it as shown in Pull Requests Without the Secret.

If you use a job matrix in your workflow (e.g., to test across multiple versions), every leg reports the same job name, because GitHub Actions gives them all one GITHUB_JOB. Set the job_name input so Test Engine can tell the reports apart:

jobs:
  example_matrix:
    strategy:
      matrix:
        version: [10, 12, 14]

Your upload step should look like:

- name: Mergify CI Upload
  if: success() || failure()
  uses: mergifyio/gha-mergify-ci@v27
  with:
    job_name: example_matrix (${{ matrix.version }})
    token: ${{ secrets.MERGIFY_TOKEN }}
    report_path: junit.xml
    test_step_outcome: ${{ steps.tests.outcome }}

To benefit from Test Engine quarantine, you need to add continue-on-error: true in your GitHub Actions step that executes your tests and generates the JUnit file. The step running the gha-mergify-ci action then decides whether the job passes or fails, taking quarantined tests into account.

You should also pass test_step_outcome: ${{ steps.tests.outcome }} to the step that runs mergifyio/gha-mergify-ci (where tests is the id of your test runner step) to detect silent failures where the test runner crashed but the JUnit report appears clean. Without this input, a crash that produces a partial or empty report could be mistakenly treated as a success.

With continue-on-error: true, the job’s result comes from the upload step. On pull requests from forks and from Dependabot, MERGIFY_TOKEN is empty and the upload step has to be skipped: add the step that fails the job when the tests failed and nothing was uploaded, as shown in pull requests without the secret.

steps:
  - label: "Run tests"
    command: <your test command>
    plugins:
      - mergifyio/mergify-ci#v8:
          action: junit-process
          report_path: junit.xml

Key Points:

• The plugin runs in the post-command hook, so it uploads results after your tests finish, even if they fail.
• report_path: junit.xml: Points to where your JUnit file is located. Make sure it matches the path you set in your test configuration.
• Silent failure detection is automatic: the plugin reads the step's exit code to detect cases where the test runner crashed but the JUnit report appears clean.

If you use a build matrix in your pipeline, each variation reports its own step label as its job name, so the variations are already distinct. Set the job_name plugin property when the label is not the name you want Test Engine to file the reports under:

steps:
  - label: "Flaky detection ({{matrix}})"
    matrix:
      - "3.10"
      - "3.11"
      - "3.12"
    command: <your test command>
    plugins:
      - mergifyio/mergify-ci#v8:
          action: junit-process
          job_name: "Tests ({{matrix}})"
          report_path: junit.xml

When using the Buildkite plugin for Test Engine quarantine, the plugin automatically detects test failures using the step’s exit code. No extra configuration is needed.

The mergifyio/mergify-ci plugin runs in the post-command hook and reads BUILDKITE_COMMAND_EXIT_STATUS to detect silent failures where the test runner crashed but the JUnit report appears clean.

Install the Mergify CLI in your pipeline and export MERGIFY_TOKEN. Run mergify ci junit-process after your tests:

set -o pipefail
exit_code=0
ginkgo -r --keep-going --junit-report=junit.xml || exit_code=$?
mergify ci junit-process \
  --test-exit-code "$exit_code" \
  junit.xml

Key Points:

• MERGIFY_TOKEN: Export this environment variable with your Mergify application key so junit-process can authenticate to the API.
• || exit_code=$?: CI shells run with -e, so a failing test command on its own line would end the script before the upload. This form keeps going and records the code. The script needs bash for set -o pipefail: on Jenkins, whose sh steps often run dash, start it with #!/bin/bash.
• --test-exit-code "$exit_code": Passes the test runner's exit code so Mergify can detect silent failures where the runner crashed but the JUnit report appears clean.
• junit-process exits last, so its status becomes the step's. Quarantine depends on that: it exits 0 when every failure it found is quarantined, and 1 when one is not. Re-exiting with the test runner's own code would fail the step whatever quarantine decided.
• The branch quarantine is evaluated against is detected from your CI provider, falling back to the checked-out branch. Pass --tests-target-branch <branch> only to override it.

Test Engine names each spec by its suite’s description, the one you pass to RunSpecs, then a dot and the spec’s full text: its kind in brackets, then the texts of the containers around it and its own, joined with spaces. The spec It("adds an item") inside Describe("Add") inside Describe("Cart"), in a suite started with RunSpecs(t, "Cart Suite"), is reported as Cart Suite.[It] Cart Add adds an item.

Give each suite a distinct description, so specs of the same text in two packages keep separate histories. Renaming a suite, a container or a spec starts a new history for the specs it holds.

The spec’s labels are part of its name: It("ships", Label("slow")) inside Describe("Order"), in the suite Order Suite, is reported as Order Suite.[It] Order ships [slow], so adding or removing a label also starts a new history. Each Entry of a DescribeTable is a spec of its own, named after the entry’s description.

Specs marked pending, such as PIt, and specs that call Skip() are reported as skipped.

After pushing these changes:

1. Your CI workflow runs your Ginkgo specs.
2. Ginkgo writes junit.xml.
3. Mergify uploads the report to Test Engine.

You can then review your test results, including any failures or flaky tests, directly in the Test Engine dashboard.

• Suites missing from the report: add --keep-going, so Ginkgo runs every suite after one fails.
• The CLI provides information about the upload. Check the logs in GitHub Actions.
• File paths: Double-check that the output file matches the path used in report_path.
• Permissions: Make sure the MERGIFY_TOKEN is valid and setup in your GitHub Actions secrets as explained in the docs.
• Workflow conditions: If your step is not running, confirm the if condition is actually triggered in your job.