Skip to content

docs(storage-resize-images): mark which kit settings can be blank #3320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CorieW wants to merge 1 commit into
base: kits
Choose a base branch
from
Open

docs(storage-resize-images): mark which kit settings can be blank #3320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 24 additions & 21 deletions kits/storage-resize-images/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,27 +92,30 @@ Deploy a single instance with `firebase deploy --only functions:<instance id>`.
Set these values in a `.env` (or `.env.<projectId>`) file. The Firebase CLI
loads them at deploy time and prompts for any required values that are missing.

| Field | Env var | Required | Default | Description |
| ---------------------- | ------------------------ | -------- | ---------------------- | ------------------------------------------------------------------------------------------ |
| `bucketRegion` | `BUCKET_REGION` | yes | (prompted) | Cloud Storage bucket location; also places the function |
| `bucket` | `IMG_BUCKET` | no | default Storage bucket | Bucket to watch |
| `sizes` | `IMG_SIZES` | no | `200x200` | Comma-separated resize sizes |
| `deleteOriginal` | `DELETE_ORIGINAL_FILE` | no | `false` | Delete original after resize; omitted in code means `on_success` (see note below) |
| `makePublic` | `MAKE_PUBLIC` | no | `false` | Make resized objects public |
| `resizedImagesPath` | `RESIZED_IMAGES_PATH` | no | (empty) | Output path prefix |
| `includePathList` | `INCLUDE_PATH_LIST` | no | (empty) | Comma-separated absolute paths to include (for example, `/users/avatars,/design/pictures`) |
| `excludePathList` | `EXCLUDE_PATH_LIST` | no | (empty) | Comma-separated absolute paths to exclude (for example, `/users/avatars/thumbs`) |
| `failedImagesPath` | `FAILED_IMAGES_PATH` | no | (empty) | Failed-image output path |
| `cacheControlHeader` | `CACHE_CONTROL_HEADER` | no | (empty) | Cache-Control for outputs |
| `imageTypes` | `IMAGE_TYPE` | no | `["false"]` | Output image types list |
| `outputOptions` | `OUTPUT_OPTIONS` | no | (empty) | JSON output options |
| `sharpOptions` | `SHARP_OPTIONS` | no | `{}` | JSON Sharp options |
| `isAnimated` | `IS_ANIMATED` | no | `true` | Preserve animation |
| `memory` | `FUNCTION_MEMORY` | no | `1024` | Function memory (MiB) |
| `regenerateToken` | `REGENERATE_TOKEN` | no | `true` | Regenerate download tokens |
| `contentFilterLevel` | `CONTENT_FILTER_LEVEL` | no | `OFF` | Content filter level |
| `customFilterPrompt` | `CUSTOM_FILTER_PROMPT` | no | (empty) | Custom filter prompt |
| `placeholderImagePath` | `PLACEHOLDER_IMAGE_PATH` | no | (empty) | Placeholder for filtered images |
A setting with **No** under "Can be blank" fails the deploy on a line like
`IMG_SIZES=`. Give it a value, or remove the line and answer the prompt.
Comment on lines +95 to +96

@gemini-code-assist gemini-code-assist Bot Nov 10, 2026

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.

medium

The phrasing "fails the deploy on a line like IMG_SIZES=" can be made clearer and more precise. Consider rephrasing it to explicitly state that an empty assignment in the .env file causes the failure. This also avoids hard line-wrapping, which is generally preferred in Markdown.

Suggested change
A setting with **No** under "Can be blank" fails the deploy on a line like
`IMG_SIZES=`. Give it a value, or remove the line and answer the prompt.
A setting with **No** under "Can be blank" fails the deploy if it is set to an empty value (for example, `IMG_SIZES=` in your `.env` file). Either provide a value, or remove the line entirely to be prompted during deployment.


| Field | Env var | Can be blank | Default | Description |
| ---------------------- | ------------------------ | ------------ | ---------------------- | ------------------------------------------------------------------------------------------ |
| `bucketRegion` | `BUCKET_REGION` | Yes | (prompted) | Cloud Storage bucket location; also places the function |
| `bucket` | `IMG_BUCKET` | No | default Storage bucket | Bucket to watch |
| `sizes` | `IMG_SIZES` | No | `200x200` | Comma-separated resize sizes |
| `deleteOriginal` | `DELETE_ORIGINAL_FILE` | No | `false` | Delete original after resize; omitted in code means `on_success` (see note below) |
| `makePublic` | `MAKE_PUBLIC` | Yes | `false` | Make resized objects public |
| `resizedImagesPath` | `RESIZED_IMAGES_PATH` | Yes | (empty) | Output path prefix |
| `includePathList` | `INCLUDE_PATH_LIST` | Yes | (empty) | Comma-separated absolute paths to include (for example, `/users/avatars,/design/pictures`) |
| `excludePathList` | `EXCLUDE_PATH_LIST` | Yes | (empty) | Comma-separated absolute paths to exclude (for example, `/users/avatars/thumbs`) |
| `failedImagesPath` | `FAILED_IMAGES_PATH` | Yes | (empty) | Failed-image output path |
| `cacheControlHeader` | `CACHE_CONTROL_HEADER` | Yes | (empty) | Cache-Control for outputs |
| `imageTypes` | `IMAGE_TYPE` | No | `["false"]` | Output image types list |
| `outputOptions` | `OUTPUT_OPTIONS` | Yes | (empty) | JSON output options |
| `sharpOptions` | `SHARP_OPTIONS` | Yes | `{}` | JSON Sharp options |
| `isAnimated` | `IS_ANIMATED` | Yes | `true` | Preserve animation |
| `memory` | `FUNCTION_MEMORY` | No | `1024` | Function memory (MiB) |
| `regenerateToken` | `REGENERATE_TOKEN` | Yes | `true` | Regenerate download tokens |
| `contentFilterLevel` | `CONTENT_FILTER_LEVEL` | No | `OFF` | Content filter level |
| `customFilterPrompt` | `CUSTOM_FILTER_PROMPT` | Yes | (empty) | Custom filter prompt |
| `placeholderImagePath` | `PLACEHOLDER_IMAGE_PATH` | Yes | (empty) | Placeholder for filtered images |

Single-quote JSON values such as `SHARP_OPTIONS` and `OUTPUT_OPTIONS` in
`.env`. In an unquoted value, `#` starts a comment and cuts the rest of the value off:
Expand Down
Loading