use small wiki list for testing on other

Author: khassel

.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

container/Dockerfile

@@ -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

scripts/create_module_list.js

@@ -5,13 +5,18 @@ import sanitizeHtml from "sanitize-html";
 
 async function fetchMarkdownData () {
   try {
-    const url =
-      "https://raw.githubusercontent.com/wiki/MagicMirrorOrg/MagicMirror/3rd-Party-Modules.md";
-    const response = await fetch(url);
-    if (response.status !== 200) {
-      throw new Error(`The fetch() call failed. Status code: ${response.status}`);
+    let markdown = "";
+    if (process.env.WIKI_FILE) {
+      markdown = fs.readFileSync(`${process.env.WIKI_FILE}`, "utf8");
+    } else {
+      const url =
+        "https://raw.githubusercontent.com/wiki/MagicMirrorOrg/MagicMirror/3rd-Party-Modules.md";
+      const response = await fetch(url);
+      if (response.status !== 200) {
+        throw new Error(`The fetch() call failed. Status code: ${response.status}`);
+      }
+      markdown = await response.text();
     }
-    const markdown = await response.text();
     return markdown;
   } catch (error) {
     console.error(error);

website/test/3rd-Party-Modules.md

@@ -0,0 +1,53 @@
+- [Notes for Module Creators](#module-creators)
+- [Module List](#module-list) organized into categories
+  - [Development / Core MagicMirror²](#development--core-magicmirror)
+  - [Finance](#finance)
+  - [News / Information](#news--information)
+  - [Transport / Travel](#transport--travel)
+  - [Voice Control](#voice-control)
+  - [Weather](#weather)
+  - [Religion](#religion)
+  - [Sports](#sports)
+  - [Utility / IoT / 3rd Party / Integration](#utility--iot--3rd-party--integration)
+  - [Entertainment / Misc](#entertainment--misc)
+  - [Health](#health)
+  - [Education](#education)
+- [Outdated Modules](#outdated-modules)
+
+## Module Creators
+
+There is always a need for more modules. Check out the [forum](https://forum.magicmirror.builders/category/9/requests) to see what people are requesting.
+
+### Create your own module
+
+If you want to build your own modules, check out the [MagicMirror² Module Development Documentation](https://docs.magicmirror.builders/development/introduction.html).
+
+When you're done, just edit this page and add your module to the list!
+
+Don't forget to present your module in the [forum](https://forum.magicmirror.builders/category/5/modules).
+
+### General Advice
+
+We highly recommend you to include the following information in your README file:
+
+- A high quality screenshot of your working module.
+- A short, one sentence, clear description what it does.
+- What external APIs it depend on, including web links to those
+- Whether the API/request require a key and the user limitations of those. (Is it free?)
+- What is the current development status (WIP, searching for new maintainer or abandoned).
+
+## Module List
+
+The following modules are maintained by their respective authors. If you have a GitHub account, don't forget [to star ⭐](https://docs.github.com/en/get-started/exploring-projects-on-github/saving-repositories-with-stars#starring-a-repository) the modules you like!
+
+[Here](https://modules.magicmirror.builders/) you can find another list based on this official list, but supplemented with screenshots and a search function.
+
+### Development / Core MagicMirror²
+
+|Title |Author |Description |
+|:-|:-:|:-|
+|[mmpm](https://github.com/Bee-Mar/mmpm) |[Bee-Mar](https://github.com/Bee-Mar) |An unofficial MagicMirror² 3rd Party Package Manager. Automates searching, installation, removal, updating, and upgrading of MagicMirror² modules. |
+|[MMM-Template](https://github.com/Dennis-Rosenbaum/MMM-Template) |Dennis-Rosenbaum |A template for creating new MagicMirror² modules. |
+|[MMM-AlertExt](https://github.com/MMRIZE/MMM-AlertExt) |MMRIZE |Alternative programmable alert/notification presenter. |
+|[MMM-AutoDimmer](https://github.com/Fifteen15Studios/MMM-AutoDimmer) |[Fifteen15Studios](https://github.com/Fifteen15Studios) |Set 1 or more schedules to dim and brighten your screen at specific times. |
+|[MMM-Bash](https://github.com/mathew-fleisch/MMM-Bash) |draxiom |A simple module to run a bash/terminal command on a loop, displaying stdout/stderr to screen. |