docs(storage-resize-images): kit README's Multiple instances section fails in an installed project
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 77/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- firebase, typescript
- Domain
- documentation
Research direction
Read the storage-resize-images kit README's Configuration and Multiple instances sections. Document the functions:kits:install and functions:kits:uninstall --instance workflow, including the installed layout and behavior described in the issue, and explain that an empty IS_ANIMATED= means false. Done when the README clearly covers creating and removing instances and the animation setting.
Written by the indexing model from the issue text.
Description
storage-resize-images kit. Priority: low. Following the README's multiple-instance steps fails in an installed project, and two behaviours are undocumented.
Problems
- The "Multiple instances"
firebase.jsonfails in a project created byfirebase functions:kits:install:
What works is the layout the install writes: source atError: Could not detect runtime for functions at <project dir>function-kits/storage-resize-images/sourcewith itssourcePackageandpredeployentries, and oneconfig-<id>directory per instance, each with a full.env(includingFUNCTION_DEFAULT_REGION). Running the install a second time adds an instance, but always with idstorage-resize-imagesand an empty.env. The README mentions neither route. - Removing one instance isn't documented.
firebase functions:kits:uninstall --instance <id>removed that instance's function, Cloud Run service, Eventarc trigger, service account, config directory andfirebase.jsonentry, and left the other instance running. - An empty
IS_ANIMATED=drops animation. It deploys without warning, and a 5-frame gif and webp both come out as one frame. The Configuration table lists the default astrue. The extension can't be installed with an empty value, and by reading its parser would also treat one asfalse, so this is a docs gap.
Code
- Kit README: Configuration, Multiple instances.
Resolution
Rewrite "Multiple instances" around functions:kits:install and functions:kits:uninstall --instance, and note that an empty IS_ANIMATED= means false.
- Dominant language
- TypeScript
- Stars
- 979
- Forks
- 434
- Avg merge
- 20h 44m
- Merged PRs (30d)
- 17
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from firebase/extensions
-
decision(storage-resize-images): kit/extension parity – ALLOWED_EVENT_TYPES is ignored, the kit reads EXT_SELECTED_EVENTSPossibly taken A pull request linked to this issue is open or already merged. Opendecision kits
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
firebase/extensions#3273 ·
Maintainers usually reply within 1 day
-
kits type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
firebase/extensions#3270 ·
Maintainers usually reply within 1 day
-
fix(storage-resize-images): kit/extension parity – BUCKET_REGION offers europe-north2 and northamerica-south1, which can't deployPossibly taken A pull request linked to this issue is open or already merged. Openkits type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
firebase/extensions#3268 ·
Maintainers usually reply within 1 day
-
fix(storage-resize-images): kit/extension parity – onCompletion event no longer carries the object namePossibly taken A pull request linked to this issue is open or already merged. Openkits type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
firebase/extensions#3266 ·
Maintainers usually reply within 1 day
-
fix(delete-user-data): kit/extension parity – spaces in EXT_SELECTED_EVENTS silently drop eventsPossibly taken A pull request linked to this issue is open or already merged. Openkits type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
firebase/extensions#3259 ·
Maintainers usually reply within 1 day
All issues in firebase/extensions
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
mobile-next/mobile-mcp#526 ·
Maintainers usually reply within 1 day
-
e2e-failure ready-to-code
Difficulty 1/5 Under an hour Newbie friendliness 73/100
redhat-developer/rhdh-plugin-export-overlays#4470 · 1 comment ·
Maintainers usually reply within 1 day