| mode | Action mode:
- "report" (default): surface BDD stories as PR comment + HTML artifact
- "review": generate an Evidence Review of the PR's changes — correlate the run to the diff and
band changed code as uncovered / weak / strong. Requires a run JSON (see run-json).
- "gate-release": verify a release candidate matches the dev test baseline
- "deploy": record a deployment to the environment ledger
For a living-docs site, scaffold once with `executable-stories init-astro` and
deploy with `astro build` in your own workflow (see the README). It is no longer
a mode of this action.
| no | report |
| report-dir | Directory containing or receiving generated reports | no | reports |
| output-name | Base filename for reports (without extension) | no | test-results |
| raw-run | Path to raw run JSON (auto-detected if not set) | no | .executable-stories/raw-run.json |
| formatter-version | Version of executable-stories binary to download (latest or semver) | no | latest |
| artifact-name | Name for the uploaded GitHub artifact | no | executable-stories-report |
| comment-title | Header text for the PR comment | no | Executable Stories |
| host-images | How to handle inline screenshots so GitHub renders them in the PR comment.
- "false" (default): replace inline base64 data URIs with a placeholder (full images remain in the HTML artifact). No write permissions needed.
- "branch": commit screenshots to an orphan branch on this repository and rewrite the markdown to reference raw.githubusercontent.com URLs. Requires `contents: write` permission on the workflow.
| no | false |
| images-branch | Branch name used when host-images: branch. Created as an orphan branch on first use. | no | executable-stories-images |
| gate-dev-run | (gate-release) Path to the dev environment test run to use as baseline | no | — |
| gate-fail-on-regression | (gate-release) Fail if scenarios regressed from dev to RC (default: true) | no | true |
| gate-fail-on-removal | (gate-release) Fail if scenarios in dev are missing from RC (default: true) | no | true |
| gate-fail-on-new | (gate-release) Fail if new scenarios appear in RC not in dev | no | false |
| gate-release-policy | (gate-release) Path to release policy JSON with allowed exceptions | no | — |
| deploy-env | (deploy) Environment name to record the deployment against (e.g. dev, staging, production) | no | — |
| deploy-tag | (deploy) Git tag for this deployment (e.g. v1.2.3) | no | — |
| deploy-ledger | (deploy) Path to deployment ledger JSON | no | .executable-stories/deployments.json |
| run-json | (review mode) Path to the run JSON (raw or canonical) to correlate against the diff. Defaults to raw-run. | no | "" |
| base-ref | (review mode) Base ref to diff against. Defaults to the PR base branch (GITHUB_BASE_REF). | no | "" |
| changed-files | (review mode) Optional precomputed changed-files file (JSON or `git diff --name-status` text). If unset, the action computes it from git. | no | "" |
| fail-on | (review mode) Opt-in gate: 'uncovered' or 'weak' — fail the check when changed code lacks evidence. Default: off. | no | "" |
| min-evidence | (review mode) Opt-in gate: 'weak' | 'moderate' | 'strong' — fail when any claim is below this strength. Default: off. | no | "" |
| formatter-binary | Path to a prebuilt executable-stories binary to use instead of downloading from Releases (for dev/testing before release). | no | "" |