Auto deploy docs to gh-pages on github release

qiaojunfeng · Feb 17, 2024 · 84710a6 · 84710a6
1 parent 7bbc88b
commit 84710a6
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 35 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,36 +1,43 @@
-name: Build docs
+name: Deploy docs
+
 on:
-  pull_request:
-  push:
-    branches:
-      - develop
+  release:
+    types: [published]
 
 jobs:
-  docs:
-      name: Build docs
-      runs-on: ubuntu-latest
-      steps:
-        - uses: actions/checkout@v4
-        - uses: actions/setup-python@v5
-          with:
-            python-version: "3.11"
-        - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-        - uses: actions/cache@v4
-          with:
-            key: mkdocs-w90-${{ env.cache_id }}
-            path: .cache
-            restore-keys: |
-              mkdocs-w90-
-        - run: pip install -r docs/requirements.txt
-        - run: mkdocs build -s
-          working-directory: ./docs
-          env:
-            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-            ENABLE_MKDOCS_GIT_COMMITTERS: False
+  deploy_docs:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: git fetch origin gh-pages --depth=1
+      - run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: "pip"
+      - run: pip install -r docs/requirements.txt
+
+      # This deploys mkdocs-built html, now we use mike to deploy
+      # html to have doc versioning.
+      #
+      # - run: mkdocs build -s
+      #   working-directory: ./docs
+      #   env:
+      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      #     ENABLE_MKDOCS_GIT_COMMITTERS: True
+      # - name: Deploy to GitHub Pages
+      #   uses: peaceiris/actions-gh-pages@v3
+      #   if: github.ref == 'refs/heads/develop'
+      #   with:
+      #     github_token: ${{ secrets.GITHUB_TOKEN }}
+      #     publish_dir: ./docs/site
 
-        - name: Deploy to GitHub Pages
-          uses: peaceiris/actions-gh-pages@v3
-          if: github.ref == 'refs/heads/develop'
-          with:
-            github_token: ${{ secrets.GITHUB_TOKEN }}
-            publish_dir: ./docs/site
+      - name: mike deploy
+        run: mike deploy --push --update-aliases ${{ github.ref_name }} latest
+        working-directory: ./docs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ENABLE_MKDOCS_GIT_COMMITTERS: True
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -4,8 +4,8 @@ on:
   pull_request:
   push:
     branches:
-    - develop
-    
+      - develop
+
 jobs:
   pre-commit:
     runs-on: ubuntu-20.04
@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        w90-binary-parallel: [ 'false', 'true' ]
+        w90-binary-parallel: ["false", "true"]
     name: Build and test `parallel=${{ matrix.w90-binary-parallel }}`
     steps:
       - name: checkout
@@ -66,3 +66,19 @@ jobs:
           path: |
             test-suite/tests/test*/test.err*
             test-suite/tests/test*/test.out*
+
+  docs:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: "pip"
+      - run: pip install -r docs/requirements.txt
+      - run: mkdocs build -s
+        working-directory: ./docs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ENABLE_MKDOCS_GIT_COMMITTERS: False