Merge pull request #51 from nims-dpfc/develop/1

Develop/1: ドキュメントのバージョン切り替え

Author: sonoh5n

.github/workflows/docs-ci-dry-run.yml

@@ -0,0 +1,61 @@
+name: Test Documentation Build and Deploy
+
+on:
+  push:
+    branches-ignore:
+      - master
+      - main
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  test-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git Credentials
+        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
+        with:
+          python-version: "3.10"
+
+      - 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-
+
+      - name: Install dependencies and Deploy
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.lock
+
+      - name: Test documentation build
+        run: mkdocs build
+
+      - name: Test full deployment process
+        run: |
+          # Simulate tag deployment
+          mike deploy test-version latest --allow-empty
+
+          # Simulate dev deployment
+          mike deploy dev --allow-empty
+
+          # Check the current state
+          git status
+          git log --oneline -n 5
+
+      - name: Cleanup
+        run: |
+          git checkout ${{ github.ref }}
+          git branch -D gh-pages

.github/workflows/docs-ci.yml

@@ -4,34 +4,58 @@ on:
     branches:
       - master
       - main
+    tags:
+      - "v*.*.*"
+
 permissions:
   contents: write
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
       - name: Configure Git Credentials
         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
         with:
           python-version: "3.10"
+
       - 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-
+
       - name: Install dependencies and Deploy
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements-dev.lock
-      - name: Fetch gh-pages branch
-        run: |
-          git fetch origin gh-pages:gh-pages
 
-      - name: Deploy HTML files
-        run: mkdocs gh-deploy --force
+      # - name: Fetch gh-pages branch
+      #   run: |
+      #     git fetch origin gh-pages:gh-pages
+
+      # - name: Deploy HTML files
+      #   run: mkdocs gh-deploy --force
+
+      - name: Deploy documentation
+        run: |
+          if [[ ${{ github.ref }} =~ ^refs/tags/ ]]; then
+              # push tag
+              VERSION=${GITHUB_REF#refs/tags/}
+              mike deploy --push --update-aliases $VERSION latest
+              mike set-default --push latest
+          else
+              # push to main/master branch
+              mike deploy --push --update-aliases dev
+          fi

mkdocs.yml

@@ -84,6 +84,15 @@ plugins:
             show_inheritance_diagram: true
             heading_level: 3
             show_root_toc_entry: false
+  - mike:
+      # These fields are all optional; the defaults are as below...
+      alias_type: symlink
+      redirect_template: null
+      deploy_prefix: ''
+      canonical_version: null
+      version_selector: true
+      css_dir: css
+      javascript_dir: js
 
 watch:
   - src

pyproject.toml

@@ -203,5 +203,5 @@ dev-dependencies = [
     "mkdocs-mermaid2-plugin>=1.1.1",
     "ruff>=0.5.5",
     "jsonschema-markdown>=0.3.8",
-    "mike>=2.1.1",
+    "mike>=2.1.3",
 ]