You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: cover report --coverage on the npm page and refresh the quality-gate notes (#13)
- `launcher/README.md` (npm page): `report --coverage` usage line and a
paragraph on Istanbul coverage input (lands on npmjs.com with the next
launcher release).
- `docs/quality-gate.md`: the reusable workflow bullets now describe the
opt-in `report` / `coverage-artifact` inputs and the six
caller-controlled inputs; the consumption line mentions the npm launcher
and the `CODE_QUALITY_IMAGE` override.
Fact-checked against the code (a failing `report` step does fail the
job; wording reflects it). No code changes, no release.
Copy file name to clipboardExpand all lines: docs/quality-gate.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,8 +75,8 @@ Each adapter writes `quality/<adapter-id>-baseline.json` with schema version 1,
75
75
- A reduction-only `baseline` update may write a current snapshot only when there is no regression.
76
76
-`check --initialize` writes a missing snapshot, including an empty findings map, but never replaces an existing snapshot.
77
77
- Tool-version and config-hash mismatches require a reviewed regeneration: remove the affected snapshot and initialize it again.
78
-
- The reusable workflow runs plain `check` and never writes baselines; `GITHUB_ACTIONS=true` also protects the CLI from update, initialize, baseline, and init writes.
79
-
- The reusable workflow accepts only lowercase, space-separated check IDs and fixes its image registry and repository to `ghcr.io/runroom/code-quality`; only `image-tag` is caller-controlled.
78
+
- The reusable workflow runs plain `check` and never writes baselines; `GITHUB_ACTIONS=true` also protects the CLI from update, initialize, baseline, and init writes. With the opt-in `report` input it also runs `code-quality report` after the check (its findings are advisory and never enter the gate, though a failing `report` step still fails the job) and uploads `artifacts/quality` as the `quality-reports` artifact; the optional `coverage-artifact` input downloads a coverage artifact for the Fallow health report.
79
+
- The reusable workflow accepts only lowercase, space-separated check IDs and fixes its image registry and repository to `ghcr.io/runroom/code-quality`; the caller controls only `image-tag`, `checks`, `setup`, `working-directory`, `report`, and `coverage-artifact`, and the coverage artifact name is validated before use.
80
80
- Tool subprocesses inherit only approved environment variables plus constant and invocation-specific tool settings.
81
81
82
82
The comparison is per key. A reduction in one finding cannot fund an increase in another finding. Native parser errors, unknown records, incomplete reports, invalid paths, and duplicate normalized keys fail closed.
@@ -183,4 +183,4 @@ A tool version bump is a policy change and follows these five steps:
183
183
4. Build and release the new image tags.
184
184
5. Have consumers explicitly regenerate affected snapshots after reviewing the changes; ordinary `--update` is not a tool-version migration mechanism.
185
185
186
-
The v1 workflow and image are consumed through `@v1` and `v1`. A breaking CLI, snapshot, parser, or policy contract starts a new major line.
186
+
The v1 workflow and image are consumed through `@v1` and `v1`, and the npm launcher `@runroom/code-quality` through `@1`; launcher X.Y.Z runs image vX.Y.Z unless `CODE_QUALITY_IMAGE` overrides it. A breaking CLI, snapshot, parser, or policy contract starts a new major line.
`CODE_QUALITY_IMAGE` overrides the image and is validated as an image reference. Set it only to an image you trust because the current directory is mounted read-write into the container.
30
31
32
+
`report --coverage <path>` (or the `report.coverage` key in `.code-quality.yml`, available from 1.2.0) gives Fallow an Istanbul `coverage-final.json` map, or a directory containing it, so the advisory CRAP values use measured coverage instead of the 0 % estimate. Vitest's `json` coverage reporter writes that format with either the V8 or Istanbul provider; raw V8 output is not supported. The path must be repository-relative and the blocking checks are not affected.
33
+
31
34
`CI`, `GITHUB_ACTIONS`, `NO_COLOR`, and `FORCE_COLOR` are forwarded to the container. `--color` and `--no-color` override everything; otherwise a non-empty `NO_COLOR` disables color, then `FORCE_COLOR` (any value but `0`) forces it, then color is on in GitHub Actions or when stdout is a TTY.
0 commit comments