joinflux/firebase-action

Firebase Action Docker镜像文档

镜像概述

该Docker镜像基于轻量级基础镜像构建，内置Firebase CLI工具，旨在为CI/CD环境提供便捷的Firebase命令执行能力。通过容器化方式封装Firebase命令执行环境，避免了在CI/CD节点上手动安装配置Firebase CLI的复杂性，确保环境一致性，支持各类Firebase操作的自动化执行。

核心功能与特性

核心功能

• 完整集成Firebase CLI，支持所有官方Firebase命令（如deploy、functions:deploy、database:set等）
• 支持Firebase认证令牌注入，实现无交互授权
• 兼容Firebase项目的多种部署目标（Hosting、Functions、Realtime Database、Firestore等）
• 支持自定义命令参数，满足复杂部署场景需求

特性

• 轻量级：基于Alpine或Debian Slim基础镜像，镜像体积小，启动速度快
• 版本可控：提供多标签版本，对应不同Firebase CLI版本，确保兼容性
• 环境隔离：容器化执行环境，避免与CI/CD节点系统环境冲突
• 易于集成：支持主流CI/CD平台（GitHub Actions、GitLab CI、Jenkins等）

使用场景与适用范围

适用场景

• 自动化部署：在代码提交或合并到主分支后，自动部署Firebase Hosting静态资源或Cloud Functions
• 定时任务：定期执行Firebase数据库备份、数据清理等维护操作
• 多环境部署：通过参数配置，实现开发、测试、生产环境的差异化部署
• 集成测试：在CI流程中执行Firebase本地模拟器测试，验证功能正确性

适用范围

• Firebase开发者
• 使用CI/CD工具进行自动化构建的团队
• 需要批量管理多个Firebase项目的组织

使用方法与配置说明

前提条件

• 已安装Docker引擎
• 拥有Firebase项目及对应的认证令牌（可通过firebase login:ci命令获取）

基本使用命令（docker run）

bash
docker run --rm \
  -v $(pwd):/app \  # 挂载本地Firebase项目目录到容器内/app
  -e FIREBASE_TOKEN="your-firebase-ci-token" \  # Firebase认证令牌
  -e PROJECT_ID="your-firebase-project-id" \    # Firebase项目ID
  joinflux/firebase-action \
  firebase deploy --only hosting  # 要执行的Firebase命令

环境变量说明

常用命令示例

1. 部署Firebase Hosting静态资源

bash
docker run --rm \
  -v $(pwd):/app \
  -e FIREBASE_TOKEN="your-token" \
  -e PROJECT_ID="my-project" \
  joinflux/firebase-action \
  firebase deploy --only hosting

2. 部署Cloud Functions

bash
docker run --rm \
  -v $(pwd):/app \
  -e FIREBASE_TOKEN="your-token" \
  joinflux/firebase-action \
  firebase deploy --only functions

3. 执行Firebase数据库操作

bash
docker run --rm \
  -v $(pwd):/app \
  -e FIREBASE_TOKEN="your-token" \
  joinflux/firebase-action \
  firebase database:set /path "value" --project my-project

集成到GitHub Actions示例

在.github/workflows/firebase-deploy.yml中配置：

yaml
name: Deploy to Firebase
on:
  push:
    branches: [ main ]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run Firebase deploy
        uses: docker://joinflux/firebase-action
        env:
          FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}
          PROJECT_ID: "my-firebase-project"
        with:
          args: firebase deploy --only hosting

注意事项

• 确保挂载的项目目录包含有效的firebase.json配置文件
• Firebase令牌需妥善保管，建议通过CI/CD平台的密钥管理功能注入，避免明文暴露
• 不同Firebase CLI版本可能存在命令差异，建议指定镜像标签（如joinflux/firebase-action:12.0.0）以锁定版本
• 执行耗时较长的命令（如大型项目部署）时，需确保CI/CD平台的任务超时时间足够长