Skip to content

docs: update npm distribution and CLI exec spec status#948

Merged
s977043 merged 1 commit into
mainfrom
docs/update-post-942-935-status
May 30, 2026
Merged

docs: update npm distribution and CLI exec spec status#948
s977043 merged 1 commit into
mainfrom
docs/update-post-942-935-status

Conversation

@s977043

@s977043 s977043 commented May 30, 2026

Copy link
Copy Markdown
Owner

Summary

Codex が指摘した陳腐化ドキュメントを修正。

変更内容

README.md

pages/reference/cli-review-exec-spec.md / .en.md

変更なし

  • artifact-input-contract.md line 140:GitHub Action の artifact input wiring は未実装のまま正確

Test plan

  • npm test — 1113 tests pass
  • lint-staged — pass

Refs #800

🤖 Generated with Claude Code

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]>
@vercel

vercel Bot commented May 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
ai-review-kit Ready Ready Preview, Comment May 30, 2026 10:37pm

@github-actions

Copy link
Copy Markdown
Contributor

No changes to review compared to main.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

このプルリクエストでは、README.md のロードマップや npm パッケージ公開に関する記述を更新し、river review exec --plan の実装状況に関するドキュメント(日本語版・英語版)を追記しています。レビューでは、日本語版 README.md の更新内容を英語版 README.en.md にも反映させること、および CLI 仕様書における --plan <file> の表記を既存の表に合わせて --plan <path> に統一することが提案されており、いずれもドキュメントの整合性を高めるための有益なフィードバックです。

Comment thread README.md
```

> 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` 体験は別途対応予定です

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

日本語版の README.md が更新されましたが、英語版の README.en.md にも同様の更新(npm publish ワークフローの実装状況やパッケージ名など)を反映させる必要があります。ドキュメントの整合性を保つため、README.en.md の対応する箇所も更新することを検討してください。

> 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

オプション一覧の表(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` 実行は未実装。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

オプション一覧の表(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 実行は未実装。

@github-actions

Copy link
Copy Markdown
Contributor

PlanGate Review

  • decision: pass
  • plan status: skipped-by-label
  • exec status: skipped-by-label

PlanGate review decision: pass

severity count policy
critical 0 fail
major 0 fail-if-required / warn
minor 0 comment-only
info 0 skipped

ポリシー: critical=fail / major=fail-if-required (warn) / minor=comment-only / info=skipped — spec: pages/reference/cli-review-plan-spec.md

@s977043 s977043 merged commit c07230f into main May 30, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant