docs: add machine-readable deprecation markers to extension READMEs - #2935
Merged
Conversation
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds deprecation notices and replacement comments to the PREINSTALL.md and README.md files of several Firebase extensions, directing users to migrate to their corresponding scoped npm packages. There are no review comments, so I have no feedback to provide.
This was referenced Aug 6, 2026
cabljac
marked this pull request as ready for review
August 6, 2026 09:47
cabljac
force-pushed
the
extension-deprecation-markers
branch
from
August 6, 2026 09:48
58a71f0 to
25f581b
Compare
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.
Summary
Adds a machine-readable deprecation marker plus a visible deprecation notice to each extension whose replacement kit exists on the
kitsbranch. Markers live in the extension READMEs (not the kit READMEs) so that someone with write access to the extension source is officially designating the replacement kit - see discussion with Varun and Andy.Markers are added to
PREINSTALL.mdand the READMEs are regenerated withlerna run generate-readme(firebase ext:info --markdown), since READMEs are generated files.Marker format (HTML comment, invisible when rendered):
Extensions covered
Notes
firestore-shorten-urls-bitlyhas no kit yet, so no marker.googlecloud/*extensions (firestore-genai-chatbot, firestore-incremental-capture, speech-to-text, firestore-vector-search, bigquery-firestore-export) andfirestore-bundle-builderneed the same treatment in their own source repos - separate PRs.