Merge pull request #14 from mwood77/chron-job-links

Add product link validation for BOM

.github/workflows/lint-markdown.yml

@@ -0,0 +1,18 @@
+name: Markdown Link Checker
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+
+    - uses: actions/checkout@v4
+
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-verbose-mode: 'yes'
+        config-file: '.github/workflows/markdown.links.config.json'
+        folder-path: 'docs/'

.github/workflows/markdown.links.config.json

@@ -0,0 +1,7 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^http://winderoo.local/"
+    }
+  ]
+}

.github/workflows/selenium-web.yml

@@ -0,0 +1,32 @@
+name: Aliexpress Product Checker
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: 0 9 * * 1 # 9AM every monday
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    container:
+      image: node:19
+
+    services:
+      selenium:
+        image: selenium/standalone-chrome
+        options: --shm-size=2gb
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 19
+
+      - uses: abhi1693/setup-browser@v0.3.4
+        with:
+          browser: firefox
+
+      - run: npm i selenium-webdriver
+      - run: npx node .github/workflows/test-ali-links.mjs

.github/workflows/test-ali-links.mjs

@@ -0,0 +1,43 @@
+import { readFile } from 'fs/promises';
+import { By, Builder } from 'selenium-webdriver';
+import firefox from 'selenium-webdriver/firefox.js'
+
+const links = [];
+let driver;
+
+const content = async(file) => {
+    return await readFile(file, 'utf8')
+}
+
+const search = async (item) => {
+    await driver.get('https://s.click.aliexpress.com/e/_' + item);
+    return await driver.findElements(By.className('not-found-page'))
+}
+
+content('./docs/bom-requirements.md')
+    .then(
+        result => {
+            const sanitizedMD = result.split('/_')
+            sanitizedMD.shift(); // remove stuff that doesn't include links
+            sanitizedMD.forEach((el) => {
+                links.push(el.split(')')[0])
+            })
+        }
+    )
+    .finally(
+        async () => {
+            driver = new Builder()
+                .forBrowser('firefox')
+                .setFirefoxOptions(new firefox.Options().headless())
+                .build();
+
+            // Test scraped aliexpress links from bom-doc
+            links.every(async el => {
+                const result = await search(el);
+
+                if (result.length > 0) {
+                    throw new Error(`product ${el} is a broken link`, content)
+                }
+            });
+        }
+    );

.gitignore

@@ -4,6 +4,8 @@
 .vscode/launch.json
 .vscode/ipch
 
+node_modules/
+
 src/platformio/osww-server/src/configurables.h
 
 # System files

README.md

@@ -43,6 +43,7 @@
 * [Click Here to see the user manual](./docs/user-manual.md)
 
 ## Prerequisites
+> [!IMPORTANT]
 > This project is an add-on to your already built [Open Source Watch Winder (OSWW)](https://github.com/mwood77/osww)
 
 #### Download and install the following on your computer:

docs/bom-requirements.md

@@ -2,8 +2,7 @@
 
 # Bill of Materials & Cost
 
-> ⚠️ IMPORTANT - READ THIS ⚠️
->
+> [!IMPORTANT]
 > This project is an add-on to your already built [Open Source Watch Winder (OSWW)](https://github.com/mwood77/osww). 
 
 - This microcontroller replaces the Pi Pico used in the OSWW.

docs/install-software.md

@@ -2,8 +2,7 @@
 
 # Software Installtion & Flashing your ESP32
 
-> ⚠️ IMPORTANT - READ THIS ⚠️
->
+> [!IMPORTANT]
 > This project is an add-on to your already built [Open Source Watch Winder (OSWW)](https://github.com/mwood77/osww). 
 
 - This project requires a microncontroller which replaces the Pi Pico used in the OSWW.
@@ -12,8 +11,9 @@
 
 # Getting Started
 
-### Have you completed the Prerequisites?
-- [Read them here](./prereqs.md)
+### Prerequisites
+- Download [Visual Studio Code (VSCode)](https://code.visualstudio.com/download)
+- Download [PlatformIO](https://platformio.org/install/ide?install=vscode)
 
 ## Flashing your microcontroller