https://github.com/w9jds/setup-firebase
Firebase GitHub Action (replacement for firebase-action)
https://github.com/w9jds/setup-firebase
Last synced: about 12 hours ago
JSON representation
Firebase GitHub Action (replacement for firebase-action)
- Host: GitHub
- URL: https://github.com/w9jds/setup-firebase
- Owner: w9jds
- License: mit
- Created: 2022-11-15T04:30:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-27T20:52:24.000Z (10 months ago)
- Last Synced: 2025-05-09T02:17:27.065Z (about 12 hours ago)
- Language: TypeScript
- Size: 74.2 KB
- Stars: 26
- Watchers: 4
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# setup-firebase (Alternative for [firebase-action](https://github.com/w9jds/firebase-action))
This action provides the following functionality for GitHub Actions:
- Install `firebase-tools` CLI for use inside the current job
- Specify which version of the CLI to install
- Allows you to configure authentication and project
- Allows you to customize your environment for what you need
- Specific Node version (via `actions/setup-node`)
- Java if needed and specified version (via `actions/setup-java`)
# Usage
_**Important: For this action to work properly `actions/setup-node` needs to be used**_
See [action.yml](https://github.com/w9jds/setup-firebase/blob/main/action.yml)
**Basic example:**
```yaml
steps:
- uses: actions/checkout@master
- uses: actions/setup-node@v3
- uses: w9jds/setup-firebase@main
with:
tools-version: 11.9.0
firebase_token: ${{ secrets.FIREBASE_TOKEN }}
- run: firebase deploy --only hosting
- run: firebase deploy --only functions
```
The `tools-version` is optional. If not supplied it will install the latest version of `firebase-tools`.
With some of the major versions removing and changing functionality, it is highly recommended you specify which version you want to use and upgrade as you need it.
**Emulator example:**
```yaml
steps:
- uses: actions/checkout@master
- uses: actions/setup-node@v3
with:
node-version: 18
- uses: actions/setup-java@v3
with:
java-version: 17
- uses: w9jds/setup-firebase@main
with:
tools-version: 11.9.0
firebase_token: ${{ secrets.FIREBASE_TOKEN }}
- run: firebase deploy --only hosting
- run: firebase deploy --only functions
```
# License
The scripts and documents in this project are released under the [MIT License](https://github.com/w9jds/setup-firebase/blob/main/LICENSE)