Merge pull request #145 from brian-rose/myst

Add MyST compatibility

Author: brian-rose

.github/workflows/build-book.yaml

@@ -4,7 +4,7 @@ on:
   workflow_call:
     inputs:
       environment_name:
-        description: 'Name of conda environment to activate'
+        description: 'Name of conda environment to activate (NO LONGER USED)'
         required: false
         default: 'cookbook-dev'
         type: string
@@ -16,13 +16,8 @@ on:
       path_to_notebooks:
         description: 'Location of the JupyterBook source relative to repo root'
         required: false
-        default: './'
+        default: '.'
         type: string
-      use_cached_environment:
-        description: 'Flag for whether we should attempt to retrieve a previously cached environment.'
-        required: false
-        default: 'true'
-        type: string  # had a lot of trouble with boolean types, see https://github.com/actions/runner/issues/1483${{ github.repository }}
       artifact_name:
         description: 'The name to assign to the built book artifact.'
         required: false
@@ -58,7 +53,11 @@ on:
         required: false
         default: success
         type: string
-
+      base_url:
+        description: 'Determines where the website is served from, including CSS & JS assets (needed for MyST)'
+        required: false
+        default: '/${{ github.event.repository.name }}'
+        type: string
 
     secrets:
       ARM_USERNAME:
@@ -80,12 +79,16 @@ on:
         description: 'NASA Earthdata API Password'
         required: false
 
+env:
+  # the BASE_URL environment variable needs to be set if building with myst
+  BASE_URL: ${{ inputs.base_url }}
+
 jobs:
   build:
     runs-on: ubuntu-latest
     defaults:
       run:
-        shell: bash -l {0}
+        shell: bash -leo pipefail {0}
     steps:
       - name: Checkout the code from the repo
         if: inputs.build_from_code_artifact == 'false'
@@ -108,10 +111,11 @@ jobs:
         run: |
           unzip pr_code.zip
           rm -f pr_code.zip   
-
-      # - name: Fetch Repo Name
-      #   id: repo-name
-      #   run: echo "value=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_OUTPUT  # just the repo name, not owner
+    
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
 
       - name: Get GitHub environment variables
         id: get-env
@@ -150,26 +154,11 @@ jobs:
         run: |
           echo '(DEBUG) The value of steps.env_change.outputs.any_changed is:'
           echo ${{ steps.env_change.outputs.any_changed }}
-
-      - name: Setup Miniforge
-        uses: conda-incubator/setup-miniconda@v3
-        with:
-          miniforge-version: latest
-          python-version: "3.10"  # binderbot is failing with python 3.11
-          activate-environment: ${{ inputs.environment_name }}
-
-      - name: Set cache date
-        if: inputs.use_cached_environment == 'true'
-        run: echo "DATE=$(date +'%Y%m%d')" >> $GITHUB_ENV
-
-      - uses: actions/cache@v4
-        if: inputs.use_cached_environment == 'true'
+      
+      - name: Setup environment with micromamba
+        uses: mamba-org/setup-micromamba@v2
         with:
-          path: /usr/share/miniconda3/envs/${{ inputs.environment_name }}
-          # This should create a key that looks like 'linux-64-conda-environment.yml-[HASH]-_config.yml-[HASH]-DATE'
-          # Logic inspired by https://dev.to/epassaro/caching-anaconda-environments-on-github-actions-2d08
-          key: ${{ format('linux-64-conda-{0}-{1}-{2}-{3}-{4}', inputs.environment_file, hashFiles(format('{0}', inputs.environment_file)), '_config.yml', hashFiles(format('{0}', '_config.yml')), env.DATE )}}
-        id: cache
+          environment-file: ${{ inputs.environment_file }}
 
       - name: Create book build environment
         if: |
@@ -182,16 +171,6 @@ jobs:
           pip install git+https://github.com/pangeo-gallery/binderbot.git
           conda list
 
-      - name: Update execution environment
-        if: |
-          (inputs.use_cached_environment != 'true'
-          || steps.cache.outputs.cache-hit != 'true'
-          || steps.env_change.outputs.any_changed == 'true')
-          && steps.parse_config.outputs.execute_notebooks != 'binder'
-        run: |
-          conda env update -n ${{ inputs.environment_name }} -f ${{ inputs.environment_file }}
-          conda list
-
       - name: Get paths to notebook files
         if: |
           steps.parse_config.outputs.execute_notebooks == 'binder'
@@ -258,6 +237,7 @@ jobs:
       - name: Build the book
         # Assumption is that if execute_notebooks != 'binder' then the _config.yml file must be set to execute notebooks during build
         env:
+          # BASE_URL: /${{ github.repository }}
           ARM_USERNAME: ${{ secrets.ARM_USERNAME }}
           ARM_PASSWORD: ${{ secrets.ARM_PASSWORD }}
           AQS_USERNAME: ${{ secrets.AQS_USERNAME }}
@@ -276,7 +256,7 @@ jobs:
           if [ -f book.zip ]; then
               rm -rf book.zip
           fi
-          zip -r book.zip ${{ inputs.path_to_notebooks }}/ ${{ inputs.output_path }}
+          zip -r book.zip ${{ inputs.path_to_notebooks }}/${{ inputs.output_path }}
 
       - name: Upload zipped book artifact
         uses: actions/upload-artifact@v4

.github/workflows/deploy-book.yaml

@@ -66,4 +66,4 @@ jobs:
           folder: ${{ inputs.publish_dir }}
           clean: true
           clean-exclude: _preview/*  # keep existing previews from other PRs
-          target-folder: ${{ inputs.destination_dir }}
+          target-folder: ${{ inputs.destination_dir }}