Merge pull request #5 from KVSlab/add-docker-workflow

Add docker workflows script for Github actions

Author: hkjeldsberg

.github/workflows/docker.yml

@@ -0,0 +1,57 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Create and publish a Docker image
+
+on:
+  push:
+    branches:
+      - "!*"
+    tags:
+      - "v*"
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64 #,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          file: docker/Dockerfile

CITATION.cff

@@ -1,9 +1,9 @@
 cff-version: 1.2.0
-message: "If you use this software, please cite it as below."
+message: "If you use OasisMove, please cite it as below."
 authors:
 - family-names: "Kjeldsberg"
   given-names: "Henrik A."
   orcid: "0000-0002-7764-4248"
 title: "OasisMove"
 version: "0.1.0"
-date-released: 2023-01-28
+date-released: 2023-04-26

docker/Dockerfile

@@ -12,6 +12,9 @@ RUN mamba upgrade -y mamba
 # Copy environment and requirements files into docker env
 COPY . ${WORKDIR}
 
+# Update environment file with new environment name
+RUN mamba env update --file environment.yml --name dockerenv
+
 RUN echo "source activate dockerenv" > ~/.bashrc
 
 RUN mamba run -n dockerenv python -m pip install .[test]

pyproject.toml

@@ -4,7 +4,7 @@ requires = ["setuptools>=61.0.0", "wheel"]
 [project]
 name = "oasismove"
 version = "0.1.0"
-description = "Moving domain version of Oasis"
+description = "Verified and validated CFD solver for moving domains"
 authors = [{ name = "Henrik A. Kjeldsberg", email = "[email protected]" }]
 license = { file = "LICENSE" }
 readme = "README.md"