Hugging Face Spacesへのデプロイ用のGitHub Actionsワークフローを追加し、デプロイ手順をドキュメント化しました。CIが成功した場合のみ手動でデプロイできるように設定しました。

.github/workflows/deploy-to-hf.yml

@@ -0,0 +1,102 @@
+name: Deploy to Hugging Face Space
+
+on:
+  workflow_dispatch:  # 手動デプロイボタン
+
+jobs:
+  check-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check CI status
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const { data: runs } = await github.rest.actions.listWorkflowRuns({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              workflow_id: 'ci.yml',
+              branch: 'main',
+              status: 'success',
+              per_page: 1
+            });
+
+            if (runs.total_count === 0) {
+              core.setFailed('CIが成功していません。デプロイする前にCIを実行して成功させてください。');
+            }
+
+  deploy:
+    needs: check-ci
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install Hugging Face Hub CLI
+        run: pip install huggingface_hub
+
+      - name: Login to Hugging Face
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: huggingface-cli login --token $HF_TOKEN
+
+      - name: Deploy to Hugging Face Space
+        env:
+          HF_SPACE_ID: Kyosuke0/yomitalk
+        run: |
+          # 必要なファイルをスペースにプッシュ
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "GitHub Actions"
+
+          # huggingface_hubを使用して直接アップロード
+          python -c "
+          from huggingface_hub import HfApi
+          import os
+          import glob
+
+          api = HfApi()
+          space_id = os.environ.get('HF_SPACE_ID')
+
+          # すべての必要なファイルをアップロード
+          files_to_upload = [
+              'app.py',
+              'requirements.txt',
+              'pyproject.toml',
+              'LICENSE',
+              'README.md',
+          ]
+
+          # ディレクトリ全体をアップロード
+          dirs_to_upload = ['yomitalk', 'assets', 'docs']
+
+          # 個々のファイルをアップロード
+          for file in files_to_upload:
+              if os.path.exists(file):
+                  print(f'Uploading {file}')
+                  api.upload_file(
+                      path_or_fileobj=file,
+                      path_in_repo=file,
+                      repo_id=space_id,
+                      repo_type='space',
+                  )
+
+          # ディレクトリ内のファイルをアップロード
+          for dir_path in dirs_to_upload:
+              if os.path.exists(dir_path):
+                  for root, _, files in os.walk(dir_path):
+                      for file in files:
+                          file_path = os.path.join(root, file)
+                          # 不要なファイルをスキップ
+                          if '__pycache__' in file_path or '.git' in file_path:
+                              continue
+                          print(f'Uploading {file_path}')
+                          api.upload_file(
+                              path_or_fileobj=file_path,
+                              path_in_repo=file_path,
+                              repo_id=space_id,
+                              repo_type='space',
+                          )
+          "

docs/deploy-to-hf.md

@@ -0,0 +1,49 @@
+# Hugging Face Spacesへのデプロイ方法
+
+このプロジェクトは、GitHub Actionsを使用してHugging Face Spacesにデプロイする設定が含まれています。
+**デプロイは手動で実行でき、CIが成功した場合のみ実行可能です。**
+
+## 事前準備
+
+### 1. Hugging Face APIトークンの取得
+1. [Hugging Face](https://huggingface.co/)にログインします。
+2. 右上のプロフィールアイコンをクリックし、「Settings」を選択します。
+3. 左サイドバーから「Access Tokens」を選択します。
+4. 「New token」ボタンをクリックします。
+5. トークン名を入力し、権限を「Write」に設定します。
+6. 「Generate token」ボタンをクリックします。
+7. 生成されたトークンをコピーします（このページを離れると二度と表示されないので注意）。
+
+### 2. GitHubリポジトリにシークレットを設定
+1. GitHubリポジトリのページに移動します。
+2. 「Settings」タブをクリックします。
+3. 左サイドバーから「Secrets and variables」→「Actions」を選択します。
+4. 「New repository secret」ボタンをクリックします。
+5. 名前に「HF_TOKEN」と入力し、値に先ほどコピーしたHugging Face APIトークンを貼り付けます。
+6. 「Add secret」ボタンをクリックします。
+
+## デプロイの流れ
+
+1. `main`ブランチにプッシュまたはPRがマージされると、自動的にCIが実行されます。
+2. CIが成功したことを確認します。
+3. GitHubリポジトリの「Actions」タブに移動します。
+4. 左サイドバーから「Deploy to Hugging Face Space」ワークフローを選択します。
+5. 「Run workflow」ボタンをクリックします。
+   - 注意: CIが成功していない場合は、デプロイボタンを押しても失敗します。
+6. デプロイが完了するまで待ちます（数分かかることがあります）。
+7. デプロイが完了したら、[https://huggingface.co/spaces/Kyosuke0/yomitalk](https://huggingface.co/spaces/Kyosuke0/yomitalk)にアクセスしてアプリケーションが正常に動作しているか確認します。
+
+## トラブルシューティング
+
+### デプロイに失敗する場合
+1. GitHub Actionsのログを確認し、エラーメッセージを確認します。
+2. CIが成功しているか確認します。
+   - CIが成功していない場合は、まずCIを実行して成功させてください。
+3. Hugging Face APIトークンが正しく設定されているか確認します。
+4. Hugging Face Spacesの容量制限に達していないか確認します。
+5. Dockerfileに必要なパッケージがすべて含まれているか確認します。
+
+### アプリケーションが正常に動作しない場合
+1. Hugging Face Spaces上のログを確認します（Spacesページの「Files and versions」タブ→「logs」フォルダ）。
+2. 必要な環境変数が設定されているか確認します。
+3. Dockerfileに必要なファイルがすべてコピーされているか確認します。