feat: publish releases to DockerHub

Author: recurser

.env.example

@@ -1,3 +1,5 @@
+DOCKER_HUB_ACCESS_TOKEN="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+DOCKER_HUB_USERNAME=daveperrett
 GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 NEXT_PUBLIC_ANALYTICS_DOMAIN=string.test
 NEXT_PUBLIC_ANALYTICS_ENABLED=false

.github/workflows/dockerhub.yml

@@ -0,0 +1,33 @@
+name: Publish to Docker Hub
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  publish_to_dockerhub:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Get the version
+        run:  echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          builder:    ${{ steps.buildx.outputs.name }}
+          cache-from: type=registry,ref=${{ secrets.DOCKER_HUB_USERNAME }}/string-is:buildcache
+          cache-to:   type=registry,ref=${{ secrets.DOCKER_HUB_USERNAME }}/string-is:buildcache,mode=max
+          context:    ./
+          file:       ./Dockerfile
+          platforms:  linux/arm64, linux/amd64
+          push:       true
+          tags:       ${{ secrets.DOCKER_HUB_USERNAME }}/string-is:latest, ${{ secrets.DOCKER_HUB_USERNAME }}/string-is:${{ env.RELEASE_VERSION }}

Dockerfile

@@ -1,14 +1,14 @@
-
 # Install dependencies only when needed
-FROM node:17-alpine AS deps
+FROM --platform=$BUILDPLATFORM node:17-alpine AS deps
+
 # Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk add --no-cache libc6-compat
 WORKDIR /app
 COPY package.json yarn.lock ./
 RUN yarn install --frozen-lockfile
 
 # Rebuild the source code only when needed
-FROM node:17-alpine AS builder
+FROM --platform=$BUILDPLATFORM node:17-alpine AS builder
 WORKDIR /app
 COPY --from=deps /app/node_modules ./node_modules
 COPY . .
@@ -17,7 +17,7 @@ ENV NEXT_TELEMETRY_DISABLED 1
 RUN yarn build
 
 # Production image, copy all the files and run next
-FROM node:17-alpine AS runner
+FROM --platform=$BUILDPLATFORM node:17-alpine AS runner
 WORKDIR /app
 
 ENV NODE_ENV production

README.md

@@ -46,24 +46,45 @@ yarn all
 
 ## Running with Docker
 
-Build the docker image (shortcut for `docker build -t string-is .`):
+Build the docker image:
 
 ```bash
 yarn docker-build
 ```
 
-... and then run it (shortcut for `docker run -p 3000:3000 string-is`):
+or
+
+```bash
+docker build -t string-is .
+```
+
+... and then run it:
 
 ```bash
 yarn docker-run
 ```
 
+or
+
+```bash
+docker run -p 3000:3000 string-is
+```
+
 Alternatively you can build and run it with `docker-compose`:
 
 ```bash
 docker-compose up
 ```
 
+... or even run it directly from [Docker Hub](https://hub.docker.com/repository/docker/daveperrett/string-is/tags?page=1&ordering=last_updated):
+
+```bash
+docker run -p 4000:3000 daveperrett/string-is:latest
+````
+
+Currently `linux/arm64` and `linux/amd64` platforms are supported.
+
+
 ## Adding a new converter
 
 The `src/lib` folder contains most of the conversion logic, and is pure TypeScript, with no React knowledge required.

package.json

@@ -6,7 +6,7 @@
     "all": "yarn eslint pages src --fix && yarn prettier && yarn jest && yarn build",
     "build": "next build",
     "dev": "next dev",
-    "docker-build": "docker build -t string-is .",
+    "docker-build": "docker build --platform linux/arm64 -t string-is .",
     "docker-run": "docker run -p 3000:3000 string-is",
     "eslint": "eslint --ext=js,ts,tsx",
     "format": "yarn eslint src pages --fix && yarn prettier",