docs(firestore-send-email): kit/extension parity – README differences and setup steps are wrong in several places
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 72/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- firebase, typescript
调研方向
从 issue 中链接的 firestore-send-email README 章节及其 CHANGELOG 入手；将每项陈述与 issue 中列出的 firebase-tools 15.31.0 复现行为进行比较。更新有关设置、迁移、区域、参数和部署的指南，包括 package 和实验功能要求。完成标准是 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 小时
- 30 天内合并 PR
- 18
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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 天内回复