Merge pull request #94

Author: KristjanESPERANTO

.dockerignore

@@ -1,5 +1,6 @@
 /.husky/*
 /.github/*
-/docs/data/*
-/docs/images/*
+/website/data/*
+/website/images/*
 /guides/*
+*.md

.github/workflows/container-build.yaml

@@ -4,6 +4,9 @@ on:
   workflow_dispatch: # needed for manually running this workflow
   schedule:
     - cron: "15 3 * * *" # sadly there is no TZ support here
+  push:
+    branches:
+      - "*"
 
 permissions:
   contents: read
@@ -21,15 +24,22 @@ jobs:
         uses: actions/checkout@v5
       - name: Build container
         run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            # ugly workaround for converting content of $GITHUB_REPOSITORY (= `MagicMirrorOrg/MagicMirror-3rd-Party-Modules`)
+            REPO="$(echo $GITHUB_REPOSITORY | tr '[:upper:]' '[:lower:]')"
+            # regular build
+            PARAMS="--output type=image,\"name=ghcr.io/${REPO}:${{ github.ref_name }}\",push=true"
+          else
+            # only build with small wiki list and no image push
+            PARAMS="--output type=image,push=false --opt build-arg:WIKI_FILE=website/test/3rd-Party-Modules.md"
+          fi
           # registry credentials
           export DOCKER_CONFIG="$(pwd)/container"
           echo "{\"auths\":{\"ghcr.io\":{\"auth\":\"$(echo -n ${{ github.actor }}:${{ secrets.GITHUB_TOKEN }} | base64 -w 0)\"}}}" > $DOCKER_CONFIG/config.json
-          # ugly workaround for converting content of $GITHUB_REPOSITORY (= `MagicMirrorOrg/MagicMirror-3rd-Party-Modules`)
-          REPO="$(echo $GITHUB_REPOSITORY | tr '[:upper:]' '[:lower:]')"
           # build
           buildctl-daemonless.sh build \
             --progress plain \
             --frontend=dockerfile.v0 \
             --local context=. \
             --local dockerfile=container \
-            --output type=image,"\"name=ghcr.io/${REPO}:${{ github.ref_name }}\",push=true"
+            $PARAMS

.prettierignore

@@ -1,6 +1,6 @@
 *.js
-docs/data/*.json
-docs/fonts/
+website/data/*.json
+website/fonts/
 modules/
 result.md
 modules_temp/

README.md

@@ -4,7 +4,7 @@ WORKDIR /workspace
 
 COPY . .
 
-ARG GITHUB_TOKEN
+ARG GITHUB_TOKEN WIKI_FILE
 RUN <<EOF
 set -e
 git config --global --add safe.directory /workspace
@@ -21,6 +21,6 @@ LABEL maintainer="MagicMirrorOrg"
 COPY container/default.conf /etc/nginx/conf.d/
 COPY container/nginx.conf /etc/nginx/
 
-COPY --from=builder /workspace/docs /usr/share/nginx/docs/
+COPY --from=builder /workspace/website /usr/share/nginx/website/
 
 EXPOSE 8080

container/Dockerfile

@@ -5,17 +5,17 @@ server {
     access_log  /var/log/nginx/access.log  main;
 
     location / {
-        root   /usr/share/nginx/docs;
+        root   /usr/share/nginx/website;
         index  index.html index.htm;
         # Do not cache HTML to allow quick refresh of UI changes
         add_header Cache-Control "no-cache, no-store, must-revalidate";
         add_header Pragma "no-cache";
         add_header Expires "0";
     }
 
-    # Cache-bust static assets aggressively; paths are stable under docs/
+    # Cache-bust static assets aggressively; paths are stable under website/
     location ~* \.(?:css|js|svg|woff2?|ttf|eot|ico|png|jpg|jpeg|gif|webp)$ {
-        root   /usr/share/nginx/docs;
+        root   /usr/share/nginx/website;
         access_log off;
         expires 30d;
         add_header Cache-Control "public, max-age=2592000, immutable";

container/default.conf

@@ -39,7 +39,7 @@ function createModuleList () {
   };
 
   fs.writeFileSync(
-    "./docs/data/modules.stage.1.json",
+    "./website/data/modules.stage.1.json",
     JSON.stringify(data, null, 2),
     "utf8"
   );

create_own_module_list.js

@@ -33,7 +33,7 @@
     "node_modules/",
     "modules/",
     "modules_temp/",
-    "docs/**",
+    "website/**",
     "eslint-config-DEBUG.json",
     "container/"
   ],

cspell.config.json

@@ -13,10 +13,10 @@ export default defineConfig([
     ignores: [
       "modules/*",
       "modules_temp/*",
-      "docs/data/modules*.json",
-      "docs/fonts/*",
-      "docs/result.html",
-      "docs/result.md"
+      "website/data/modules*.json",
+      "website/fonts/*",
+      "website/result.html",
+      "website/result.md"
     ]
   },
   {

eslint.config.js

@@ -273,7 +273,7 @@ def check_modules():
     }
 
     modules_json_file = open(
-        "./docs/data/modules.stage.5.json", encoding="utf-8")
+        "./website/data/modules.stage.5.json", encoding="utf-8")
     modules = json.load(modules_json_file)
     stats = {
         "moduleCounter": 0,
@@ -566,29 +566,29 @@ def check_modules():
     )
 
     # Writing to markdown
-    with open("./docs/result.md", "w", encoding="utf-8") as output_file:
+    with open("./website/result.md", "w", encoding="utf-8") as output_file:
         output_file.write(markdown_output)
 
     # Serializing json
     json_object = json.dumps(modules, indent=2)
 
     # Writing to modules.json
-    with open("./docs/data/modules.json", "w", encoding="utf-8") as outfile:
+    with open("./website/data/modules.json", "w", encoding="utf-8") as outfile:
         outfile.write(json_object)
 
     # Serializing and minifying json
     json_object = json.dumps(modules)
 
     # Writing to modules.min.json
-    with open("./docs/data/modules.min.json", "w", encoding="utf-8") as outfile:
+    with open("./website/data/modules.min.json", "w", encoding="utf-8") as outfile:
         outfile.write(json_object)
 
     # Statistics
     # Serializing json
     statistics_json_object = json.dumps(stats, indent=2)
 
     # Writing to stats.json
-    with open("./docs/data/stats.json", "w", encoding="utf-8") as outfile:
+    with open("./website/data/stats.json", "w", encoding="utf-8") as outfile:
         outfile.write(statistics_json_object)