Merge pull request #11 from scientificcomputing/cache-conda

try enabling conda package caching

Author: jorgensd

.github/actions/install-dependencies/action.yml

@@ -10,6 +10,8 @@ inputs:
 runs:
   using: composite
   steps:
+    # cache ref https://github.com/conda-incubator/setup-miniconda#caching-packages
+
     - name: Setup conda-forge
       uses: conda-incubator/setup-miniconda@v2
       with:
@@ -18,23 +20,26 @@ runs:
           activate-environment: mpi-tutorial
           python-version: ${{ inputs.python-version }}
           use-mamba: true
-          environment-file: environment.yml
+          # uncomment to install env in one go (without caching)
+          # environment-file: environment.yml
+          # needed for caching
+          use-only-tar-bz2: true
 
-    # - name: Prepare cache
-    #   shell: bash -el {0}
-    #   run: |
-    #     if [[ $CONDA != /opt/conda ]]; then
-    #       mkdir -p /opt/conda/
-    #       ln -s $CONDA/envs /opt/conda/envs
-    #     fi
-    #     echo CONDA=$CONDA
-    #     mamba env list
-        
-    # - name: Environment cache
-    #   uses: actions/cache@v3
-    #   with:
-    #     path: /opt/conda/envs/mpi-tutorial
-    #     key: env-conda-mpi-tutorial-${{ inputs.python-version }}-${{ hashFiles('.github/actions/install-dependencies/*') }}
-    #   id: cache
+    - name: Get Date
+      id: get-date
+      run: echo "today=$(/bin/date -u '+%Y%m%d')" >> "$GITHUB_OUTPUT"
+      shell: bash
 
+    - name: Cache conda env
+      uses: actions/cache@v3
+      id: cache-env
+      with:
+        path: ${{ env.CONDA }}/envs/mpi-tutorial
+        key:
+          conda-env-${{ steps.get-date.outputs.today }}-${{ inputs.python-version }}-${{ hashFiles('environment.yml') }}
 
+    - name: Update environment
+      if: steps.cache-env.outputs.cache-hit != 'true'
+      run:
+          mamba env update -n mpi-tutorial -f environment.yml
+      shell: bash -el {0}

.github/workflows/build_docs.yml

@@ -9,23 +9,35 @@ on:
 env:
   DEB_PYTHON_INSTALL_LAYOUT: deb_system
 
+defaults:
+  run:
+    shell: bash -el {0}
+
 jobs:
   build-book:
     runs-on: ubuntu-latest
- 
+
     steps:
 
       - uses: actions/checkout@v3
-  
+
       - name: Install common packages
         uses: ./.github/actions/install-dependencies
 
       - name: Build the book
-        run: 
-          conda run -n mpi-tutorial jupyter-book build . -W
+        run:
+          jupyter-book build . -W
+
       - uses: actions/upload-artifact@v3
+        # always upload artifact, which can include error messages
+        if: always()
         with:
           name: documentation
           path: ./_build/html
           retention-days: 2
-          if-no-files-found: error
+          if-no-files-found: error
+
+      - name: Show error reports
+        if: failure()
+        run: |
+          find _build/html/reports -type f -print -exec cat {} \;