rspec-mergify 2026.10.5 → 2026.10.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '092c343724059e005bbf42780e79c01ba31094c0baa70e2965666c4dd53c61b7'
-  data.tar.gz: 8d520a90dd1967045177867a760b9c47cc3984544765e69ea5affdd3b917fef9
+  metadata.gz: 2c8b41d3c9e361bcea64889951b41d214d237d06a56ee0873d725f1106b9c21a
+  data.tar.gz: 86f2ccc52676008a737da28ae8877ec49b84f7dc4f484847f0f3d3c83f1496bf
 SHA512:
-  metadata.gz: d1ce7b70450745ba95a4a34b86ffdd00aa15ffdfe8fd5a055116e9b48f03ff32ad908e582da279537fb277475e16c3d24900c2f5733fb1cb99bf254fdf0906c9
-  data.tar.gz: '049ac3da9f0cb469cb45cbdc40c9eccec30a9485cf918a0208b4665ac6c96998ab4151618098a0ee654186d002717df9b5a044cded81e802660f3b2196b0d3c4'
+  metadata.gz: e9c95b28c61e098fc580b9a854f3bbc3d8f9dc94d5084bd98d5fd0fe3bcf7d090711c3e993651739501bfb5fa11ef091a92e5959cbb78098883bfad9b5ce8882
+  data.tar.gz: 0cb4388da6ad71ae24ca0315fb29dde8e7995c031b79f29c37a177da5c77df548ffe8216c5b8af5931f810eb39999eab5ad5145dc0c2b20022588629906c45c6

data/README.md

@@ -1,13 +1,13 @@
 # rspec-mergify
 
-RSpec plugin for [Mergify Test Insights](https://docs.mergify.com/ci-insights/).
+RSpec plugin for [Mergify Test Engine](https://docs.mergify.com/test-engine/).
 
 ## Features
 
 - **Test tracing** — Sends OpenTelemetry traces for every test to Mergify's API
 - **Flaky test detection** — Intelligently reruns tests to detect flakiness with budget constraints
 - **Test quarantine** — Quarantines failing tests so they don't block CI
-- **Test selection** — Runs only the previously-failing examples when Mergify's merge queue reruns a job
+- **Test selection** — Runs first the examples a merge-queue bisection step failed in the step above, and stops once one fails again
 
 ## Installation
 
@@ -40,7 +40,7 @@ gem 'rspec-mergify', '0.1.4'
 
 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 `RSPEC_MERGIFY_ENABLE=true`.
+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
 
@@ -48,49 +48,57 @@ The plugin activates automatically when running in CI (detected via the `CI` env
 |---|---|---|
 | `MERGIFY_TOKEN` | Mergify API authentication token | (required) |
 | `MERGIFY_API_URL` | Mergify API endpoint | `https://api.mergify.com` |
-| `RSPEC_MERGIFY_ENABLE` | Force-enable outside CI | `false` |
-| `RSPEC_MERGIFY_DEBUG` | Print spans to console | `false` |
+| `MERGIFY_CI_ENABLE` | Force-enable outside CI | `false` |
+| `MERGIFY_CI_DEBUG` | Print the session verdict and 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_TEST_SELECTION_ENABLE` | Opt this job into test selection (see below) | `false` |
 
+The names these replace, `RSPEC_MERGIFY_ENABLE` and `RSPEC_MERGIFY_DEBUG`, are
+deprecated: they still work when the new name is not set, and the summary says
+which one to switch to. Both take a boolean, like the variables that replace
+them: `RSPEC_MERGIFY_DEBUG=false` leaves debug off.
+
 ### Test selection
 
-When Mergify's merge queue reruns a job — a retry, or a step of a batch
-bisection — only the examples that failed on the previous attempt are
-informative. The gem asks Mergify whether the current run is such a rerun and,
-if so, runs only those examples.
+When Mergify's merge queue splits a failed batch, each bisection step only
+needs to tell whether it is red. The gem asks Mergify whether the current run
+is such a step and, if so, runs first the examples this job failed in the run
+the step was split from (Fail First). The top-level groups holding them run
+first, and inside each group they run before its other examples and child
+groups — whatever the order (`--order rand`, `config.order`, your own
+`register_ordering`, `order:` metadata), which still applies to everything
+else. RSpec runs a group's whole subtree before the next group, and a group's
+own examples before its child groups, so when they span several groups the
+rest of each of those groups runs in between. If one of them fails again, the
+step is red whatever the rest does, so the run stops once they have all run
+(exit code 1, the remaining examples not run) and the queue can split again
+without waiting for the suite. If none fails again, the rest of the suite runs
+as usual. No example is ever skipped, so a green step still comes from a full
+suite. A quarantined failure does not stop the run; a `--fail-fast` of your own
+still stops at the first failure.
 
 **This is off until you turn it on, per job.** Set
-`MERGIFY_TEST_SELECTION_ENABLE=true` on the job you want reduced. Installing the
-gem is not enough — a feature that decides not to run tests starts only where
-you wrote that it should. Anything that is not a recognised yes (unset, empty,
-`false`, unparsable) means no, and a job that has not opted in never asks.
+`MERGIFY_TEST_SELECTION_ENABLE=true` on the job you want to run its failures
+first. Installing the gem is not enough. Anything that is not a recognised yes
+(unset, empty, `false`, unparsable) means no, and a job that has not opted in
+never asks.
 
-Once opted in, it only ever removes work:
+Once opted in:
 
-- the answer is applied **after** RSpec's own filters — file and line
-  arguments, `--tag`, `-e`, `--only-failures` all still narrow the run, never
-  widen it;
+- the order applies **after** RSpec's own filters — file and line arguments,
+  `--tag`, `-e`, `--only-failures` all still narrow the run;
 - examples are matched by their id (`./spec/models/user_spec.rb[1:2]`), the
   identity RSpec itself reruns failures by;
-- if Mergify says the previous attempt already ran every one of these examples
-  and they passed, the run executes none and exits green;
-- if any example Mergify asks for is not collected here, the full suite runs;
-- any error, timeout, or unrecognised answer runs the full suite;
-- if Mergify refuses to pick a previous attempt (several runs of this job
-  report under one name), the run **fails** with Mergify's explanation: give
-  each run its own `MERGIFY_TEST_JOB_NAME`;
+- any error, timeout, or unrecognised answer runs the full suite in its usual
+  order;
 - at the end of the run the gem sends Mergify what it concluded (the counts
   and the failing examples) — unless the run failed outside any example (a
-  failing `after(:context)` or suite hook), in which case a retry runs the
-  full suite.
+  failing `after(:context)` or suite hook), in which case the next bisection
+  step runs its full suite in its usual order.
 
 Each parallel_tests worker, and each CI job handed a slice of the spec files,
-is matched to the same slice of the previous attempt, by the examples it
-collects. This needs the slices to be the same on both attempts, which is the
-case for a split by file size or by a committed runtime log; Knapsack Pro's
-Queue Mode hands files out dynamically and is not supported.
+reports its own collection, by the examples it collects.
 
 ### Parallel runs
 
@@ -101,7 +109,7 @@ Queue Mode hands files out dynamically and is not supported.
 
 Suites split across CI jobs (knapsack, `circleci tests split`, Buildkite `parallelism`) behave the same way, one session per job.
 
-For detailed documentation, see the [official guide](https://docs.mergify.com/ci-insights/test-frameworks/rspec/).
+For detailed documentation, see the [official guide](https://docs.mergify.com/test-engine/test-frameworks/rspec/).
 
 ## Development
 
@@ -120,13 +128,16 @@ bundle install
 ### Running Tests
 
 ```bash
-bundle exec rspec
+bundle exec rake test
 ```
 
+`rake test` compiles the extension in Cargo's dev profile first: running
+`rspec` alone skips every binding example when the extension isn't built.
+
 ### Linting
 
 ```bash
-bundle exec rubocop
+bundle exec rake lint
 ```
 
 ## License