w9jds/firebase-action

Firebase的GitHub Actions

此Action适用于https://github.com/firebase/firebase-tools%EF%BC%8C%E6%94%AF%E6%8C%81%E4%BD%BF%E7%94%A8%60firebase%60%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%AE%A2%E6%88%B7%E7%AB%AF%E6%89%A7%E8%A1%8C%E4%BB%BB%E6%84%8F%E6%93%8D%E4%BD%9C%E3%80%82

输入参数（Inputs）

• args - 必填。用于firebase命令行工具的参数。

环境变量

• FIREBASE_TOKEN - 当未设置GCP_SA_KEY时必填。用于身份验证的令牌。可通过firebase login:ci命令获取。

• GCP_SA_KEY - 当未设置FIREBASE_TOKEN时必填。具有项目中Firebase Admin角色的普通服务账户密钥（JSON格式）或Base64编码的服务账户密钥。如果要部署函数，还需要Cloud Functions Developer角色。由于部署服务账户在部署过程中使用App Engine默认服务账户，因此还需要Service Account User角色。如果仅用于托管，Firebase Hosting Admin角色已足够。详情参见Firebase Hosting GitHub集成文档。

• PROJECT_ID - 可选。用于指定所有命令使用的特定项目。如果在.firebaserc文件中指定了项目，则无需此参数。

• PROJECT_PATH - 可选。如果firebase.json不在仓库根目录，此参数指定包含firebase.json的文件夹路径。例如：./my-app。

示例

以下示例展示如何通过Firebase身份验证并部署到Firebase Hosting：

yaml
name: 构建与部署
on:
  push:
    branches:
      - master

jobs:
  build:
    name: 构建
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码库
        uses: actions/checkout@master
      - name: 安装依赖
        run: npm install
      - name: 构建
        run: npm run build-prod
      - name: 归档生产构建产物
        uses: actions/upload-artifact@master
        with:
          name: dist
          path: dist
  deploy:
    name: 部署
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码库
        uses: actions/checkout@master
      - name: 下载构建产物
        uses: actions/download-artifact@master
        with:
          name: dist
          path: dist
      - name: 部署到Firebase
        uses: w9jds/firebase-action@master
        with:
          args: deploy --only hosting
        env:
          FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}

或者使用GCP服务账户密钥：

yaml
        env:
          GCP_SA_KEY: ${{ secrets.GCP_SA_KEY }}

如果有多个托管环境，可以在args中指定环境名称，例如：args: deploy --only hosting:[环境名称]。

如果要为部署添加消息（如Git提交消息），需注意转义引号，避免YAML格式错误：

yaml
        with:
          args: deploy --message \"${{ github.event.head_commit.message }}\"

许可证

本项目中的Dockerfile及相关脚本和文档以MIT许可证发布。

建议

如果决定将构建和部署分为不同的作业（建议如此），请确保克隆代码库，因为Firebase-cli需要firebase仓库（特别是firebase.json）才能部署。