31 インフラfirebaseにデプロイして動作しない不具合 (#33)

.github/workflows/firebase-hosting-merge.yml

@@ -1,20 +1,28 @@
 # This file was auto-generated by the Firebase CLI
 # https://github.com/firebase/firebase-tools
 
-name: Deploy to Firebase Hosting on merge
-'on':
+name: Deploy to Firebase Hosting/Function on merge
+"on":
   push:
     branches:
       - main
 jobs:
-  build_and_deploy:
+  deploy-firebase-hosting-functions:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - run: npm ci && npm run build
-      - uses: FirebaseExtended/action-hosting-deploy@v0
-        with:
-          repoToken: '${{ secrets.GITHUB_TOKEN }}'
-          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_KEY3_GLOBAL_HACKATHON }}'
-          channelId: live
-          projectId: key3-global-hackathon
+
+      - name: Create env file
+        run: |
+          echo "${{ secrets.CONFIG_VALUES }}" >> .env
+          echo ${{ secrets.FIREBASE_SERVICE_ACCOUNT }} | base64 --decode > ./firebase-service-account.json
+
+      - name: Install npm packages
+        run: |
+          npm ci && npm run build
+
+      - name: Deploy to Firebase
+        run: |
+          npx firebase-tools deploy
+        env:
+          GOOGLE_APPLICATION_CREDENTIALS: ./firebase-service-account.json

README.md

@@ -6,7 +6,7 @@
 
 ### 1. 必要情報の取得
 
-はじめに下記のサービスにアクセスし、利用に必要な情報を取得する。
+はじめに下記のサービスにアクセスし、利用に必要な情報を取得する。API キーやアカウントが存在しない場合は作成する。
 
 | サービス名   | URL                               | 必要な情報                         |
 | ------------ | --------------------------------- | ---------------------------------- |
@@ -23,6 +23,7 @@ OPENAI_API_KEY=${OpenAIのAPIキー}
 
 # GCPの設定
 GOOGLE_APPLICATION_CREDENTIALS=${GCPのサービスアカウントキーのパス}
+FIRE_STORAGE_BUCKET=${GCPのサービスアカウントキーのパス}
 ```
 
 ### 2. サーバの起動
@@ -46,3 +47,26 @@ npm run dev
 ```bash
 npm run preview
 ```
+
+## デプロイ
+
+本アプリケーションは、Firebase Hosting と Function にデプロイされている。Github のリポジトリのシークレットに以下の環境変数を設定する。
+
+| 環境変数名               | 説明                      |
+| ------------------------ | ------------------------- |
+| FIREBASE_SERVICE_ACCOUNT | サービスアカウントを json |
+| CONFIG_VALUES            | 以下                      |
+
+Firebase のコンソールからサービスアカウントを発行した場合、発行したサービスアカウントに以下の権限を追加で付与する。
+
+- Cloud Functions Developer
+- Firebase Hosting Admin
+- Service Account User
+
+CONFIG_VALUES には、アプリの起動に必要な環境変数を、半角スペース区切りで設定する。
+
+```
+open_api_key=${OpenAPI のキー} fire_storage_bucket=${バケット名}
+```
+
+設定が完了後、Github Actions により自動的に検証環境にデプロイされる。