Merge pull request #1 from eins78/first-release

First release

Author: eins78

.dockerignore

@@ -1,6 +1,6 @@
 .git
 /node_modules/
 .env
-
+README.md
 Dockerfile
 .dockerignore

.env-default

@@ -1,2 +1,2 @@
 PORT=4444
-TITLE=Hello World!
+APP_TITLE=Hello World!

.github/workflows/docker-image-publish.yml

@@ -1,21 +1,49 @@
 name: Docker Image Publish
 
 on:
+  schedule:
+    - cron: "0 10 * * *"
   push:
+    branches:
+      - "**"
+    tags:
+      - "v*.*.*"
+  pull_request:
     branches:
       - "main"
 
 jobs:
   Deploy:
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            ghcr.io/${{ github.repository }}
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
       - name: set up QEMU
         uses: docker/setup-qemu-action@v2
 
       - name: set up Docker buildx
         uses: docker/setup-buildx-action@v2
 
       - name: login to GitHub Container Registry
+        if: github.event_name != 'pull_request'
         uses: docker/login-action@v1
         with:
           registry: ghcr.io
@@ -25,7 +53,7 @@ jobs:
       - name: build and push docker image
         uses: docker/build-push-action@v3
         with:
-          push: true
-          tags: |
-            ghcr.io/${{ github.repository }}:git-commit-${{ github.sha }}
-            ghcr.io/${{ github.repository }}:latest
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -1,5 +1,4 @@
 ARG BASEIMAGE="node:18-alpine"
-
 FROM $BASEIMAGE as prod
 
 WORKDIR /app
@@ -27,5 +26,7 @@ EXPOSE 7777
 
 HEALTHCHECK CMD node --experimental-fetch --no-warnings bin/healthcheck.mjs || exit 1
 
+ENV APP_TITLE="Hello Dockerfile!"
+
 # start app
 CMD npm start

README.md

@@ -19,11 +19,13 @@ npm start
 ## Run with `docker`
 
 ```bash
-IMG=hello-world-web
-PORT=8080
-docker build -t $IMG .
+IMG=ghcr.io/eins78/hello-world-web
+export PORT=8080
+export "APP_TITLE=Hello ${USER}@$(hostname -s)"!
+# downloads image from Github Container registry. to build from source:
+# docker build -t $IMG .
 # or: docker buildx build --load -t $IMG .
-docker run --rm -it -e 'TITLE=Hello Docker!' -e PORT -p $PORT:$PORT $IMG
+docker run --rm -it -e APP_TITLE -e PORT -p $PORT:$PORT $IMG
 ```
 
 ## Run with `docker-compose`
@@ -53,13 +55,17 @@ This table also show the order of precendence (last wins, if applicable).
 
 ### Healthcheck
 
+There is a healthcheck script that checks if the homepage is served with a non-error status.
+Note that the query parameter `?healthcheck` is used, but not handled specifically by the server,
+it just help to identifiy the healthcheck requests in logs.
+
 * `GET https://localhost:${PORT}/?healthcheck`
 * Node.js script: `bin/healthcheck.mjs`
 * with `docker` and `docker-compose`, see
 
     ```sh
-    container=hello-world-web-webserver-1
-    docker inspect $container | jq '.[0].State.Health'
+    ctr=hello-world-web-webserver-1
+    docker inspect $ctr | jq '.[0].State.Health'
     ```
 
 ## Development

VERSION.env

@@ -1,2 +1,2 @@
 VERSION=1.0.0
-PRE_RELEASE=alpha.1
+PRE_RELEASE=

bin/healthcheck.mjs

@@ -3,14 +3,14 @@
 const URL = process.env.HEALTHCHECK_URL || `http://localhost:${process.env.PORT || 9999}/\?healthcheck`;
 
 function fail(error) {
-  console.log(`FAIL: ${URL}\n${[error.message, error.cause].filter(Boolean).join("\n")}`);
+  console.log(`FAIL: ${[URL, error.message, error.cause].filter((i) => i).join("\n")}`);
   process.exit(1);
 }
 
 process.on("uncaughtException", fail);
 process.on("unhandledRejection", fail);
 
 const response = await fetch(URL);
-if (!response.ok) fail(await response.text());
+if (!response.ok) fail({ message: `HTTP status ${response.status}`, cause: await response.text() });
 
 console.log(`OK: ${URL}`);

docker-compose.yaml

@@ -15,4 +15,4 @@ services:
       retries: 3
     environment:
       - "PORT=${PORT}"
-      - "TITLE=Hello docker-compose!"
+      - "APP_TITLE=Hello docker-compose!"

public/stylesheets/style.css

@@ -17,13 +17,13 @@ body {
 
 /* dark mode */
 body {
-  background-color: rgba(0, 0, 0, 0.92);
-  color: rgba(255, 255, 255, 0.86);
+  background-color: #141414;
+  color: #8fc2c7;
 }
 @media screen and (prefers-color-scheme: light) {
   body {
-    background-color: rgba(255, 255, 255, 0.9);
-    color: rgba(0, 0, 0, 0.95);
+    background-color: #a1e5e8;
+    color: #0a0c0c;
   }
 }
 

routes/home.js

@@ -3,7 +3,7 @@ const router = express.Router();
 const htmlTemplate = require("../views/html");
 const homeTemplate = require("../views/home");
 const config = require("../config");
-const title = process.env.TITLE ?? "!!! MISSING $TITLE !!!";
+const title = process.env.APP_TITLE ?? "Hello World!";
 
 /* GET home page. */
 router.get("/", function (req, res, next) {