From 503fec9247152b954bf4677e6a5ccbfef1254d05 Mon Sep 17 00:00:00 2001 From: kevinccbsg Date: Thu, 3 Sep 2026 19:58:12 +0200 Subject: [PATCH] docs: list the sharding inputs in the action inputs table The Action Inputs table documented 2 of the action's 5 inputs. `shard`, `report-dir` and `upload-report` shipped with sharding in 1.5.0 and were only discoverable by reading action.yml, even though the sharding section further down the README tells you to pass `shard`. Defaults match .github/actions/run/action.yml. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index bea5e1e..b772d13 100644 --- a/README.md +++ b/README.md @@ -209,6 +209,9 @@ jobs: |-------|---------|-------------| | `working-directory` | `.` | Directory where `twd.config.json` lives | | `contract-report` | `false` | Post contract validation summary as a PR comment | +| `shard` | (empty) | Run one shard of the suite, as `/` (e.g. `2/4`). Leave empty to run everything in one job. See [Sharding](#sharding-across-ci-jobs) | +| `report-dir` | `.twd/run` | Where the shard report is written. Only used when `shard` is set | +| `upload-report` | `true` | Upload the shard report as an artifact named `twd-run-`, the layout `twd-cli merge` expects. Only used when `shard` is set | #### With code coverage