feat(explorer): build docker image on pull request + refactor dockerfile for ipfs (#3245)

2023-03-23 10:50:23 +01:00 · 2023-03-23 10:50:23 +01:00 · 34d5f3fd13
commit 34d5f3fd13
parent a060f94146
7 changed files with 78 additions and 172 deletions
--- a/.github/workflows/publish-docker-containers.yml
+++ b/.github/workflows/publish-docker-containers.yml
@ -1,54 +1,20 @@
 name: Publish docker containers

 'on':
-  push:
-    tags:
-      - 'v[0-9]+.[0-9]+.[0-9]+'
-      - 'v[0-9]+.[0-9]+.[0-9]+-*'
-
-  workflow_dispatch:
-    inputs:
-      publish:
-        description: 'Publish tag to Docker Hub & GitHub Registry'
-        required: false
-        type: boolean
-        default: false
-      tag:
-        description: 'Git Tag to build and publish'
-        required: false
-        type: string
-        default: ''
-      apps:
-        description: 'Applications to build and publish'
-        required: false
-        type: choice
-        options:
-          - '["explorer", "token", "trading"]'
-          - '["explorer"]'
-          - '["token"]'
-          - '["trading"]'
-      archs:
-        description: 'Architecture to build and publish'
-        required: false
-        type: choice
-        options:
-          - linux/amd64, linux/arm64
-          - linux/amd64
-          - linux/arm64
+  pull_request:

 jobs:
  master:
    strategy:
      fail-fast: false
+      # to be replaced by nix: https://github.com/vegaprotocol/frontend-monorepo/blob/develop/tools/ipfs-deploy.js#L106-L108
      matrix:
-        app: ${{ fromJson(inputs.apps || '["explorer", "token", "trading"]') }}
+        app: ${{ fromJson('["explorer"]') }}
    name: Build the ${{ matrix.app }} image
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@v3
-        with:
-          ref: ${{ inputs.tag }}

      - name: Set up QEMU
        id: quemu
@ -60,67 +26,64 @@ jobs:
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2

-      - name: Login to DockerHub
-        if: ${{ inputs.publish || startsWith(github.ref, 'refs/tags/') }}
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
+      # https://docs.github.com/en/actions/learn-github-actions/contexts
+      # https://github.com/actions/checkout#Checkout-pull-request-HEAD-commit-instead-of-merge-commit
      - name: Determine Docker Image tag
        id: tags
        run: |
-          hash=$(git rev-parse HEAD|cut -b1-8)
-          versionTag=${{ inputs.tag || startsWith(github.ref, 'refs/tags/') && github.ref_name || '${hash}' }}
+          npmVersion=$(cat .nvmrc | head -n 1)
+          versionTag=${{ startsWith(github.ref, 'refs/tags/') && github.ref_name || github.event.pull_request.head.sha }}
+          echo ::set-output name=npmVersion::${npmVersion}
          echo ::set-output name=version::${versionTag}
-          echo ::set-output name=npmVersion::$(cat dockerfiles/${{ matrix.app =='trading' && 'Dockerfile.next' || 'Dockerfile.cra' }} | grep FROM | head -n 1 | awk '{print $2}' | cut -d ':' -f 2 | cut -d '-' -f 1 )

      - name: Print config
        run: |
          git rev-parse --verify HEAD
          git status
-          echo "inputs.tag=${{ inputs.tag }}"
-          echo "inputs.publish=${{ inputs.publish }}"
-          echo "inputs.apps=${{ inputs.apps }}"
-          echo "inputs.archs=${{ inputs.archs }}"
          echo "steps.tags.outputs.version=${{ steps.tags.outputs.version }}"

-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ steps.tags.outputs.npmVersion }}
-
-      - name: Build frontend dists
-        run: |
-          yarn --verbose --pure-lockfile
-          yarn nx ${{ matrix.app =='trading' && 'export' || 'build' }} ${{ matrix.app }} --pure-lockfile
-
      - name: Build and export to local Docker
        uses: docker/build-push-action@v3
        with:
          context: .
          push: false
-          file: dockerfiles/${{ matrix.app =='trading' && 'Dockerfile.next' || 'Dockerfile.cra' }}.dist
-          build-args: APP=${{ matrix.app }}
+          file: dockerfiles/Dockerfile
+          build-args: |
+            APP=${{ matrix.app }}
+            NODE_VERSION=${{ steps.tags.outputs.npmVersion }}
          load: true
-          tags: vegaprotocol/${{ matrix.app }}:local
+          tags: |
+            ghcr.io/vegaprotocol/frontend/${{ matrix.app }}:local

      - name: Sanity check docker image
        run: |
-          docker run --rm vegaprotocol/${{ matrix.app }}:local cat .env
-          docker run --rm vegaprotocol/${{ matrix.app }}:local ls -lah
+          echo "Check .env file"
+          docker run --rm ghcr.io/vegaprotocol/frontend/${{ matrix.app }}:local cat .env
+          echo "Check ipfs-hash"
+          docker run --rm ghcr.io/vegaprotocol/frontend/${{ matrix.app }}:local cat ipfs-hash
+          echo "List html directory"
+          docker run --rm ghcr.io/vegaprotocol/frontend/${{ matrix.app }}:local ls -lah

-      - name: Build and push to DockerHub
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
        id: docker_build
        uses: docker/build-push-action@v3
        with:
          context: .
-          push: ${{ inputs.publish || startsWith(github.ref, 'refs/tags/') }}
-          file: dockerfiles/${{ matrix.app =='trading' && 'Dockerfile.next' || 'Dockerfile.cra' }}.dist
-          build-args: APP=${{ matrix.app }}
-          platforms: ${{ inputs.archs || 'linux/amd64, linux/arm64' }}
+          push: true
+          file: dockerfiles/Dockerfile
+          build-args: |
+            APP=${{ matrix.app }}
+            NODE_VERSION=${{ steps.tags.outputs.npmVersion }}
          tags: |
-            vegaprotocol/${{ matrix.app }}:latest
-            vegaprotocol/${{ matrix.app }}:${{ steps.tags.outputs.version }}
+            ghcr.io/vegaprotocol/frontend/${{ matrix.app }}:latest
+            ghcr.io/vegaprotocol/frontend/${{ matrix.app }}:${{ steps.tags.outputs.version }}

      - name: Image digest
        run: echo ${{ steps.docker_build.outputs.digest }}
--- a/dockerfiles/Dockerfile
+++ b/dockerfiles/Dockerfile
@ -0,0 +1,31 @@
+# Build container
+ARG NODE_VERSION
+FROM --platform=amd64 node:${NODE_VERSION}-alpine3.16 as build
+WORKDIR /app
+# Argument to allow building of different apps
+ARG APP
+ENV PATH /app/node_modules/.bin:$PATH
+COPY package.json ./
+COPY yarn.lock ./
+COPY . ./
+RUN apk add python3 make gcc g++
+RUN yarn --network-timeout 100000 --pure-lockfile
+RUN yarn nx build ${APP} --network-timeout 100000 --pure-lockfile
+
+# Server environment
+# if this fails you need to docker pull nginx:1.23-alpine and pin new SHA
+# this is to ensure that we run always same version of alpine to make sure ipfs is indempotent
+FROM --platform=amd64 nginx:1.23-alpine@sha256:6318314189b40e73145a48060bff4783a116c34cc7241532d0d94198fb2c9629
+ARG APP
+# configuration of system
+RUN apk add --no-cache bash go-ipfs
+EXPOSE 80
+COPY entrypoint.sh /entrypoint.sh
+CMD ["/entrypoint.sh"]
+
+# Copy dist
+WORKDIR /usr/share/nginx/html
+COPY --from=build /app/dist/apps/${APP} /usr/share/nginx/html
+COPY nginx/nginx.conf /etc/nginx/conf.d/default.conf
+COPY ./apps/${APP}/.env .env
+RUN ipfs init && echo "$(ipfs add -rQ .)" > ipfs-hash
--- a/dockerfiles/Dockerfile.cra
+++ b/dockerfiles/Dockerfile.cra
@ -1,30 +0,0 @@
-# Build container
-FROM node:16.14.0-alpine as build
-WORKDIR /app
-# Argument to allow building of different apps
-ARG APP
-ENV PATH /app/node_modules/.bin:$PATH
-COPY package.json ./
-COPY yarn.lock ./
-COPY . ./
-RUN apk add python3 make gcc g++
-RUN yarn --network-timeout 100000 --verbose --pure-lockfile
-RUN yarn nx build $APP --network-timeout 100000 --verbose --pure-lockfile
-
-# Production environment
-FROM nginx:stable-alpine
-ARG APP
-COPY --from=build /app/dist/apps/$APP /usr/share/nginx/html
-COPY nginx/nginx.conf /etc/nginx/conf.d/default.conf
-
-EXPOSE 80
-
-WORKDIR /usr/share/nginx/html
-COPY ./env.sh .
-COPY ./apps/$APP/.env .env
-
-# Add bash
-RUN apk add --no-cache bash
-
-RUN chmod +x ./env.sh
-CMD ["/bin/bash", "-c", "/usr/share/nginx/html/env.sh && nginx -g \"daemon off;\""]
--- a/dockerfiles/Dockerfile.cra.dist
+++ b/dockerfiles/Dockerfile.cra.dist
@ -1,17 +0,0 @@
-FROM nginx:stable-alpine
-ARG APP
-COPY dist/apps/$APP /usr/share/nginx/html
-COPY nginx/nginx.conf /etc/nginx/conf.d/default.conf
-
-EXPOSE 80
-
-WORKDIR /usr/share/nginx/html
-COPY ./env.sh .
-COPY ./apps/$APP/.env .env
-
-# Add bash
-RUN apk add --no-cache bash
-
-RUN chmod +x ./env.sh
-CMD ["/bin/sh", "-c", "/usr/share/nginx/html/env.sh && nginx -g \"daemon off;\""]
-
--- a/dockerfiles/Dockerfile.next
+++ b/dockerfiles/Dockerfile.next
@ -1,30 +0,0 @@
-# Build container
-FROM node:16.14.0-alpine as build
-WORKDIR /app
-# Argument to allow building of different apps
-ARG APP
-ENV PATH /app/node_modules/.bin:$PATH
-COPY package.json ./
-COPY yarn.lock ./
-COPY . ./
-RUN apk add python3 make gcc g++
-RUN yarn --network-timeout 100000 --verbose --pure-lockfile
-RUN yarn nx export $APP --network-timeout 100000 --verbose --pure-lockfile
-
-# Production environment
-FROM nginx:stable-alpine
-ARG APP
-COPY --from=build /app/dist/apps/$APP/exported /usr/share/nginx/html
-COPY nginx/nginx.conf /etc/nginx/conf.d/default.conf
-
-EXPOSE 80
-
-WORKDIR /usr/share/nginx/html
-COPY ./env.sh .
-COPY ./apps/$APP/.env .env
-
-# Add bash
-RUN apk add --no-cache bash
-
-RUN chmod +x ./env.sh
-CMD ["/bin/bash", "-c", "/usr/share/nginx/html/env.sh && nginx -g \"daemon off;\""]
--- a/dockerfiles/Dockerfile.next.dist
+++ b/dockerfiles/Dockerfile.next.dist
@ -1,16 +0,0 @@
-FROM nginx:stable-alpine
-ARG APP
-COPY dist/apps/$APP/exported /usr/share/nginx/html
-COPY nginx/nginx.conf /etc/nginx/conf.d/default.conf
-
-EXPOSE 80
-
-WORKDIR /usr/share/nginx/html
-COPY ./env.sh .
-COPY ./apps/$APP/.env .env
-
-# Add bash
-RUN apk add --no-cache bash
-
-RUN chmod +x ./env.sh
-CMD ["/bin/bash", "-c", "/usr/share/nginx/html/env.sh && nginx -g \"daemon off;\""]
--- a/entrypoint.sh
+++ b/entrypoint.sh
@ -1,12 +1,14 @@
 #!/bin/bash
+set -e

 # Recreate config file
-mkdir assets
-rm -rf ./assets/env-config.js
-touch ./assets/env-config.js
+env_file=/usr/share/nginx/html/assets/env-config.js
+mkdir -p $(dirname $env_file)
+rm -rf $env_file || echo "no file to delete"
+touch $env_file

 # Add assignment
-echo "window._env_ = {" >> ./assets/env-config.js
+echo "window._env_ = {" >> $env_file

 # Read each line in .env file
 # Each line represents key=value pairs
@ -25,8 +27,11 @@ do

  # Append configuration property to JS file if non-empty
  if [ ! -z "$varname" ]; then
-    echo "  $varname: \"$value\"," >> ./assets/env-config.js
+    echo "  $varname: \"$value\"," >> $env_file
  fi
-done < .env
+done < /usr/share/nginx/html/.env

-echo "}" >> ./assets/env-config.js
+echo "}" >> $env_file
+
+# start serving
+nginx -g 'daemon off;'