umbrella (#87)

Author: joshuafernandes

README.md

@@ -2,3 +2,5 @@
 
 https://github.com/Consensys/github-actions acts as a single source of truth (sot) for actions that we use
 
+# TODO
+- Add lint checks on this repo

docs-link-check/action.yml

@@ -8,14 +8,6 @@ inputs:
     description: 'default config file.'
     required: false
     default: .github-actions/docs-link-check/config/.linkspector.yml
-  FAIL_LEVEL:
-    description: 'exit code for reviewdog when errors are found with severity greater than or equal to this level'
-    required: false
-    default: 'any'
-  FILTER_MODE:
-    description: 'filtering mode for reviewdog command'
-    required: false
-    default: 'nofilter'
 runs:
   using: "composite"
   steps:
@@ -25,11 +17,40 @@ runs:
         repository: Consensys/github-actions
         path: .github-actions
 
-    # also needs reviewdog/action-setup@v1
-    # reviewdog/action-setup@d8edfce3dd5e1ec6978745e801f9c50b5ef80252
-    - name: Test links
-      uses: umbrelladocs/action-linkspector@652f85bc57bb1e7d4327260decc10aa68f7694c3
+    - name: Read .nvmrc
+      shell: bash
+      run: echo "NODE_VERSION=$(cat .nvmrc)" >> $GITHUB_OUTPUT
+      id: nvm
+
+    - name: Use Node.js 
+      uses: actions/setup-node@v6
       with:
-        config_file: ${{ inputs.CONFIG_FILE }}
-        fail_level: ${{ inputs.FAIL_LEVEL }}
-        filter_mode: ${{ inputs.FILTER_MODE }}
+        registry-url: https://registry.npmjs.org/
+        node-version-file: '.nvmrc'
+
+    # Fix Chrome sandbox issues on Ubuntu 24.04
+    - name: Setup Chrome Linux Sandbox
+      shell: bash    
+      run: |
+        # Based on https://chromium.googlesource.com/chromium/src/+/main/docs/security/apparmor-userns-restrictions.md
+        if [ "$(lsb_release -rs)" = "24.04" ]; then
+          echo 0 | sudo tee /proc/sys/kernel/apparmor_restrict_unprivileged_userns
+          echo 'Done'
+        else
+          echo "Not running on Ubuntu 24.04 — skipping sandbox fix"
+        fi
+
+    - name: Install linkspector
+      shell: bash
+      run: |
+        npm install -g @umbrelladocs/linkspector @umbrelladocs/rdformat-validator
+        echo "linkspector version: $(node ${{ github.action_path }}/scripts/run-linkinspector.mjs --version)"
+    
+    # Run linkspector and fail if there are broken links
+    - name: Run linkspector
+      shell: bash    
+      run: |
+        set -eo pipefail
+        echo "🔍 Checking for broken links..."
+        node ${{ github.action_path }}/scripts/run-linkinspector.mjs check -c ${{ inputs.CONFIG_FILE }}
+        

docs-link-check/scripts/run-linkinspector.mjs

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+/**
+ * Wrapper for @umbrelladocs/linkspector that fixes CJS import of @umbrelladocs/rdformat-validator.
+ * Compatible with Node 18–24.
+ */
+
+import { fileURLToPath } from "url";
+import { dirname, resolve } from "path";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+// Dynamically import linkspector’s CLI entry point
+const linkspector = await import("@umbrelladocs/linkspector/lib/cli.js");
+
+// Safely import CommonJS validator
+import validatorPkg from "@umbrelladocs/rdformat-validator";
+const { validateAndFix } = validatorPkg;
+
+// Patch the global context so linkspector sees the right export
+globalThis.validateAndFix = validateAndFix;
+
+// Execute linkspector CLI
+if (typeof linkspector.default === "function") {
+  await linkspector.default();
+} else if (typeof linkspector.run === "function") {
+  await linkspector.run();
+} else {
+  console.error("⚠️ Could not find linkspector entry point.");
+  process.exit(1);
+}