Merge pull request #43 from UBC-DSCI/dev

update main

Author: trevorcampbell

.github/CODEOWNERS

@@ -0,0 +1 @@
+source/** @UBC-DSCI/dsci-100-instructors

.github/workflows/build_book.yml

@@ -1,3 +1,4 @@
+name: Rebuild and deploy book to gh-pages branch
 on:
   push:
     branches:
@@ -7,36 +8,20 @@ on:
 
 jobs:
   deploy-book:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     permissions:
       contents: write
       packages: write
 
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - os: ubuntu-latest
-            lock-file: conda-linux-64.lock
-        os: [ubuntu-latest]
-    defaults:
-      run:
-        shell: bash -l {0}
     steps:
       - name: checkout
         uses: actions/checkout@v2
         with:
           ref: 'main'
 
-      - name: install from lockfile
-        uses: mamba-org/provision-with-micromamba@main
-        with:
-          environment-name: lock_test
-          environment-file: .github/workflows/lockfiles/${{ matrix.lock-file }}
-
       - name: Build the book
         run: |
-          jupyter-book build source
+          ./build_html.sh
 
        # Push the book's HTML to github-pages
       - name: GitHub Pages action

.github/workflows/update_build_environment.yml

@@ -0,0 +1,40 @@
+name: Rebuild and publish new ubcdsci/py-intro-to-ds image on DockerHub
+on:
+  push:
+    branches:
+      - dev
+    paths:
+      - Dockerfile
+jobs:
+  rebuild-docker:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - name: Checkout dev
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: '0'
+        ref: 'dev'
+    - name: Rebuild and publish image
+      id: rebuild
+      uses: elgohr/Publish-Docker-Github-Action@v5
+      with:
+        name: ubcdsci/py-intro-to-ds
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}
+        dockerfile: Dockerfile
+        snapshot: true
+    - name: Update build_html.sh script
+      run: |
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        git pull origin dev
+        sed 's/ubcdsci\/py-intro-to-ds:[[:alnum:]]\+/ubcdsci\/py-intro-to-ds:${{ steps.rebuild.outputs.snapshot-tag }}/g' build_html.sh > build_html.tmp && mv build_html.tmp build_html.sh
+        git add build_html.sh
+        git commit -m "update build_html.sh script with new docker image"
+    - name: Push changes to build scripts
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: 'dev'

Dockerfile

@@ -1,3 +1,4 @@
+# Dockerfile for intro to ds python book
 FROM jupyter/scipy-notebook
 
 USER root
@@ -20,7 +21,6 @@ RUN mamba install --quiet --yes \
         'click' \
         'ghp-import' \
         'jupytext' \
-        'jupyter_contrib_nbextensions' \
         'jupyter-book' \
         'nodejs' \
     && mamba clean --all -f -y \

README.md

@@ -14,8 +14,7 @@ See [the license file](LICENSE.md) for more information.
 
 ### Setup
 
-In order to build the book, you need to first install Docker 
-(instructions here: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)).
+Building the book requires Docker (instructions here: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)).
 
 ### Contributing 
 Primary development in this repository happens on the `dev` branch. If you want to contribute to the book,
@@ -35,7 +34,7 @@ in the root directory of this repository. The book can be viewed in your browser
 
 You can update the build environment for the book by making changes to `Dockerfile` in the root of the repository in the `dev` branch.
 If you push any changes to the `Dockerfile` on the `dev` branch, GitHub will trigger a rebuild of the docker image,
-push it to DockerHub, and update the `build_html.sh` script and book deploy GitHub action with the new image digest.
+push it to DockerHub, and update the `build_html.sh` script and book deploy GitHub action with the new image tag.
 
 ### Update public html
 

build_html.sh

@@ -0,0 +1 @@
+docker run --rm -v $(pwd):/home/jovyan ubcdsci/py-intro-to-ds:202212112047457751d4 /bin/bash -c "jupyter-book build source"