Add PR preview deployment logic

.github/workflows/deploy.yml → .github/workflows/publish-book.yml

@@ -1,7 +1,10 @@
-name: build-and-deploy-book
+name: publish-book
 
-# Trigger the workflow on push to main branch and PRs
-on: [push, pull_request]
+# Trigger the workflow on push to main branch
+on:
+  push:
+    branches:
+      - main
 # This job installs dependencies, builds the book, and deploys the html
 jobs:
   build-and-deploy-book:
@@ -51,6 +54,7 @@ jobs:
         run: |
           find _build/html -name "*.log" -print -exec cat {} \;
       - name: 🚀 Deploy to GitHub Pages
+        # redudant but keeping for testing purposes
         if: github.ref == 'refs/heads/main'
         uses: peaceiris/[email protected]
         with:

.github/workflows/trigger-book-build.yml

@@ -0,0 +1,49 @@
+name: trigger-book-build
+on:
+  pull_request:
+
+jobs:
+  install-dependencies:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.9]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Get PR number
+        run: echo "Your PR is ${PR}"
+        env:
+          PR: ${{ github.event.pull_request.number }}
+      - name: 📦 Cache Conda Packages
+        uses: actions/cache@v2
+        env:
+          # Increase this value to reset cache if etc/example-environment.yml has not changed
+          CACHE_NUMBER: 0
+        with:
+          path: ~/conda_pkgs_dir
+          key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('conda-linux-64.lock') }}
+      - name: 🐍 Set up Conda environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: false
+          activate-environment: DGM2lines
+          environment-file: conda-linux-64.lock
+      - name: 👀 Check Conda environment
+        shell: bash -l {0}
+        run: |
+          pip install -r requirements.txt
+          conda info
+          conda list
+      - name: 📦 Cache Notebooks
+        uses: actions/cache@v2
+        with:
+          path: _build/.jupyter_cache
+          key: notebook_cache-${{hashFiles('_toc.yml', '_config.yml', 'environment.yml') }}
+  build:
+    uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main
+    with:
+      environment_name: DGM2lines
+      artifact_name: book-zip-${{ github.event.number }}
+      path_to_notebooks: "src"
+      build_command: "jupyter-book build --keep-going ."

.github/workflows/trigger-delete-preview.yml

@@ -0,0 +1,9 @@
+name: trigger-delete-preview
+
+on:
+  pull_request_target:
+    types: closed
+
+jobs:
+  delete:
+    uses: ProjectPythia/cookbook-actions/.github/workflows/delete-preview.yaml@main

.github/workflows/trigger-preview.yml

@@ -0,0 +1,29 @@
+name: trigger-preview
+on:
+  workflow_run:
+    workflows:
+      - trigger-book-build
+    types:
+      - requested
+      - completed
+permissions:
+  pull-requests: write
+jobs:
+  find-pull-request:
+    uses: ProjectPythia/cookbook-actions/.github/workflows/find-pull-request.yaml@main
+  deploy-preview:
+    needs: find-pull-request
+    if: github.event.workflow_run.conclusion == 'success'
+    uses: ProjectPythia/cookbook-actions/.github/workflows/deploy-book.yaml@main
+    with:
+      artifact_name: book-zip-${{ needs.find-pull-request.outputs.number }}
+      destination_dir: _preview/${{ needs.find-pull-request.outputs.number }} # deploy to subdirectory labeled with PR number
+      is_preview: 'true'
+      publish_dir: "src/_build/html"
+
+  preview-comment:
+    needs: find-pull-request
+    uses: ProjectPythia/cookbook-actions/.github/workflows/preview-comment.yaml@main
+    with:
+      pull_request_number: ${{ needs.find-pull-request.outputs.number }}
+      sha: ${{ needs.find-pull-request.outputs.sha }}

.gitignore

@@ -6,13 +6,9 @@ __pycache__
 *.jpeg
 *.npz
 *.pth
-_build/*
+src/_build/*
 _notebook_cache/*
-notebooks/figs/symbolic_regression.png
-notebooks/figs/symbolic_regression_pw.png
 notebooks/Source.gv
 notebooks/*.pkl
 notebooks/*.csv*
-notebooks/figs/symbolic_regression.svg
-notebooks/figs/symbolic_regression_pw.svg
 dataset*