Skip to content

docs: add machine-readable deprecation markers to extension READMEs - #2935

Merged
cabljac merged 1 commit into
kitsfrom
extension-deprecation-markers
Aug 6, 2026
Merged

docs: add machine-readable deprecation markers to extension READMEs#2935
cabljac merged 1 commit into
kitsfrom
extension-deprecation-markers

Conversation

@cabljac

@cabljac cabljac commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a machine-readable deprecation marker plus a visible deprecation notice to each extension whose replacement kit exists on the kits branch. 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.md and the READMEs are regenerated with lerna run generate-readme (firebase ext:info --markdown), since READMEs are generated files.

Marker format (HTML comment, invisible when rendered):

<!-- FIREBASE_EXTENSION_REPLACEMENT: extension="firebase/firestore-send-email" package="@firebase/firestore-send-email" -->

> **Deprecation Notice:** The Firebase Extension `firebase/firestore-send-email` is deprecated. Please migrate to the [`@firebase/firestore-send-email`](https://www.npmjs.com/package/@firebase/firestore-send-email) package.

Extensions covered

Extension Replacement package
firebase/delete-user-data @firebase/delete-user-data
firebase/firestore-bigquery-export @firebase/firestore-bigquery-export
firebase/firestore-counter @firebase/firestore-counter
firebase/firestore-send-email @firebase/firestore-send-email
firebase/firestore-translate-text @firebase/firestore-translate-text
firebase/rtdb-limit-child-nodes @firebase/rtdb-limit-child-nodes
firebase/storage-resize-images @firebase/storage-resize-images

Notes

  • firestore-shorten-urls-bitly has no kit yet, so no marker.
  • Kits for googlecloud/* extensions (firestore-genai-chatbot, firestore-incremental-capture, speech-to-text, firestore-vector-search, bigquery-firestore-export) and firestore-bundle-builder need the same treatment in their own source repos - separate PRs.
  • Supersedes the kit-README markers in docs(kits): add machine-readable deprecation markers to kit READMEs #2934; that PR is being reduced to its CI fixes.

@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 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.

@cabljac
cabljac force-pushed the extension-deprecation-markers branch from 58a71f0 to 25f581b Compare August 6, 2026 09:48
@cabljac
cabljac requested a review from a team as a code owner August 6, 2026 09:48
@cabljac
cabljac changed the base branch from next to kits August 6, 2026 09:48
@cabljac
cabljac merged commit a8b0bd2 into kits Aug 6, 2026
21 checks passed
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.

1 participant