Skip to content

Updated README for 'force' command #429

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

Merged
bkendall merged 13 commits into from
Aug 18, 2025
Merged

Updated README for 'force' command #429

Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
bb25dd7
added in a flag for '--force' when deploying changes that may increas…
ThadCastl3 Jul 21, 2025
93bfe47
updated force flag to accept a boolean value.
ThadCastl3 Jul 21, 2025
0c94d23
updated tests for using force flag
ThadCastl3 Jul 21, 2025
6f6d7eb
updated formatting to match contributor guidelines
ThadCastl3 Jul 21, 2025
0aeca82
Update action.yml
ThadCastl3 Aug 12, 2025
43f1c76
accepted update to action.yml for 'force' flag description, added sup…
ThadCastl3 Aug 12, 2025
4c9959f
updated test to use the correct ChannelDeployConfig
ThadCastl3 Aug 13, 2025
ab40107
Merge remote-tracking branch 'upstream/main'
ThadCastl3 Aug 13, 2025
561f0e1
merged remote main branch updates and formatted, tests are passing now
ThadCastl3 Aug 13, 2025
8ec7c1d
removed unused types for tests
ThadCastl3 Aug 14, 2025
26e4273
Merge branch 'FirebaseExtended:main' into main
ThadCastl3 Aug 15, 2025
2123c9b
updated readme for force flag
ThadCastl3 Aug 15, 2025
91aca77
Update README.md
bkendall Aug 18, 2025
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ jobs:
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
expires: 30d
projectId: your-Firebase-project-ID
# Optionally add Force flag
# force: true
```

### Deploy to your live channel on merge
Expand Down Expand Up @@ -81,6 +83,8 @@ jobs:
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
projectId: your-Firebase-project-ID
channelId: live
# Optionally add Force flag
# force: true
```

## Options
Expand Down Expand Up @@ -151,6 +155,10 @@ The version of `firebase-tools` to use. If not specified, defaults to `latest`.

Disable commenting in a PR with the preview URL.

### `force` _{boolean}_

Bypass the confirmation prompt.
Copy link

@gemini-code-assist gemini-code-assist bot Aug 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The description for the force flag could be more descriptive. The action.yml file has a more detailed explanation which would be beneficial here as well to inform users about the implications of using this flag. Consider using a description similar to the one in action.yml for consistency and clarity.

Suggested change
Bypass the confirmation prompt.
Pass 'true' to use the --force flag with firebase deploy. This will automatically accept any warning or prompts during deploy. Use with caution.


## Outputs

Values emitted by this action that can be consumed by other actions later in your workflow
Expand Down