Merge pull request #49 from sugarlabs/18-docker-improve

(18) Update Docker image and GitHub container registry

Author: meganindya

.github/linters/.eslintrc.json

@@ -50,6 +50,10 @@ jobs:
         uses: github/super-linter@v3
         env:
           DEFAULT_BRANCH: main
+          LINTER_RULES_PATH: /
+          JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.json
+          TYPESCRIPT_ES_CONFIG_FILE: .eslintrc.json
+          MARKDOWN_CONFIG_FILE: .markdownlint.jsonc
           VALIDATE_ALL_CODEBASE: false
           VALIDATE_CSS: false
           VALIDATE_DOCKERFILE: false

.github/linters/.markdownlint.jsonc

@@ -1,26 +1,25 @@
-FROM debian:buster-slim
+# base from official Node (Alpine LTS) image
+FROM node:lts-alpine
 
-# install node.js:14.x
-RUN apt update --no-install-recommends -yq \
-    && apt-get install curl gnupg -yq \
-    && curl -sL https://deb.nodesource.com/setup_14.x | bash \
-    && apt-get install nodejs -yq \
-    && apt-get clean -y \
-    && rm -rf /var/lib/apt/lists/*
-
-# update npm
-RUN npm install -g npm
+# install simple http server for serving static content
+RUN npm install -g http-server
 
 # install typescript compiler
 RUN npm install -g typescript
 
 # install ts-node (to run/debug .ts files without manual transpiling)
 RUN npm install -g ts-node
 
-LABEL org.opencontainers.image.description='An initial development image based on a slimmed Debian \
-10.7 (buster), and further configured with Node.js v14, TypeScript compiler, and ts-node. This \
-does not contain any source files.'
-
+# set /app as working directory (in development mode for mounting source code)
 WORKDIR /app
 
-EXPOSE 5000 9000
+# override default CMD for image ("node"): launch the shell
+CMD sh
+
+# Listen on ports
+EXPOSE 80 3000
+
+# Add label for GitHub container registry
+LABEL org.opencontainers.image.description='An initial development image based on the official \
+    Node.js (on Alpine LTS) image, and further configured with a HTTP server, TypeScript compiler, \
+    and ts-node. This is merely to provide an execution sandbox and does not contain source files.'

.github/workflows/linter.yml

@@ -47,13 +47,13 @@ Windows) this repository using
 4. Build _docker image_ and launch _docker network_.
 
     _**Note:**_ A
-    [built initial development image](https://github.com/orgs/sugarlabs/packages/container/musicblocks/531083)
+    [built initial development image](https://github.com/orgs/sugarlabs/packages/container/musicblocks/2948273?tag=4.0.0-dev)
     has been published to
     [_Sugar Labs GitHub Container Registry_ (_GHCR_)](https://github.com/orgs/sugarlabs/packages?ecosystem=container),
     which can be pulled directly, so you don't have to build it again. Pull using
 
     ```bash
-    docker pull ghcr.io/sugarlabs/musicblocks:initial
+    docker pull ghcr.io/sugarlabs/musicblocks:4.0.0-dev
     ```
 
     Nagivate inside the project directory and launch the _docker network_ using
@@ -76,27 +76,28 @@ Windows) this repository using
 5. In a second terminal, run
 
     ```bash
-    docker attach musicblocks
+    docker attach musicblocks-4.0.0-dev
     ```
 
-    The _Linux Debian 10.7_ (_buster_) _shell_ in the _docker container_ named _musicblocks_ is
-    spawned and standard input/output is connected to the terminal.
+    The _Alpine shell_ in the _docker container_ named _musicblocks-4.0.0-dev_ is spawned and
+    standard input/output is connected to the terminal.
 
 6. _**Node**_ (_Node.js Runtime_), _**npm**_ (_Node Package Manager_), _**tsc**_ (_TypeScript
-    Compiler_), and _**ts-node**_ (_Node executable for TypeScript_) should be installed. Check
-    using
+    Compiler_), _**ts-node**_ (_Node executable for TypeScript_), and _**http-server**_ (_a HTTP
+    server program_) should be installed. Check using
 
     ```bash
-    node --version && npm --version && tsc --version && ts-node --version
+    node -v && npm -v && tsc -v && ts-node -v && http-server -v
     ```
 
-    in the second terminal. Output should look like
+    Output should look like
 
     ```bash
-    v14.16.1
-    7.9.0
-    Version 4.2.4
-    v9.1.1
+    v14.17.0
+    6.14.13
+    Version 4.3.2
+    v10.0.0
+    v0.12.3
     ```
 
 The steps you take from here depend on what you want to do: