docs: update npm distribution and CLI exec spec status#948
Conversation
README.md: - Mark npm publish workflow as implemented (#942, not roadmap) - Name the three publishable packages (@river-reviewer/*) - Note NPM_TOKEN activation step; npx river try is still separate - Update Epic 1 roadmap row: B2 implemented, token setup pending pages/reference/cli-review-exec-spec.md/.en.md: - Add addendum: river review exec --plan <file> is now implemented via PR #935 (2026-05-29), produces Review Artifact via generateReview - Note: exec without --plan still exits 3 Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No changes to review compared to main. |
There was a problem hiding this comment.
Code Review
このプルリクエストでは、README.md のロードマップや npm パッケージ公開に関する記述を更新し、river review exec --plan の実装状況に関するドキュメント(日本語版・英語版)を追記しています。レビューでは、日本語版 README.md の更新内容を英語版 README.en.md にも反映させること、および CLI 仕様書における --plan <file> の表記を既存の表に合わせて --plan <path> に統一することが提案されており、いずれもドキュメントの整合性を高めるための有益なフィードバックです。
| ``` | ||
|
|
||
| > npm パッケージとしての配布、`npx river try` 体験はロードマップ化されています(Epic 1 / [#800](https://github.com/s977043/river-reviewer/issues/800))。 | ||
| > npm publish ワークフローと `publishConfig` は実装済みです([#942](https://github.com/s977043/river-reviewer/pull/942))。`NPM_TOKEN` シークレットを設定すると `@river-reviewer/core-runner`・`@river-reviewer/node-api`・`@river-reviewer/cli-runner` の公開が有効化されます([#800](https://github.com/s977043/river-reviewer/issues/800))。`npx river try` 体験は別途対応予定です。 |
| > Addendum (#802 Phase 3, 2026-05-18): **`river review exec --dry-run` (without `--plan`) is implemented.** Per spec, dry-run makes no external LLM / skill execution — it only resolves inputs and produces a deterministic plan, emitting a v1 Review Artifact with `status` `ok`/`no-changes` and `findings: []`, exit 0 (it reuses `runReviewPlan`, the same non-breaking path as `river review plan --plan-only`). Non-dry-run `exec`, `--plan` replay, and `verify` execution remain unimplemented (exit 3). | ||
| > Addendum (#802 Phase 3, 2026-05-18): **`river review exec --dry-run` (without `--plan`) is implemented.** Per spec, dry-run makes no external LLM / skill execution — it only resolves inputs and produces a deterministic plan, emitting a v1 Review Artifact with `status` `ok`/`no-changes` and `findings: []`, exit 0 (it reuses `runReviewPlan`, the same non-breaking path as `river review plan --plan-only`). | ||
| > | ||
| > Addendum ([#935](https://github.com/s977043/river-reviewer/pull/935), 2026-05-29): **`river review exec --plan <file>` is now implemented.** It reads the plan file, executes skills via `generateReview`, and produces a Review Artifact. Non-dry-run `exec` without `--plan` still returns exit 3. `verify` execution remains unimplemented. |
There was a problem hiding this comment.
オプション一覧の表(55行目)では --plan <path> と定義されているため、追記部分の表記も <file> ではなく <path> に統一することで、ドキュメント内の整合性と正確性が向上します。\n\n以下のように修正することを提案します:\n> Addendum ([#935](https://github.com/s977043/river-reviewer/pull/935), 2026-05-29): **river review exec --plan is now implemented.** It reads the plan file, executes skills viagenerateReview, and produces a Review Artifact. Non-dry-run execwithout--planstill returns exit 3.verify execution remains unimplemented.
| > 追補(#802 Phase 3、2026-05-18): **`river review exec --dry-run`(`--plan` 併用なし)は実装済み**。spec どおり外部 LLM・skill 実行を行わず、入力解決 + 決定論 plan のみを実行し、`status` は `ok` / `no-changes`、`findings` は `[]`、Review Artifact v1 を出力して exit 0(`runReviewPlan` を再利用、`river review plan --plan-only` と同一の非破壊経路)。通常 `exec`(非 dry-run)、`--plan` 再生、verify 実行は引き続き未実装で exit 3。 | ||
| > 追補(#802 Phase 3、2026-05-18): **`river review exec --dry-run`(`--plan` 併用なし)は実装済み**。spec どおり外部 LLM・skill 実行を行わず、入力解決 + 決定論 plan のみを実行し、`status` は `ok` / `no-changes`、`findings` は `[]`、Review Artifact v1 を出力して exit 0(`runReviewPlan` を再利用、`river review plan --plan-only` と同一の非破壊経路)。 | ||
| > | ||
| > 追補([#935](https://github.com/s977043/river-reviewer/pull/935)、2026-05-29): **`river review exec --plan <file>` は実装済み**。plan ファイルを読み込み `generateReview` 経由で skill を実行し Review Artifact を出力する。`--plan` なしの通常 `exec`(非 dry-run)は引き続き exit 3。`verify` 実行は未実装。 |
There was a problem hiding this comment.
オプション一覧の表(56行目)では --plan <path> と定義されているため、追記部分の表記も <file> ではなく <path> に統一することで、ドキュメント内の整合性と正確性が向上します。\n\n以下のように修正することを提案します:\n> 追補([#935](https://github.com/s977043/river-reviewer/pull/935)、2026-05-29): **river review exec --plan は実装済み**。plan ファイルを読み込みgenerateReview 経由で skill を実行し Review Artifact を出力する。--planなしの通常exec(非 dry-run)は引き続き exit 3。verify 実行は未実装。
PlanGate Review
PlanGate review decision: pass
ポリシー: critical=fail / major=fail-if-required (warn) / minor=comment-only / info=skipped — spec: |
Summary
Codex が指摘した陳腐化ドキュメントを修正。
変更内容
README.md
@river-reviewer/core-runner/node-api/cli-runner)を明記pages/reference/cli-review-exec-spec.md / .en.md
river review exec --plan <file>が PR feat(cli): --plan replay execution wires generateReview (#878 A2-3-impl) #935(2026-05-29)で実装済みであることを追記--planなし exec はまだ exit 3 のままであることを明記変更なし
artifact-input-contract.mdline 140:GitHub Action の artifact input wiring は未実装のまま正確Test plan
npm test— 1113 tests passRefs #800
🤖 Generated with Claude Code