Merge pull request #869 from cambridge-cares/fix-dtvf-action

fix-dtvf-action

Author: mdhillman

.github/workflows/dtvf_release.yml

@@ -32,7 +32,7 @@ jobs:
       # Checkout the repository
       - name: Checkout repository
         uses: actions/checkout@v3
-        
+          
       # Get the version of the DTVF
       - name: Get DTVF version
         id: versioner
@@ -44,7 +44,7 @@ jobs:
         id: compiler
         working-directory: ./web/digital-twin-vis-framework/library
         run: |
-          docker-compose -f docker/docker-compose.yml up compile
+          docker-compose -f docker-compose.dev.yml up compile
           zip -r $HOME/dtvf.zip output/
           echo zip=$HOME/dtvf.zip >> $GITHUB_ENV
           
@@ -61,11 +61,11 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           push: true
-          context: ./web/digital-twin-vis-framework/library/docker
+          context: ./web/digital-twin-vis-framework/library
           tags: |
-            "ghcr.io/cambridge-cares/dtvf-base-image:${{ env.version }}"
-            "ghcr.io/cambridge-cares/dtvf-base-image:latest"
-          
+            ghcr.io/cambridge-cares/dtvf-base-image:${{ env.version }}
+            ghcr.io/cambridge-cares/dtvf-base-image:latest
+         
       # Generate the release body text
       - name: Generate release text
         id: generate-text

web/digital-twin-vis-framework/CHANGELOG.md

@@ -1,5 +1,11 @@
 [//]: # (Note that version headers need to start with "# " characters to be picked up by some automated scripts)
 
+# 3.8.3
+### Features
+* _No features present._
+### Bug Fixes:
+* Separated and moved docker config files to better support GitHub actions.
+
 # 3.8.2
 ### Features
 * _No features present._

…-vis-framework/library/docker/Dockerfile …al-twin-vis-framework/library/Dockerfileweb/digital-twin-vis-framework/library/docker/Dockerfile renamed to web/digital-twin-vis-framework/library/Dockerfile web/digital-twin-vis-framework/library/docker/Dockerfile renamed to web/digital-twin-vis-framework/library/Dockerfile

@@ -28,15 +28,15 @@ RUN apk update && apk add procps nano wget bash busybox-initscripts dos2unix apa
 RUN mkdir -p /var/www/dtvf
 COPY --from=build /app/output/ /var/www/dtvf/
 
+# Custom in the HTTPD configuration
+COPY ./resources/httpd.conf /etc/apache2/httpd.conf
+
 # Copy in the start-up script
-COPY ./docker/start-up.sh /usr/local/start-up.sh
+COPY ./resources/start-up.sh /usr/local/start-up.sh
 RUN chmod 777 /usr/local/start-up.sh
 RUN chmod +x /usr/local/start-up.sh
 RUN dos2unix /usr/local/start-up.sh
 
-# Custom in the HTTPD configuration
-COPY ./docker/httpd.conf /etc/apache2/httpd.conf
-
 # Permissions
 RUN mkdir -p /var/www/html
 RUN chmod -R 775 /var/www/
@@ -45,4 +45,4 @@ RUN chmod -R 775 /var/www/
 EXPOSE 80
 
 # Run cron daemon and boot script at start
-CMD [ "/bin/bash", "-c", "/usr/local/start-up.sh" ]
+CMD [ "/bin/bash", "-c", "/usr/local/start-up.sh" ]

…ramework/library/docker/build.Dockerfile …win-vis-framework/library/Dockerfile.devweb/digital-twin-vis-framework/library/docker/build.Dockerfile renamed to web/digital-twin-vis-framework/library/Dockerfile.dev web/digital-twin-vis-framework/library/docker/build.Dockerfile renamed to web/digital-twin-vis-framework/library/Dockerfile.dev

@@ -65,7 +65,9 @@ When launched from a correctly integrated HTML file, the DTVF follows a set patt
 
 ## Deployment of Base Image
 
-The intended workflow of creating DTVF visualisations is to use a standard base image that contains the compiled DTVF library and an Apache web server to host content. The base image can be built from this directory by running the `build.sh` script. Note that it will be tagged with the version currently listed within the `VERSION` file.
+The intended workflow of creating DTVF visualisations is to use a standard base image that contains the compiled DTVF library and an Apache web server to host content.
+
+The base image can be built from this directory by running the `build.sh` script. Note that this will result in an image tagged with `:latest`, when pushing to the GitHub image registry this tag **and** a copy of the same image tagged with the version number (i.e. `:1.2.3`) should be pushed. To that end, we recommend leaving the pushing of new images to the automated GitHub actions, as they'll handle this.
 
 <br/>
 

web/digital-twin-vis-framework/library/README.md

@@ -1 +1 @@
-3.8.2
+3.8.3

web/digital-twin-vis-framework/library/VERSION

@@ -1,20 +1,7 @@
 #!/bin/bash
 
 #
-# Use this script to build the latest copy of the DTVF image for deployment.
+# Use this script to build the latest copy of the DTVF base image for local use.
 #
 
-# Read the version
-VERSION=`cat -s "./VERSION" 2>/dev/null`
-echo "Determined DTVF version as: $VERSION"
-
-# Write the '.env' file
-echo "TAG=$VERSION" > ./docker/.env
-echo "Written .env file"
-
-# Run docker compose build command
-echo "Building dtvf-base-image..."
-docker compose -f ./docker/docker-compose.yml build
-
-# Clean up
-rm ./docker/.env
+docker compose -f docker-compose.yml build --no-cache

web/digital-twin-vis-framework/library/build.sh

@@ -0,0 +1,23 @@
+#
+# Compose file for the DTVF (development).
+#
+version: "3.8"
+
+# All Services
+services:
+
+  # Compilation container.
+  # This container will compile the source code, package it for deployment, write it to the ./output folder, then shutdown.
+  compile:
+    build:
+      context: "./"
+      dockerfile: "Dockerfile.dev"
+    image: ghcr.io/cambridge-cares/dtvf-build-environment:latest
+    container_name: "dtvf-build-compile"
+    restart: "no"
+    working_dir: "/app"
+    entrypoint: "/bin/bash -c 'npm install && tsc && grunt package'"
+    volumes:
+      - type: bind
+        source: ./
+        target: /app

web/digital-twin-vis-framework/library/docker-compose.dev.yml

@@ -0,0 +1,23 @@
+#
+# Compose file for the DTVF.
+#
+version: "3.8"
+
+# All Services
+services:
+
+  # Empty DTVF visualisation image for deployment. Builds a base image that, when combined
+  # with a volume of files, can be used as a visualisation. It is not intended that this
+  # config is used to run the dtvf-base-image.
+  visualise:
+    image: ghcr.io/cambridge-cares/dtvf-base-image:latest
+    container_name: "empty-dtvf-container"
+    restart: "no"
+    build:
+      context: "./"
+      dockerfile: "Dockerfile"
+      labels:
+        authors: "support@cmcl.io"
+        description: "Empty visualisation image, ready to house web files."
+    ports:
+      - "80:80"