Skip to content

docs(kits): document differences from the legacy extensions - #2948

Open
IzaakGough wants to merge 1 commit into
kitsfrom
docs/kit-differences
Open

docs(kits): document differences from the legacy extensions#2948
IzaakGough wants to merge 1 commit into
kitsfrom
docs/kit-differences

Conversation

@IzaakGough

@IzaakGough IzaakGough commented Aug 17, 2026

Copy link
Copy Markdown

Every kit's changelog said only "Initial release", and nothing told a user moving off an installed extension instance what would behave differently.

Each kit README gains a ## Differences from the <extension> extension section, and the changelog entry points at it. Twelve kits are covered. firestore-incremental-capture is untouched: this kit is still in the process of being implemented and tested.

Each section covers only what a migrating user acts on: settings renamed or newly defaulted, install-time validation that now fails at runtime, secrets that must exist by name, region and generation changes, data shape changes, and tooling that did not come across. Shared template differences (extension.yaml to npm package, params, HandlerContext, gen1 to gen2 boilerplate) are deliberately left out.

Verified by reading the extension and kit source for each pair, plus the extension.yaml params. Nothing was exercised against a live deploy, and each section says so where a claim depends on one.

Two decisions for a reviewer: whether the section belongs before ## API surface, where it is now, or higher up in each README; and whether to leave the firestore-incremental-capture changelog as it is.

Each kit's README gains a "Differences from the <extension> extension"
section covering the migration traps, behavioural changes and missing
tooling a user moving off an installed instance needs to know. The
changelog entry now points at it.

firestore-incremental-capture is untouched: it is a private, unimplemented
skeleton package with nothing to compare against.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the CHANGELOG.md and README.md files across multiple Firebase kits, including bigquery-firestore-export, delete-user-data, firestore-bigquery-export, firestore-bundle-builder, firestore-counter, firestore-genai-chatbot, firestore-send-email, firestore-translate-text, firestore-vector-search, rtdb-limit-child-nodes, speech-to-text, and storage-resize-images. The updates introduce a comprehensive 'Differences' section in each README to guide users migrating from the legacy Firebase Extensions to these repackaged npm packages, detailing changes in configuration, runtime behavior, and deployment regions. As there are no review comments provided, I have no feedback to offer.

@IzaakGough
IzaakGough marked this pull request as ready for review August 18, 2026 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants