minitest-mergify 2026.10.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f8329ced091f90450e17fd2609fb2f0c4b2473a4c9b4a3dcb2894976ca7cca1
+  data.tar.gz: ca3816579117094718c11e849cac1674eff03803feb7302c63533cd2710acc31
+SHA512:
+  metadata.gz: d7a4608e8303cfe68b9b9a27fac19ec798ffc0deecd61987823903fba281f6d741a97c647e1ca936b05731282e7235b3c6855f78346e43d35d5332577e79a146
+  data.tar.gz: ef2e7eabb0d85e518a066e94fabebf9a212afe436a40e8018c50d013f782e5747fafcb86a4b90f923960bc43f4c012a689fdcb251c740c58ef60fe448571c8be

data/LICENSE

@@ -0,0 +1,31 @@
+Copyright © 2021-2026 Mergify. All rights reserved.
+
+This software is proprietary to Mergify and is not open source.
+
+Mergify grants anyone who obtains a copy a non-exclusive, non-transferable,
+revocable, royalty-free licence to download, install, copy and run this
+software, unmodified, solely for use with the Mergify service, including as a
+dependency of a project that uses the Mergify service. You may make copies
+available within your organisation, including in internal package mirrors,
+container images and CI environments, for that same purpose.
+
+Except to the extent applicable law expressly permits it, you may not modify or
+create derivative works of this software, distribute it outside the purposes
+above, reverse engineer it, or use it to build or operate a product or service
+that competes with Mergify.
+
+Use of the Mergify service is governed by the Mergify Terms of Service
+(https://mergify.com/tos) or by your written agreement with Mergify, which
+prevails over this notice where it covers this software.
+
+THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, MERGIFY SHALL NOT BE
+LIABLE FOR ANY DAMAGES ARISING FROM ITS USE, EXCEPT AS PROVIDED IN YOUR
+AGREEMENT WITH MERGIFY.
+
+Some files carry their own licence notice, which applies to them instead of
+this one.
+
+This licence is governed by French law.
+
+Third-party components and their licenses are listed in THIRD_PARTY_LICENSES.

data/README.md

@@ -0,0 +1,129 @@
+# minitest-mergify
+
+Minitest plugin for [Mergify Test Engine](https://docs.mergify.com/test-engine/).
+
+## Features
+
+- **Test tracing** — Sends OpenTelemetry traces for every test to Mergify's API
+- **Test quarantine** — Quarantines failing tests so they don't block CI
+- **Test selection** — Runs first the tests that failed in a merge-queue bisection step, and stops once one fails again
+- **Flaky test detection** — Reruns new tests to catch flaky ones before they merge
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'minitest-mergify'
+```
+
+Then run `bundle install`, and require the plugin where your suite sets up
+Minitest, before its tests are defined, such as in `test/test_helper.rb`:
+
+```ruby
+require 'minitest/mergify'
+```
+
+Minitest 6 loads only the plugins a suite asks for, so the line is needed
+there. Minitest 5 also loads the plugin by itself, but only once the tests are
+defined: keep the line there too, or a spec test with no body (`it "does a
+thing"` without a block) is reported without its line, under the file of
+another test of its `describe`.
+
+It supports Minitest 5.19 and later, on Ruby 3.1 and later, and Minitest 6 on
+Ruby 3.2 and later: tests in classes and in `describe` blocks, run in one
+process, in Minitest's threads (`parallelize_me!`) or in Rails' parallel
+workers (`parallelize`). It runs on `mergify-ci-core`, which Bundler installs
+with it and which ships precompiled for Linux (glibc 2.30 or newer, and musl),
+macOS and Windows.
+
+## Configuration
+
+Set the `MERGIFY_TOKEN` environment variable with your Mergify API token.
+
+The plugin activates automatically when running in CI (detected via the `CI`
+environment variable). To enable outside CI, set `MERGIFY_CI_ENABLE=true`.
+
+### Environment Variables
+
+| Variable | Description | Default |
+|---|---|---|
+| `MERGIFY_TOKEN` | Mergify API authentication token | (required) |
+| `MERGIFY_API_URL` | Mergify API endpoint | `https://api.mergify.com` |
+| `MERGIFY_CI_ENABLE` | Force-enable outside CI | `false` |
+| `MERGIFY_CI_DEBUG` | Print the spans instead of sending them, and upload nothing | `false` |
+| `MERGIFY_TRACEPARENT` | W3C distributed trace context | — |
+| `MERGIFY_TEST_JOB_NAME` | Mergify test job name | — |
+| `MERGIFY_FAIL_FIRST_ENABLE` | Set to `false` to never run first what a merge-queue bisection step of this job failed before (see below) | `true` |
+
+### Quarantine
+
+A test quarantined in Mergify's dashboard still runs and is still reported, as
+failed when it fails, but its failure does not fail the run: Minitest counts it
+as a skip. A test quarantined while the repository uploaded JUnit reports is
+known under the name minitest-junit and minitest-reporters gave it,
+`UserTest.test_valid`, and is quarantined under that name too.
+
+### Fail First
+
+When Mergify's merge queue splits a batch that failed, the tests that failed
+in the step above are the ones that tell the next split apart. The plugin asks
+Mergify whether the run is such a bisection step and, if so, runs those tests
+first, and stops the run once one failed again, so the queue can split again
+without waiting for the rest of the suite.
+
+**This is on by default.** A job turns it off with
+`MERGIFY_FAIL_FIRST_ENABLE=false` (or `no`, `off`, `0`; any other value keeps
+it on). `MERGIFY_TEST_SELECTION_ENABLE`, its former name, is still read while
+the new one is unset or empty, and the summary at the end of the run says to
+switch. It asks about
+the tests Minitest's own filters (`-n`, `-e`, Rails' `file:line`) left, and at
+the end of the run sends Mergify what it concluded (the counts and the failing
+tests), which the next step is answered from. Any error, timeout, or
+unrecognised answer runs the suite as usual.
+
+It only ever asks in a build of a merge-queue batch, the only builds a
+bisection step can be: on GitHub Actions, the event of the draft pull request
+the queue opened; on any other build, the queue's git note on the branch, one
+`git ls-remote` against `origin` that runs while the tests are being collected.
+Every other build asks nothing and sends nothing. Of a batch's builds, only
+those below a failed batch, and not retrying their own checks, ask: the
+others cannot be a bisection step, and send their results only when the
+batch holds two pull requests or more, so a bisection step may read them, or
+when they failed. A build where git cannot answer (no `origin`, credentials
+the test step does not hold) asks, as it would without this.
+
+### Flaky detection
+
+On a pull request, a test the target branch does not have yet is new: once the
+suite is over, the plugin reruns it, within a time budget Mergify sets, and if
+a run fails, the test is flaky and the job fails. Minitest's own summary still
+counts the test as passed; the exit code and the report below it say
+otherwise. On a branch with no target, such as a push to main, it reruns the
+tests Mergify knows as unhealthy instead, to report whether they still are,
+without failing the job. The reruns go through Minitest itself, so they run
+where the test ran: in one process, in Minitest's threads, or in Rails'
+parallel workers.
+
+### Test names
+
+A test in a class is named as Minitest names it, `UserTest#test_valid`. A test
+in a `describe` block is named by its file, its `describe` blocks and its text,
+`test/models/user_test.rb > User > when banned > cannot log in`: Minitest
+numbers an `it` by its position, which would rename every test below one added.
+A text its `describe` repeats keeps Minitest's number, so the two stay apart.
+
+## Development
+
+```bash
+rbenv install          # install the Ruby version from .ruby-version (if needed)
+bundle install
+(cd ../mergify-ci-core && bundle install)
+bundle exec rake test  # compiles mergify-ci-core's extension, then runs the suite
+bundle exec rake lint
+```
+
+## License
+
+Proprietary — see the LICENSE shipped with the gem. Use is governed by the
+[Mergify Terms of Service](https://mergify.com/tos).