Use GitHub Actions for Docker build

Author: mwtrew

.github/workflows/docker-build-and-push.yml

@@ -0,0 +1,80 @@
+# see https://docs.github.com/en/actions/use-cases-and-examples/publishing-packages/publishing-docker-images#publishing-images-to-github-packages
+name: Create and publish Docker images
+
+on:
+  push
+
+env:
+  REGISTRY: ghcr.io
+  NAMESPACE: isaacphysics
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+
+    strategy:
+      matrix:
+        target: [build-phy, build-phy-renderer, build-ada, build-ada-renderer]
+        include:
+          - target: build-phy
+            image-name: isaac-phy-app
+          - target: build-phy-renderer
+            image-name: isaac-phy-app-renderer
+          - target: build-ada
+            image-name: isaac-ada-app
+          - target: build-ada-renderer
+            image-name: isaac-ada-app-renderer
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Get metadata for image
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.NAMESPACE }}/${{ matrix.image-name }}
+          tags: |
+            type=sha,prefix=,format=long
+            type=ref,event=branch
+            type=ref,event=tag
+            type=ref,event=pr
+      - name: Load API version from .env file for release
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          source .env
+          echo REACT_APP_API_VERSION="$REACT_APP_API_VERSION" >> $GITHUB_ENV
+      - name: Build and push image for release
+        # If this is a release tag (vX.Y.Z), bake in the API version defined in .env.
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        if: startsWith(github.ref, 'refs/tags/v')
+        with:
+          context: .
+          build-args: |
+            BUILD_TARGET=${{ matrix.target }}
+            REACT_APP_API_VERSION=${{ env.REACT_APP_API_VERSION }}
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+      - name: Build and push image
+        # Otherwise, assume there is an API branch or tag with the same name(!) and override the app to use that.
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        if: startsWith(github.ref, 'refs/tags/v') != true
+        with:
+          context: .
+          build-args: |
+            BUILD_TARGET=${{ matrix.target }}
+            REACT_APP_API_VERSION=${{ steps.meta.outputs.version }}
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -15,7 +15,7 @@ bundle-stats-*.json
 
 # production
 /build
-/build-physics
+/build-phy
 /build-ada
 /build-phy-renderer
 /build-ada-renderer

Dockerfile

@@ -1,10 +1,24 @@
-FROM nginx:stable
+ARG BUILD_TARGET="build-phy"
+
+FROM node:20.12.0-buster AS builder
+ARG BUILD_TARGET
+ARG REACT_APP_API_VERSION
+
+RUN mkdir /build
+WORKDIR /build
 
-ARG API_VERSION
-ARG SUBJECT
-ARG RENDERER_PATH=""
+COPY package.json /build
+COPY yarn.lock /build
+RUN yarn install --frozen-lockfile
+
+COPY . /build
+RUN yarn $BUILD_TARGET
+
+FROM nginx:stable
+ARG BUILD_TARGET
+ARG REACT_APP_API_VERSION
 
+COPY --from=builder /build/$BUILD_TARGET/ /usr/share/nginx/html
 COPY nginx.conf /etc/nginx/nginx.conf
-COPY ./build-$SUBJECT$RENDERER_PATH/ /usr/share/nginx/html
 
-LABEL apiVersion=$API_VERSION
+LABEL apiVersion=$REACT_APP_API_VERSION

Dockerfile-Builder

@@ -15,6 +15,8 @@ if [ $# -lt 4 ] || ! { [ $1 = "ada" ] || [ $1 = "phy" ]; } || ! { [ $2 = "dev" ]
   exit 1
 fi
 
+DOCKER_REPO=ghcr.io/isaacphysics
+
 # Extract args:
 SITE=$1
 ENV=$2
@@ -26,13 +28,13 @@ shift 3
 # Use the app image to find the correct API version to use:
 if [ $1 = "create" ] || [ $1 = "pull" ] || [ $1 = "push" ] || [ $1 = "run" ] || [ $1 = "start" ] || [ $1 = "up" ]; then
   # This will cause new containers or should update containers, so pull newer images if possible:
-  docker pull docker.isaacscience.org/isaac-$SITE-app:$APP_VERSION
-  API_VERSION=$(docker inspect -f '{{.Config.Labels.apiVersion}}' docker.isaacscience.org/isaac-$SITE-app:$APP_VERSION)
-  docker pull docker.isaacscience.org/isaac-api:$API_VERSION
+  docker pull $DOCKER_REPO/isaac-$SITE-app:$APP_VERSION
+  API_VERSION=$(docker inspect -f '{{.Config.Labels.apiVersion}}' $DOCKER_REPO/isaac-$SITE-app:$APP_VERSION)
+  docker pull $DOCKER_REPO/isaac-api:$API_VERSION
 
 elif [ $1 = "down" ] || [ $1 = "stop" ] || [ $1 = "restart" ] || [ $1 = "exec" ] || [ $1 = "config" ] || [ $1 = "logs" ] || [ $1 = "kill" ] || [ $1 = "ps" ]; then
   # This affects existing containers, so don't pull newer images:
-  API_VERSION=$(docker inspect -f '{{.Config.Labels.apiVersion}}' docker.isaacscience.org/isaac-$SITE-app:$APP_VERSION)
+  API_VERSION=$(docker inspect -f '{{.Config.Labels.apiVersion}}' $DOCKER_REPO/isaac-$SITE-app:$APP_VERSION)
 
 else
   # This might not be a docker-compose operation. If it is, it could be added above to the correct branch.
@@ -63,15 +65,15 @@ version: '2'
 services:
   $APP_NAME:
     container_name: $APP_NAME
-    image: docker.isaacscience.org/isaac-$SITE-app:$APP_VERSION
+    image: $DOCKER_REPO/isaac-$SITE-app:$APP_VERSION
     restart: "no"
     networks:
       default:
         aliases:
           - $SITE-app-$ENV
   $API_NAME:
     container_name: $API_NAME
-    image: docker.isaacscience.org/isaac-api:$API_VERSION
+    image: $DOCKER_REPO/isaac-api:$API_VERSION
     restart: "no"
     extra_hosts:
       - local-smtp:$LOCAL_SMTP

build-in-docker.sh

@@ -10,6 +10,8 @@ if [ $# -lt 3 ] || ! { [ $1 = "ada" ] || [ $1 = "phy" ]; }; then
   exit 1
 fi
 
+DOCKER_REPO=ghcr.io/isaacphysics
+
 # Extract args:
 SITE=$1
 APP_VERSION=$2
@@ -20,13 +22,13 @@ shift 2
 # Use the app image to find the correct API version to use:
 if [ $1 = "create" ] || [ $1 = "pull" ] || [ $1 = "push" ] || [ $1 = "run" ] || [ $1 = "start" ] || [ $1 = "up" ]; then
   # This will cause new containers or should update containers, so pull newer images if possible:
-  docker pull docker.isaacscience.org/isaac-$SITE-app:$APP_VERSION
-  API_VERSION=$(docker inspect -f '{{.Config.Labels.apiVersion}}' docker.isaacscience.org/isaac-$SITE-app:$APP_VERSION)
-  docker pull docker.isaacscience.org/isaac-etl:$API_VERSION
+  docker pull $DOCKER_REPO/isaac-$SITE-app:$APP_VERSION
+  API_VERSION=$(docker inspect -f '{{.Config.Labels.apiVersion}}' $DOCKER_REPO/isaac-$SITE-app:$APP_VERSION)
+  docker pull $DOCKER_REPO/isaac-etl:$API_VERSION
 
 elif [ $1 = "down" ] || [ $1 = "stop" ] || [ $1 = "restart" ] || [ $1 = "exec" ] || [ $1 = "config" ] || [ $1 = "logs" ] || [ $1 = "kill" ] || [ $1 = "ps" ]; then
   # This affects existing containers, so don't pull newer images:
-  API_VERSION=$(docker inspect -f '{{.Config.Labels.apiVersion}}' docker.isaacscience.org/isaac-$SITE-app:$APP_VERSION)
+  API_VERSION=$(docker inspect -f '{{.Config.Labels.apiVersion}}' $DOCKER_REPO/isaac-$SITE-app:$APP_VERSION)
 
 else
   # This might not be a docker-compose operation. If it is, it could be added above to the correct branch.
@@ -55,7 +57,7 @@ version: '2'
 services:
   $SITE-etl:
     container_name: $ETL_NAME
-    image: docker.isaacscience.org/isaac-etl:$API_VERSION
+    image: $DOCKER_REPO/isaac-etl:$API_VERSION
     environment:
       - SEGUE_CONFIG_LOCATION=/local/data/config/segue-config.dec.yaml
       - JAVA_OPTIONS=-Dlog.path=/isaac-logs -Dsegue.version=$API_VERSION -Djetty.port=8090