docs: README.en.md を receiver の現行契約に同期する (#105) - #107
Merged
Conversation
#103(inbox ログイン + CORS 制限)・#104(healthz / graceful shutdown / 設定警告)・#106(ingest key)で README.md に入れた receiver 契約の変更を 英語版にミラーする: - RECEIVER_TOKEN の説明を「閲覧系も保護 + inbox ログイン(HMAC cookie)」に更新 - INGEST_KEYS / ALLOWED_ORIGINS の項目を追加 - healthz・graceful shutdown・invalid setting warning を追記 - Public Deployment (EC2 etc.) 節を新設 - Init options に ingestKey を追加、Current Boundary の Auth 行を更新 Closes #105 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LRdDjwxbAAaTMwwnzipkau
Owner
Author
🔍 レビュー依頼(→ Codex)
|
Owner
Author
📋 レビュー結果(by Codex GPT-5.5)判定: ✅ merge 可(must 0 件) — 🟡 should / ⚪ nit も 0 件 🔴 mustなし 🟡 shouldなし ⚪ nitなし レビュアーの検証範囲(要旨)README.en.md の差分全体を、server/receive.js(auth route table / cookie / 401・403 / healthz / shutdown / CORS / 警告ログ)および widget/src/index.js(ingestKey 送信)と突き合わせて実装との一致を確認。README.md の対応箇所との同値性、secret・内部参照の混入なしも確認。 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
Issue #105。README.md(日本語)は #103 / #104 / #106 で receiver の契約変更に追従済みだが、ミラーの README.en.md が古いままだったので同期する(PR #104 の Codex レビュー ⚪ nit 起点。#101 と同型のドキュメント同期 PR)。
変更内容(すべて README.md の既存記述の英訳ミラー)
RECEIVER_TOKEN: 「read-only GETs are not gated」→ 閲覧系も保護 + inbox ログイン(HMAC 派生 cookie、7 日、Secure 条件、ローテで全失効)に更新INGEST_KEYS/ingestKeys(projectId 紐付け含む)とALLOWED_ORIGINSの項目を追加GET /healthz/ graceful shutdown の bullet を追加limits:/rate limit:サマリの段落を追加ingestKeyを追加テスト
npm run check全 105 件パス(docs のみ、コード変更なし)。Closes #105
🤖 Generated with Claude Code
https://claude.ai/code/session_01LRdDjwxbAAaTMwwnzipkau