Setting up Docker image and Jupyter book build and deploy on GitHub

Author: mgenet

.binder/Dockerfile

@@ -6,7 +6,8 @@
 ###                                                                          ###
 ################################################################################
 
-FROM registry.gitlab.inria.fr/mgenet/dolfin_warp-tutorials:latest
+# FROM registry.gitlab.inria.fr/mgenet/dolfin_warp-tutorials:latest
+FROM ghcr.io/mgenet/dolfin_warp-tutorials:latest
 
 # Copy repo into the image, cf. https://mybinder.readthedocs.io/en/latest/tutorials/dockerfile.html. MG20230531: OMG this copies from the "build context", cf. https://stackoverflow.com/questions/73156067/where-does-the-copy-command-in-docker-copy-from; here it seems to be the repo itself.
 ARG NB_USER=jovyan

.github/workflows/build_and_deploy_jupyter_book.yml

@@ -0,0 +1,31 @@
+on:
+  - push
+
+jobs:
+  build_and_deploy_jupyter_book:
+    runs-on: ubuntu-latest
+
+    permissions:
+      pages: write
+      
+    environment:
+      name: github-pages
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+    
+      - name: Build Jupyter Book
+        run: |
+          pip install -U jupyter-book
+          jupyter-book clean .
+          jupyter-book build .
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: github-pages
+          path: "_build/html"
+
+      - name: Deploy Jupyter Book to GitHub Pages
+        uses: actions/deploy-pages@v4

.github/workflows/build_and_push_docker_image.yml

@@ -0,0 +1,21 @@
+on:
+  - push
+
+jobs:
+  build_and_push_docker_image:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@main
+
+      - name: Removing Docker file
+        run: |
+          rm -rf ${{github.workspace}}/.binder
+          cp ${{github.workspace}}/.repo2docker/* ${{github.workspace}}/.
+          
+      - name: Build and push docker image
+        uses: jupyterhub/repo2docker-action@master
+        with:
+          DOCKER_USERNAME: ${{github.actor}}
+          DOCKER_PASSWORD: ${{secrets.GITHUB_TOKEN}}
+          DOCKER_REGISTRY: ghcr.io

.github/workflows/mirror_to_gitlab.yml

@@ -0,0 +1,16 @@
+on:
+  - push
+  - delete
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - uses: wangchucheng/git-repo-sync@v0.1.0
+      with:
+        target-url: https://gitlab.inria.fr/mgenet/dolfin_warp-tutorials
+        target-username: mgenet
+        target-token: ${{secrets.GITLAB_TOKEN}}

.gitlab-ci.yml

@@ -15,7 +15,6 @@ build_docker:
   tags:
     - ci.inria.fr
     - large
-  # image: registry.gitlab.inria.fr/inria-ci/docker/ubuntu:20.04
   image: ubuntu:20.04
   script:
     - apt update; DEBIAN_FRONTEND=noninteractive apt install -y ca-certificates curl git gnupg lsb-release mercurial python3 python3-pip tzdata

README.md

@@ -1,5 +1,5 @@
 # Welcome to the dolfin_warp tutorials!
 
-Main library can be found at https://gitlab.inria.fr/mgenet/dolfin_warp
+Main library can be found at https://github.com/mgenet/dolfin_warp
 
-Interactive tutorials can be found at https://mgenet.gitlabpages.inria.fr/dolfin_warp-tutorials/index.html.
+Interactive tutorials can be found at https://mgenet.github.io/dolfin_warp-tutorials.

index.md

@@ -1,5 +1,5 @@
 # Welcome to the dolfin_warp tutorials!
 
-Main library can be found at [https://gitlab.inria.fr/mgenet/dolfin_warp](https://gitlab.inria.fr/mgenet/dolfin_warp).
+Main library can be found at [https://github.com/mgenet/dolfin_warp](https://github.com/mgenet/dolfin_warp).
 
 Tutorials can be browsed statically but also interactively—to start a session and run the code just click on the rocket icon at the top of a tutorial page and then click on Binder.

tutos/tuto_warp.ipynb

@@ -24,7 +24,7 @@
    "source": [
     "import dolfin # https://fenicsproject.org\n",
     "\n",
-    "import dolfin_warp as dwarp # https://gitlab.inria.fr/mgenet/dolfin_warp\n",
+    "import dolfin_warp as dwarp # https://github.com/mgenet/dolfin_warp\n",
     "\n",
     "import lib_viewer"
    ]
@@ -488,7 +488,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.15"
+   "version": "3.10.14"
   },
   "toc": {
    "base_numbering": 1,