metadata action

.github/workflows/push-to-huggingface.yaml

@@ -1,4 +1,4 @@
-name: Sync to Hugging Face hub
+name: Deploy to Hugging Face Spaces
 on:
   push:
     branches: [main]
@@ -7,6 +7,13 @@ on:
   workflow_dispatch:
 
 jobs:
+  update-readme:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Update README
+        run: |
+          python scripts/update_readme.py
   sync-to-hub:
     runs-on: ubuntu-latest
     steps:
@@ -14,6 +21,11 @@ jobs:
         with:
           fetch-depth: 0
           lfs: true
+      - name: Update README
+        run: |
+          python scripts/update_readme.py
+          git add README.md
+          git commit -m "README metadata"
       - name: Push to hub
         env:
           HF_TOKEN: ${{ secrets.HF_TOKEN }}

README.md

@@ -1,14 +1,3 @@
----
-title: Chameleon
-emoji: 🦎
-colorFrom: green
-colorTo: yellow
-sdk: streamlit
-sdk_version: 1.31.1
-app_file: src/app.py
-pinned: true
----
-
 # Chameleon
 
 *A social deduction game powered by LLMs*

scripts/update_readme.py

@@ -0,0 +1,23 @@
+import os
+
+readme_path = "README.md"
+
+hf_space_metadata="""
+---
+title: Chameleon
+emoji: 🦎
+colorFrom: green
+colorTo: yellow
+sdk: streamlit
+sdk_version: 1.31.1
+app_file: src/app.py
+pinned: true
+---
+"""
+
+# Open the README file
+with open(readme_path, 'r') as original:
+    data = original.read()
+# Rewrite the README file, with metadata prepended
+with open(readme_path, 'w') as modified:
+    modified.write(hf_space_metadata + data)