docs(firestore-send-email): kit/extension parity – README differences and setup steps are wrong in several places
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 72/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- firebase, typescript
調査の方向性
issue でリンクされている firestore-send-email の README セクションと CHANGELOG から始め、各記述を issue に記載された firebase-tools 15.31.0 の再現された動作と比較してください。パッケージと実験的機能の要件を含め、セットアップ、移行、リージョン、パラメータ、デプロイに関する案内を更新してください。README と CHANGELOG が、列挙されたすべての相違点と回避策を正確に説明していれば完了です。
索引モデルが issue の本文から書いたものです。
説明
firestore-send-email kit/extension parity. Priority: low. Several README statements about setup and about the differences from the extension are wrong for firebase-tools 15.31.0.
Difference
| README says | Actually |
|---|---|
Secrets are "named exactly SMTP_PASSWORD…", and the extension's secrets "are not picked up" (L157-L169) |
With a kit stanza they are kit-<instance>-<NAME>. ext:migrate reuses the extension's secret through FIREBASE_SECRET_REF_SMTP_PASSWORD (seen in a migrated .env) |
The extension "offered no location setting" / "Nothing reads" FUNCTION_DEFAULT_REGION (L173-L175, L199-L202) |
Extensions have a location setting (an instance in europe-west2 was migrated). The install and migrate templates read FUNCTION_DEFAULT_REGION, and it decides the region when DATABASE_REGION is blank |
| Changing the region "deletes and recreates the function" (L216-L221) | The CLI creates the new function before deleting the old one. A non-interactive deploy aborts with deletion cannot proceed in non-interactive mode unless you pass --force (reproduced) |
EXT_SELECTED_EVENTS "cannot be set" (L227-L232) |
It is allowed, ext:migrate writes it, and the kit honours it (only onComplete was published when set) |
A bad URI "fails at send time with delivery.state: ERROR" (L242-L243) |
A blank or unparseable URI leaves documents with no delivery field |
| Every variable "keeps its name, type and default"; "ported verbatim", "version 0.2.10" (L148-L153, L270-L272) | OAUTH_PORT, OAUTH_SECURE and TTL_EXPIRE_VALUE changed type. Several optional params gained defaults. nodemailer is 7, not 9 |
| The CLI "prompts for any required values that are missing" (L87-L88) | A non-interactive deploy fails unless every param, including ones with defaults, is in .env |
Configure "with a .env (or .env.<projectId>)" (L49) |
.env.<projectId>, which kits:install, ext:migrate and interactive deploys write, silently overrides edits to .env |
Deploy example with instance id default (L57-L70) |
Fails in any project that already has a default functions codebase: "functions codebase name and kit instance ID must be mutually exclusive" |
firebase ext:migrate is a supported path |
firebase-tools lists this extension as PENDING_PUBLISHER, so a plain ext:migrate fails with "does not have an associated function kit". It needs --package @firebase-function-kits/firestore-send-email@next and the extMigrationFeatures and secretEnvParams experiments |
CHANGELOG: eventarcpublishing.googleapis.com "is enabled on your project whether or not you use events" |
A non-interactive deploy without --force fails with "Must enable required APIs to deploy" if the API is disabled |
Reproduced
Each row was checked on the test project or against firebase-tools 15.31.0. The rows marked "reproduced" were run live.
Resolution
Correct each statement in the README and CHANGELOG. Document the --package / experiments requirement until the replacement listing is published.
- 主要言語
- TypeScript
- スター
- 979
- フォーク
- 436
- 平均マージ
- 2日 13時間
- マージ済み PR(30日)
- 18
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
firebase/extensions のほかの issue
-
kits parity type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
firebase/extensions#3303 ·
メンテナーはふだん 1 日以内に返信
-
kits parity type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
firebase/extensions#3301 ·
メンテナーはふだん 1 日以内に返信
-
kits parity type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
firebase/extensions#3296 ·
メンテナーはふだん 1 日以内に返信
-
kits parity type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
firebase/extensions#3294 ·
メンテナーはふだん 1 日以内に返信
-
kits parity type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
firebase/extensions#3291 ·
メンテナーはふだん 1 日以内に返信
firebase/extensions の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
Slaymish/HealthAgent#7 ·
-
area: engine topic: math type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
Get-Concord-AI/concord-mcp#310 ·
メンテナーはふだん 1 日以内に返信
-
Correct install_claude: 'marketplace add' over a different source is refused, not replaced in placeオープンtype:bug
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
nightgauge/nightgauge#2804 ·
メンテナーはふだん 1 日以内に返信