Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

docs(firestore-send-email): kit/extension parity – README differences and setup steps are wrong in several places

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#3,300 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
firebase, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với các phần README của firestore-send-email được liên kết trong issue và CHANGELOG của nó; đối chiếu từng nội dung với hành vi firebase-tools 15.31.0 đã được tái hiện và liệt kê trong issue. Cập nhật hướng dẫn về thiết lập, di chuyển, khu vực, tham số và triển khai, bao gồm các yêu cầu về package và tính năng thử nghiệm. Hoàn thành khi README và CHANGELOG mô tả chính xác mọi khác biệt và cách khắc phục được liệt kê.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation kits parity

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.

Ngôn ngữ chính
TypeScript
Star
979
Fork
436
Merge trung bình
2 ngày 13 giờ
Pull request đã merge (30 ngày)
18

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của firebase/extensions

Tất cả issue của firebase/extensions

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.