docs(installation, README): state that the release tag is the only version source - #223
Conversation
docs/installation.md と .ja.md に "Versioning and published artifacts" 節を追加し、 公開成果物の版数は GitHub Release の tag だけがソースであり、リポジトリ内の version フィールドはどれも公開値に届かないことを明記した。cd.yml が npm / mcpb 双方で tag から版数を振り直している事実と、各 version フィールドの役割 （root は private、mcp-server の package.json / manifest.json は公開時に上書き される placeholder、server.json は release workflow が触らない registry metadata）を表で示している。README.md / README.ja.md には同じ事実を一文で置き、 詳細節へリンクした。 背景: リポジトリ内の version 値と公開版数の乖離は cd.yml の設計どおりだが、 その手がかりが読み手の踏む場所に無く、乖離を不整合と誤読する経路が実際に 発生した。挙動・version 値は変更していない。ドキュメントのみ。 Refs #222
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
github-rag-mcp | cddcb63 | Aug 06 2026, 04:55 AM |
liplus-lin-lay
left a comment
liplus-lin-lay
left a comment
There was a problem hiding this comment.
セルフレビュー結果: pass
受入基準チェック（issue #222 の制約）
| 制約 | 実装 | 判定 |
|---|---|---|
| 1. 版数フィールドを増やさない | 新しい版数の置き場は作らず、「タグがソース」という事実のみ記述 | 満たす |
2. cd.yml の挙動を変えない |
ワークフロー無改変。docs 4ファイルのみ | 満たす |
| 3. リポジトリ内の version 値を書き換えない | 値の変更ゼロ。「手で直すものではない」と明記 | 満たす |
| 4. 読み手が踏む場所を選ぶ / 日英を揃える | installation docs を選択（0-requirements.md に release/distribution 節が実在しないことを確認した上での判断）。行数 474/474・218/218 で parity |
満たす |
検証
- ja 版にも同一の英語見出し
## Versioning and published artifactsが入っており、README 両版のアンカー#versioning-and-published-artifactsが解決する。 - 引用された2つの書き換えコマンド（npm / mcpb）を
cd.ymlの literal と突き合わせて一致を確認。 - CI =
test/CI/Workers Buildsの3本とも SUCCESS。
配置判断について
issue の制約4は記述先を実装側の判断に委ねていた。docs/0-requirements.md を選ばなかった根拠が実読に基づいている点を評価する — 同ファイルに release/distribution の節は存在せず、release は索引対象の type として現れるだけだった。issue 本文が想定した「リリース/配布の記述がある面」は事実として無く、前提の誤りを実物で正した上での配置。
スコープ逸脱
なし。
検討したが起票しなかった事項
mcp-server/server.json にも version（0.1.0）があり、cd.yml はこれを書き換えない（package.json / manifest.json とは非対称）。npm tarball には含まれる。
issue を切らない判断とした理由: 現状このファイルを読む消費者がリポジトリ内に存在しない（MCP registry への publish 経路が無い）。休眠フィールドであり、事実は本 PR の表に行として記録された。将来 registry 公開を足す作業がその行に当たる形になる。消費者の無い不整合に先回りで issue を立てるのは rules/model/subtractive-structural-beauty.md の push surplus 側。
次の期待
auto モードにつき人間ゲートなし。リリース種別 patch（ドキュメントのみ、observable な挙動変化なし）。self-review pass によりマージへ進む。
1 participant
Closes #222
変更内容
公開成果物の版数のソースが GitHub Release の tag だけであること、リポジトリ内の
versionフィールドはどれも公開値に届かないことをドキュメントに明記した。挙動は変更していない。docs/installation.md/docs/installation.ja.md## Troubleshootingの直前に## Versioning and published artifacts節を追加。.github/workflows/cd.ymlがrelease: publishedで走り、pack / publish の前に tag から版数を振り直していること（npm 側はnpm version "${TAG_NAME#v}" ...、mcpb 側はjq ... '.version = $v' manifest.json）各 version フィールドの役割を表で提示
package.json（root）private: trueで非公開mcp-server/package.jsonmcp-server/manifest.jsonmcp-server/server.json乖離は設計どおりであり手で合わせる対象ではないこと（次のリリースが tag から上書きするため、手編集は「このファイルが権威である」という誤った印象を残すだけ）
実際の公開版数の確認先（
gh release list/npm view github-rag-mcp version）README.md/README.ja.md## Installationの直後に## Versioning節を追加。同じ事実を一文で置き、上記の詳細節へアンカーリンクした。リポジトリ入口から版数の疑問が上記の節に着地する経路を作るのが目的で、正本は installation 側に置いている。制約への対応
issue #222 の制約 1-4 はすべて満たしている。
cd.ymlは未変更記述先の判断について
docs/0-requirements.mdにはリリース / 配布そのものの記述が無く（releaseは索引対象の item type として出てくるのみ）、この事実の置き場としては installation 側が適切と判断した。補足
mcp-server/server.jsonのversionはcd.ymlが書き換えていないことを確認した上で表に載せている（リポジトリ内でserver.jsonを参照しているのはmcp-server/package.jsonのfilesのみ）。この事実の記載は挙動を変えるものではなく、同種の誤読を防ぐための手がかりとして置いた。リリース種別
patch。ドキュメントのみで user/system observable な挙動変化なし。