Update GitHub Actions workflow for documentation deployment

mgao6767 · Feb 2, 2025 · be76ec6 · be76ec6
1 parent 490d8f3
commit be76ec6
Showing 1 changed file with 11 additions and 5 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -2,7 +2,6 @@ name: docs
 on:
   push:
     branches:
-      - master 
       - main
 permissions:
   contents: write
@@ -15,15 +14,22 @@ jobs:
         run: |
           git config user.name github-actions[bot]
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
         with:
-          python-version: 3.x
+          enable-cache: true
+      - name: Set up Python
+        run: uv python install
+      - name: Install the project
+        run: |
+          uv sync --all-extras --dev
+          uv pip install .
       - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
       - uses: actions/cache@v4
         with:
           key: mkdocs-material-${{ env.cache_id }}
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material 
-      - run: mkdocs gh-deploy --force
+      - name: Deploy MkDocs
+        run: mkdocs gh-deploy --force --remote-branch gh-pages