将 flutter web 与 github 操作一起使用时如何访问机密

Question

我有一个 flutter web 应用程序，为了访问数据库，我在 secrets.dart 文件中硬编码了一个 APIKey，这工作得很好。我已将此文件添加到 .gitignore 以防止将其推送到版本控制。但是当使用 GitHub 操作部署应用程序时脚本失败，因为它没有检测到机密文件。

我确实看过 Github 上 Encrypted secrets 上的文档，它基本上允许存储 secrets.But 似乎这些秘密只能在 yml 文件中访问。

我想知道如何在我的应用程序中使用这个秘密，以便我的脚本成功运行并部署应用程序。这是我的文件夹结构

lib/
  services/
     database.dart /// this file uses the APIkey from secrets.dart
  secrets.dart /// contains the APIkey

我能想到的解决这个问题的一种方法是使用 .env 文件，但我不太熟悉如何通过 CI 脚本在 .env 文件中添加密钥.我相信这也能解决我的问题。

这是我的 CI 脚本

# This file was auto-generated by the Firebase CLI
# https://github.com/firebase/firebase-tools

name: Deploy to Firebase Hosting on merge
"on":
  push:
    branches:
      - master
jobs:
  build_and_deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-java@v1
        with:
          java-version: "12.x"
      - uses: subosito/flutter-action@v1
        with:
          channel: "master"
      - run: flutter pub get
      - run: flutter pub run build_runner build --delete-conflicting-outputs
      - run: flutter build web --release
      - uses: FirebaseExtended/action-hosting-deploy@v0
        with:
          repoToken: "${{ secrets.GITHUB_TOKEN }}"
          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_VOCABHUB_34C7F }}"
          channelId: live
          projectId: vocabhub-34c7f
        env:
          FIREBASE_CLI_PREVIEWS: hostingchannels

Answer 1

您可以使用您的 secrets.dart 文件，同时在源代码管理中被忽略。

步骤如下

在您的本地机器上，使用 base64 命令对 secrets.dart 的内容进行编码：
```
  base64 lib/path/to/secrets.dart
```
将输出复制并粘贴到您的 GitHub 机密中，将其命名为 $SECRETS_FILE_CONTENT 或您想要的任何名称。

将此 CI 步骤添加到 yaml 脚本中 flutter pub get 步骤之前。

  # other stuff ...
  - run: echo $SECRETS_FILE_CONTENT | base64 -d > lib/path/to/secrets.dart
    env:
      SECRETS_FILE_CONTENT: ${{ secrets.SECRETS_FILE_CONTENT }}
  - run: flutter pub get
  - run: flutter pub run build_runner build --delete-conflicting-outputs
  - run: flutter build web --release
  # other stuff ...

要在 GitHub 用户界面中添加密码，请按照下列步骤操作：

您的秘密应该出现在 UI 的下半部分“存储库秘密”中，它不应出现在“环境秘密”中，因为它们不适用于简单的 ${{ secrets.name_of_variable }}。

为了提供更多上下文，这里是“动作”文件的内容，例如.github/workflows/ci.yml 在您的存储库中，应该如下所示：

name: CI

on:
  push:
    branches: [ main, dev ]
  pull_request:
    branches: [ main ]

  # Allows to run this workflow manually from the Actions tab
  workflow_dispatch:
  
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Decode base64 secrets
        run: echo $SECRETS_FILE_CONTENTS | base64 -d > lib/path/to/secrets.dart
        env:
          SECRETS_FILE_CONTENTS: ${{ secrets.SECRETS_FILE_CONTENTS }}
      # … put your steps here
        run: flutter pub get

编辑

当人们使用 firebase 时，隐藏 google-services.json 也是相同的过程。或者使用签名密钥（key.jks 或 key.keystore）。

Answer 2

如果您使用的是 Environment Secrets 而不是 Repository Secrets，您应该定义您将使用的环境，查看此内容

jobs:
  build:
    environment: **ENVIRONMENT NAME HERE**

    steps:
      - name: blah blah
        run: echo blah blah

将 flutter web 与 github 操作一起使用时如何访问机密

How to access secrets when using flutter web with github actions

flutter

web

github-actions

secret-key

步骤如下

编辑