Merge pull request #117 from coding-for-reproducible-research/refactored-github-action

Seperate out building and deploying of juypter book in github action

Author: liamjberrisford

.github/workflows/deploy.yml

@@ -1,6 +1,6 @@
 name: deploy-book
 
-# Run this on push to master/main branches and on pull requests
+# Run this on push to main branches and on pull requests
 on:
   push:
     branches:
@@ -11,7 +11,7 @@ on:
 
 # This job installs dependencies, builds the book, and pushes it to `gh-pages`
 jobs:
-  deploy-book:
+  build-book:
     runs-on: ubuntu-latest
     permissions:
       pages: write
@@ -33,7 +33,7 @@ jobs:
     # if you have config:
     # execute:
     #   execute_notebooks: cache
-    - name: cache executed notebooks
+    - name: Cache executed notebooks
       uses: actions/cache@v3
       with:
         path: _build/.jupyter_cache
@@ -46,11 +46,31 @@ jobs:
 
     # Upload the book's HTML as an artifact
     - name: Upload artifact
-      uses: actions/upload-pages-artifact@v2
+      uses: actions/upload-artifact@v3
+      with:
+        name: jupyter-book-html
+        path: "_build/html"
+
+  deploy-book:
+    needs: build-book
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - uses: actions/checkout@v3
+
+    # Download the built book artifact
+    - name: Download artifact
+      uses: actions/download-artifact@v3
       with:
+        name: jupyter-book-html
         path: "_build/html"
 
     # Deploy the book's HTML to GitHub Pages
     - name: Deploy to GitHub Pages
       id: deployment
       uses: actions/deploy-pages@v2
+      with:
+        path: "_build/html"