docs(kits): add machine-readable deprecation markers to kit READMEs - #2934
Conversation
There was a problem hiding this comment.
Code Review
This pull request adds deprecation notices and replacement HTML comments to the README files of several Firebase extension kits. The reviewer suggested wrapping the attribute values in the HTML comments in double quotes to ensure robust parsing and standard formatting.
|
Applied the quoting suggestion to all 8 READMEs. Also fixed the two CI failures, both pre-existing on the kits branch (from the recently added storage-resize-images and firestore-vector-search kits, not the README changes):
|
|
You acted very quickly, but unfortunately what you were told in chat is wrong. We don't need the markup on extension replacement in kits README files. The must be in the extension source files, e.g., the readme that you'd see if you follow the "source code" link from an Extension page like: https://extensions.dev/extensions/firebase/firestore-bigquery-export |
Summary
Adds a machine-readable deprecation marker plus a visible deprecation notice to the top of each kit README on the
kitsbranch. A scraping script can pick up the HTML comment to power CLI warnings and migration nudges for users of the deprecated extensions.Marker format:
The marker includes an
extension=field alongsidepackage=so the scraper does not need to infer the extension ID from the repo path. This matters because publishers differ across kits:Notes