fixes

Author: bcherry

.github/workflows/template-check.yml

@@ -0,0 +1,31 @@
+# As this is a starter template project, we don't want to check in the uv.lock and livekit.toml files in its template form
+# However, once you have cloned this repo for your own use, LiveKit recommends you check them in and delete this github workflow entirely
+    
+name: Template Check
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  check-template-files:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Check template files not tracked in git
+      run: |
+        if git ls-files | grep -q "^uv\.lock$"; then
+          echo "Error: uv.lock should not be checked into git"
+          echo "Disable this test and commit the file once you have cloned this repo for your own use"
+          exit 1
+        fi
+        if git ls-files | grep -q "^livekit\.toml$"; then
+          echo "Error: livekit.toml should not be checked into git"
+          echo "Disable this test and commit the file once you have cloned this repo for your own use"
+          exit 1
+        fi
+        echo "✓ uv.lock and livekit.toml are correctly not tracked in git" 

.github/workflows/tests.yml

@@ -13,22 +13,6 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    # As this is a starter template project, we don't want to check in the uv.lock and livekit.toml files in its template form
-    # However, once you have cloned this repo for your own use, LiveKit recommends you check them in and remove this check
-    - name: Check files not tracked in git
-      run: |
-        if git ls-files | grep -q "^uv\.lock$"; then
-          echo "Error: uv.lock should not be checked into git"
-          echo "Disable this test and commit the file once you have cloned this repo for your own use"
-          exit 1
-        fi
-        if git ls-files | grep -q "^livekit\.toml$"; then
-          echo "Error: livekit.toml should not be checked into git"
-          echo "Disable this test and commit the file once you have cloned this repo for your own use"
-          exit 1
-        fi
-        echo "✓ uv.lock and livekit.toml are correctly not tracked in git"
-    
     - name: Install uv
       uses: astral-sh/setup-uv@v1
       with:

README.md

@@ -92,6 +92,8 @@ Once you've started your own project based on this repo, you should:
 
 2. **Remove the git tracking test**: Delete the "Check files not tracked in git" step from `.github/workflows/tests.yml` since you'll now want this file to be tracked. These are just there for development purposes in the template repo itself.
 
+3. **Add your own repository secrets**: You must [add secrets](https://docs.github.com/en/actions/how-tos/writing-workflows/choosing-what-your-workflow-does/using-secrets-in-github-actions) for `OPENAI_API_KEY` or your other LLM provider so that the tests can run in CI.
+
 ## Deploying to production
 
 This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/agents/ops/deployment/) guide.