flake-ledger 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 WJDdidi-1
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,420 @@
-# Temporary Holding Version
+# flake-ledger
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![CI](https://github.com/WJDdidi-1/flake-ledger/actions/workflows/ci.yml/badge.svg)](https://github.com/WJDdidi-1/flake-ledger/actions/workflows/ci.yml)
+[![version](https://img.shields.io/github/package-json/v/WJDdidi-1/flake-ledger)](https://github.com/WJDdidi-1/flake-ledger/releases)
+
+Ranks flaky tests from JUnit XML across CI runs, including passed-on-retry.
+
+Retries turn a red run green, so the same test burns CI time indefinitely; each
+run's JUnit XML is inspected alone and the passed-on-retry evidence is
+discarded. `flake-ledger` reads every JUnit XML under a directory, groups shards
+into CI runs, and keeps each attempt. A test that failed and then passed on
+retry stays a `passed-on-retry` row in the ledger instead of disappearing into a
+green build.
+
+## A real session
+
+The five runs are checked in at [`examples/runs`](examples/runs), one JUnit
+report per run. From a checkout, `npm run example` (or
+`node examples/demo.mjs`) runs the same CLI commands against those files and
+checks the output:
+
+```text
+examples/runs/
+  run-01/results.xml
+  run-02/results.xml
+  run-03/results.xml
+  run-04/results.xml
+  run-05/results.xml
+```
+
+`run-01/results.xml` (other testcases trimmed) carries Surefire's
+passed-on-retry evidence:
+
+```xml
+<testsuite name="com.example.CheckoutTest" timestamp="2026-01-05T10:00:00">
+  <testcase classname="com.example.CheckoutTest" name="appliesCoupon">
+    <flakyFailure message="expected 10% discount, got 0">
+      <stackTrace>org.opentest4j.AssertionFailedError: expected 10% discount, got 0
+  at CheckoutTest.appliesCoupon(CheckoutTest.java:42)</stackTrace>
+    </flakyFailure>
+  </testcase>
+  <!-- more testcases -->
+</testsuite>
+```
+
+Scan the tree. The table is ranked by a 95% Wilson lower bound on unstable
+rate, so a test with more evidence outranks one with a single bad run:
+
+```console
+$ flake-ledger scan examples/runs
+TEST ID                                     RUNS  ATTEMPTS  UNSTABLE  PASS-ON-RETRY  FAILED  RATE   SCORE  CLASS
+com.example.LoginTest::rejectsExpiredToken  5     5         2         0              2       40.0%  0.118  cross-run flake
+com.example.SearchTest::filtersByPrice      5     5         2         0              2       40.0%  0.118  cross-run flake
+com.example.CheckoutTest::appliesCoupon     5     7         2         2              0       40.0%  0.118  passed-on-retry
+com.example.CartTest::addsItem              5     5         0         0              0       0.0%   0.000  stable
+com.example.ReportTest::exportsCsv          5     5         0         0              0       0.0%   0.000  skipped
+
+5 runs, 5 tests, 27 attempts, 5 XML files.
+```
+
+`appliesCoupon` has five runs but seven attempts and two passed-on-retry runs:
+the two red attempts are not lost. `explain` prints the timeline that produced
+the score (it prints absolute paths; they are shown here relative to the
+repository root):
+
+```console
+$ flake-ledger explain examples/runs 'com.example.CheckoutTest::appliesCoupon'
+com.example.CheckoutTest::appliesCoupon
+  classification: passed-on-retry
+  runs: 5  attempts: 7  unstable: 2/5  rate: 40.0%  score: 0.118
+
+  run run-01  passed-on-retry  2 attempts
+    examples/runs/run-01
+    #1 failed  examples/runs/run-01/results.xml
+         expected 10% discount, got 0
+    #2 passed  examples/runs/run-01/results.xml (retried)
+
+  run run-02  passed  1 attempt
+    examples/runs/run-02
+    #1 passed  examples/runs/run-02/results.xml
+
+  run run-03  passed-on-retry  2 attempts
+    examples/runs/run-03
+    #1 failed  examples/runs/run-03/results.xml
+         expected 10% discount, got 0
+    #2 passed  examples/runs/run-03/results.xml (retried)
+
+  run run-04  passed  1 attempt
+    examples/runs/run-04
+    #1 passed  examples/runs/run-04/results.xml
+
+  run run-05  passed  1 attempt
+    examples/runs/run-05
+    #1 passed  examples/runs/run-05/results.xml
+```
+
+Use the ledger as a CI gate and write the quarantine list. The table on stdout
+is the same one shown above, so it is omitted here:
+
+```console
+$ flake-ledger scan examples/runs --quarantine flaky.txt --fail-on 0.2 --min-runs 5 > /dev/null
+wrote 3 flaky test ids to flaky.txt
+flaky: com.example.LoginTest::rejectsExpiredToken unstable in 2/5 runs (40.0%) >= 20.0%
+flaky: com.example.SearchTest::filtersByPrice unstable in 2/5 runs (40.0%) >= 20.0%
+flaky: com.example.CheckoutTest::appliesCoupon unstable in 2/5 runs (40.0%) >= 20.0%
+flake-ledger: 3 flaky tests crossed --fail-on 0.2
+$ echo $?
+1
+$ cat flaky.txt
+com.example.LoginTest::rejectsExpiredToken
+com.example.SearchTest::filtersByPrice
+com.example.CheckoutTest::appliesCoupon
+```
+
+`--fail-on` and `--min-runs` are opt-in; without them the command is
+report-only and exits 0.
+
+## Measured on real test runners
+
+The checked-in example is hand-written. To check the parser against output it
+did not create, the same CLI was run against JUnit XML produced by pytest
+9.2.0 with pytest-rerunfailures 16.7 and by Playwright 1.65.0. Each fixture had
+ten runs, one directory per run; the test files, configs, and commands are in
+[`docs/real-world.md`](https://github.com/WJDdidi-1/flake-ledger/blob/main/docs/real-world.md).
+
+pytest-rerunfailures writes one `<testcase>` per attempt, so a test that failed
+once and then passed on retry appears as two passing testcases. From the
+fixture directory, `flake-ledger scan runs` printed:
+
+```console
+$ flake-ledger scan runs
+TEST ID                              RUNS  ATTEMPTS  UNSTABLE  PASS-ON-RETRY  FAILED  RATE    SCORE  CLASS
+test_checkout::test_always_failing   10    20        10        0              10      100.0%  0.722  failed-on-retry
+test_checkout::test_applies_coupon   10    20        10        10             0       100.0%  0.722  passed-on-retry
+test_checkout::test_cross_run_flake  10    10        5         0              5       50.0%   0.237  cross-run flake
+test_checkout::test_skipped          10    10        0         0              0       0.0%    0.000  skipped
+test_checkout::test_stable           10    10        0         0              0       0.0%    0.000  stable
+
+10 runs, 5 tests, 70 attempts, 10 XML files.
+```
+
+The recovered test is `passed-on-retry` in all 10 runs, the alternating test is
+`cross-run flake` in 5 of 10, and the stable and skipped tests stay in their
+classes.
+
+Playwright's JUnit reporter writes `<flakyError>`/`<rerunError>` only when
+`includeRetries: true` is set. With that option, two projects (chromium and
+firefox) and ten runs produced:
+
+```console
+$ flake-ledger scan runs
+TEST ID                                      RUNS  ATTEMPTS  UNSTABLE  PASS-ON-RETRY  FAILED  RATE    SCORE  CLASS
+checkout.spec.js::failures › always failing  10    40        10        0              10      100.0%  0.722  always-failing
+checkout.spec.js::checkout › applies coupon  10    40        10        10             0       100.0%  0.722  passed-on-retry
+checkout.spec.js::cross-run flake            10    20        5         0              5       50.0%   0.237  cross-run flake
+checkout.spec.js::skipped                    10    20        0         0              0       0.0%    0.000  skipped
+checkout.spec.js::stable                     10    20        0         0              0       0.0%    0.000  stable
+
+10 runs, 5 tests, 140 attempts, 10 XML files.
+```
+
+The recovered test is `passed-on-retry` in all 10 runs. `stable` has 20 attempts
+because both projects run it, but it is still `stable`: duplicate executions in
+separate Playwright project suites are not retries.
+
+**Playwright caveat:** with the default JUnit reporter, Playwright writes only
+the final attempt for each test, so the retry is not in the XML at all. With the
+same ten runs, the row for `checkout.spec.js::checkout › applies coupon` had 20
+attempts, 0 passed-on-retry runs, and class `stable`. `flake-ledger` cannot
+recover that retry from the file; set `includeRetries: true` (or
+`PLAYWRIGHT_JUNIT_INCLUDE_RETRIES=1`) if you want retry evidence in the ledger.
+
+## Who it is for
+
+Maintainers of multi-runner CI suites (pytest, Playwright, xUnit,
+cargo-nextest, Surefire) whose jobs keep going green only after a retry.
+
+## Why not the obvious answer
+
+pytest-rerunfailures, Playwright retries, and `--rerun-failed` only mask the
+failure; BuildPulse, Trunk, and Datadog CI Visibility are paid hosted
+dashboards; GitHub's flaky-test detection is confined to Actions. None offers a
+free, offline, cross-runner ledger plus a quarantine file.
+
+## Install
+
+From a checkout:
+
+```sh
+git clone https://github.com/WJDdidi-1/flake-ledger.git
+cd flake-ledger
+npm install --global .
+flake-ledger --version
+```
+
+The npm package is published by the release workflow when a `v*` tag is
+pushed. The latest release is `v0.1.1`:
+
+```sh
+npm install --global flake-ledger@0.1.1
+flake-ledger --version   # 0.1.1
+```
+
+To try it without a global install, run the checked-in five-run example:
+
+```sh
+npm run example
+```
+
+Requires Node.js 18 or newer. There are no runtime dependencies, and the
+published package contains the runtime (`bin/`, `lib/`), the checked-in example
+(`examples/`), package metadata, `README.md`, and `LICENSE`.
+
+## Use
+
+Point the scanner at a directory of JUnit XML. It reads recursively:
+
+```sh
+flake-ledger scan path/to/runs
+```
+
+Machine-readable output, top 10 only:
+
+```sh
+flake-ledger scan path/to/runs --json --top 10
+```
+
+Explain one test's per-run timeline, including XML paths and failure messages:
+
+```sh
+flake-ledger explain path/to/runs 'com.example.FooTest::eventuallyGreen'
+flake-ledger explain path/to/runs 'com.example.FooTest::eventuallyGreen' --json
+```
+
+Write the ids of flaky tests to a quarantine file, and fail CI when a flaky
+test crosses a threshold and has at least five eligible (non-skipped) runs:
+
+```sh
+flake-ledger scan path/to/runs --quarantine flaky.txt --fail-on 0.5 --min-runs 5
+```
+
+`--fail-on` accepts a fraction (`0.5`), a percentage (`50%`), or a whole
+percentage (`50`). Exit codes:
+
+- `0` — report written, or no flaky test crossed `--fail-on`.
+- `1` — a flaky test crossed `--fail-on`, or `explain` matched no test or more
+  than one test.
+- `2` — usage error, unreadable runs directory, or a quarantine file that
+  could not be written.
+
+### Scan options
+
+| Option | Meaning |
+| --- | --- |
+| `--json`, `-j` | Print JSON instead of the terminal table. |
+| `--top N` | Show only the N highest-ranked tests (totals still count every test). |
+| `--quarantine <file>` | Write the ids of flaky tests, one per line. |
+| `--fail-on <rate>` | Exit 1 when a flaky test's unstable rate is at or above `<rate>`. |
+| `--min-runs <n>` | With `--fail-on`, ignore tests with fewer than `n` eligible runs. |
+| `--group-by <mode>` | `auto` (default), `file`, or `parent`; controls what counts as one run. |
+
+## Input layout
+
+The first directory below `<runs-dir>` is one CI run, so every XML file inside
+it is a shard of that run:
+
+```text
+runs/
+  run-1/results.xml
+  run-1/retry-shard/results.xml
+  run-2/results.xml
+```
+
+XML files placed directly under `<runs-dir>` are separate runs unless their
+names carry a shard marker (`shard-1.xml`, `run-3-part-2.xml`). Top-level
+shard-named run directories (`run-3-shard-1/`, `run-3-shard-2/`) merge into one
+run as well. Use `--group-by file` to make every XML document its own run, or
+`--group-by parent` to group by immediate directory.
+
+Supported inputs are Surefire and compatible JUnit XML, including
+`<failure>`, `<error>`, `<skipped>`, `<flakyFailure>`, `<flakyError>`,
+`<rerunFailure>`, `<rerunError>`, `retry`/`retries`/`rerun`/`rerunCount`
+attributes, and repeated `<testcase>` elements for the same test. A malformed
+XML file produces a warning and does not hide healthy files.
+
+Real runners differ in how much of that they emit. pytest-rerunfailures
+recovers a test by writing the passing `<testcase>` again, so repeated passing
+testcases in one suite count as retry evidence. Playwright writes
+`<flakyError>`/`<rerunError>` only with `includeRetries: true`; without it its
+JUnit XML contains only the final attempt. The measured output from both
+runners is in [`docs/real-world.md`](https://github.com/WJDdidi-1/flake-ledger/blob/main/docs/real-world.md).
+
+## What it reports
+
+`scan` collapses all of those attempts into one record per `classname::name`
+and classifies it:
+
+| Classification | Meaning |
+| --- | --- |
+| `stable` | Every eligible run passed without retry evidence. |
+| `passed-on-retry` | A run ended green only after a retry. |
+| `cross-run flake` | The test both passed and failed across runs. |
+| `always-failing` | No run passed and at least one run failed. |
+| `failed-on-retry` | A run ended red after at least one retry. |
+| `skipped` | Every run skipped the test. |
+
+Flaky classifications are `passed-on-retry`, `cross-run flake`, and
+`failed-on-retry`; those are the records written by `--quarantine` and checked
+by `--fail-on`.
+
+The JSON output contains `totals`, `runs`, `warnings`, and one `tests` record
+per test (limited to the first N by `--top`) with its `attempts`,
+`unstableRuns`, `eligibleRuns`, `unstableRate`, Wilson `score`,
+`classification`, and `timeline`.
+
+## Use it in CI
+
+Collect one directory per CI run (artifact names become run ids), download the
+reports, and gate on the ledger:
+
+```yaml
+- uses: actions/download-artifact@v4
+  with:
+    path: runs
+- run: npm install --global flake-ledger
+- run: flake-ledger scan runs --fail-on 0.3 --min-runs 10 --quarantine flaky.txt
+```
+
+The command fails only when a flaky classification crosses the threshold. Keep
+the `flaky.txt` artifact or commit it if your test runner supports reading a
+quarantine list.
+
+## FAQ
+
+**Do I have to install it globally?**
+No. From a checkout, call the CLI through Node:
+
+```sh
+node bin/flake-ledger.mjs scan path/to/runs
+```
+
+A global install just makes `flake-ledger` available on your `PATH`.
+
+**Does it run or retry my tests?**
+No. `flake-ledger` reads JUnit XML that your test runner already produced; it
+does not execute tests, change retry settings, or modify reports.
+
+**Does it upload my reports anywhere?**
+No. `scan` and `explain` read local XML and write to stdout, `--json`, or the
+`--quarantine` file you name. There are no network calls and no runtime
+dependencies.
+
+**How do I fail CI only on well-evidenced flakes?**
+Combine both thresholds:
+
+```sh
+flake-ledger scan path/to/runs --fail-on 0.3 --min-runs 10
+```
+
+On a readable runs directory, this exits 1 only when a flaky classification has
+at least 10 eligible runs and an unstable rate of at least 30%; otherwise it
+exits 0. Without `--fail-on`, `scan` is report-only.
+
+**How much history do I need?**
+One run is enough to produce a ledger, and a single run can already show
+`passed-on-retry` evidence; cross-run flakes need at least two runs. The score
+is a 95% Wilson lower bound on the unstable rate, so use `--min-runs` to require
+enough history before `--fail-on` can fail the build.
+
+## How we know it works
+
+`npm test` builds temporary JUnit fixtures and exercises every feature above
+through the CLI: recursive scanning, shard merging, repeated testcases,
+Surefire `flakyFailure`/`rerunFailure`, retry attributes, all classifications,
+Wilson-bound table ordering, `--json`, `--top`, `--quarantine`, `explain`, and
+`--fail-on`/`--min-runs`.
+
+The checked-in fixture under [`examples/runs`](examples/runs) is a second,
+readable path through the same CLI: `npm run example` runs `scan`, `explain`,
+`--quarantine`, and the CI gate against it, and exits nonzero if the table,
+timeline, quarantine list, or exit codes change.
+
+The real-runner measurement in [`docs/real-world.md`](https://github.com/WJDdidi-1/flake-ledger/blob/main/docs/real-world.md)
+records the exact commands and output from pytest-rerunfailures and Playwright,
+including the Playwright `includeRetries` caveat.
+
+CI runs the suite on Ubuntu, macOS (Intel), and Windows for Node.js 18, 20, 22,
+and 24. Each job also packs the tarball, installs it into a clean directory,
+and runs the installed binary, so the published package is tested rather than
+just the checkout.
+
+From a checkout, the same commands run against the local entry point:
+
+```sh
+npm test
+node bin/flake-ledger.mjs scan path/to/runs
+```
+
+## Releases
+
+Versions are SemVer tags (`vMAJOR.MINOR.PATCH`) and must match `version` in
+`package.json`. Pushing a `v*` tag runs the publish workflow, which tests,
+packs the tarball, installs it into a clean directory, and publishes it to npm
+with provenance. The latest release is `v0.1.1`, matching `version` `0.1.1` in
+`package.json`.
+
+The changelog for each version lives in [`CHANGELOG.md`](CHANGELOG.md), the
+per-release GitHub Release bodies are in
+[`docs/releases`](https://github.com/WJDdidi-1/flake-ledger/tree/main/docs/releases),
+and the maintainer steps are in
+[`docs/RELEASING.md`](https://github.com/WJDdidi-1/flake-ledger/blob/main/docs/RELEASING.md).
+
+## Status
+
+Early MVP. The features above are the scope; anything not listed is not built
+yet.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).