split

Author: briling

.github/workflows/docs-build-test-deploy.yml

@@ -0,0 +1,99 @@
+name: Documentation build
+
+# cancel any previous running or pending jobs from the same branch
+concurrency:
+  group: docs-build-cache-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  workflow_run:
+    workflows: ["Build env and test"]
+    branches:
+      - '*'
+    types:
+      - completed
+  workflow_dispatch:
+
+env:
+  CACHE_NUMBER: 0  # increase to reset cache manually
+
+jobs:
+
+  build-docs:
+
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+
+    defaults:
+      run:
+        shell: bash -el {0}
+
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            label: linux-64
+            prefix: /usr/share/miniconda3/envs/my-env
+
+    name: ${{ matrix.label }}
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Miniforge
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+            miniforge-version: latest
+            activate-environment: my-env
+
+      - name: Set cache date
+        run: echo "DATE=$(date +'%Y%m')" >> $GITHUB_ENV
+
+      - name: Restore doc env cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.CONDA }}/envs
+          key: ${{ matrix.label }}-conda-${{ hashFiles('environment.yml') }}-${{ hashFiles('docs/requirements.txt') }}-${{ env.DATE }}-${{ env.CACHE_NUMBER }}
+        id: cache-doc
+
+      - name: Restore env cache
+        if: steps.cache-doc.outputs.cache-hit != 'true'
+        uses: actions/cache/restore@v4
+        with:
+          path: ${{ env.CONDA }}/envs
+          key: ${{ matrix.label }}-conda-${{ hashFiles('environment.yml') }}-${{ env.DATE }}-${{ env.CACHE_NUMBER }}
+          fail-on-cache-miss: true
+        id: cache
+
+      - name: Install documentation requirements
+        if: steps.cache-doc.outputs.cache-hit != 'true'
+        run: pip install -r docs/requirements.txt
+
+      - name: Build documentation src
+        run: make build-src -C docs/
+
+      - name: Build HTML
+        run: make html -C docs/
+
+      - name: Upload artifacts
+        if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html/
+
+  deploy:
+    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+    needs: build-docs
+    runs-on: ubuntu-latest
+
+    environment:
+      name: github-pages
+
+    permissions:
+      pages: write
+      id-token: write
+
+    steps:
+      - name: Deploy
+        uses: actions/deploy-pages@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/python-package-conda-cache.yml

@@ -1,4 +1,4 @@
-name: Python Package with caching
+name: Build env and test
 
 # taken from https://github.com/epassaro/cache-conda-envs