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,34 @@ 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: Use Node.js 
+    - uses: actions/setup-node@v4
       with:
-        config_file: ${{ inputs.CONFIG_FILE }}
-        fail_level: ${{ inputs.FAIL_LEVEL }}
-        filter_mode: ${{ inputs.FILTER_MODE }}
+        node-version: 20
+
+    # 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/[email protected]
+    
+    # Run linkspector and fail if there are broken links
+    - name: Run linkspector
+      shell: bash    
+      run: |
+        set -eo pipefail
+        linkspector --version
+        echo "🔍 Checking for broken links..."
+        linkspector check -c ${{ inputs.CONFIG_FILE }}
+        

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

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+/**
+ * Wrapper for @umbrelladocs/linkspector
+ * Fixes CommonJS import of @umbrelladocs/rdformat-validator for Node 20+.
+ * Works when dependencies are installed in the caller repository.
+ */
+
+import { fileURLToPath } from "url";
+import { dirname, resolve } from "path";
+import { createRequire } from "module";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+async function importValidator() {
+  try {
+    // Try local import first
+    return await import("@umbrelladocs/rdformat-validator");
+  } catch {
+    console.warn("⚠️ validator not found locally; resolving from caller repo...");
+    try {
+      // Dynamically resolve from the parent repository
+      const require = createRequire(import.meta.url);
+      const path = require.resolve("@umbrelladocs/rdformat-validator", {
+        paths: [resolve(process.cwd(), "node_modules")],
+      });
+      return await import(`file://${path}`);
+    } catch (err) {
+      console.error("❌ Could not resolve @umbrelladocs/rdformat-validator", err);
+      process.exit(1);
+    }
+  }
+}
+
+async function main() {
+  // Import linkspector CLI
+  let linkspector;
+  try {
+    linkspector = await import("@umbrelladocs/linkspector/lib/cli.js");
+  } catch (err) {
+    console.error("❌ Could not import @umbrelladocs/linkspector CLI:", err);
+    process.exit(1);
+  }
+
+  // Import validator safely
+  const validatorPkg = await importValidator();
+  const { validateAndFix } = validatorPkg;
+  globalThis.validateAndFix = validateAndFix;
+
+  // Run linkspector’s CLI
+  const cli = linkspector.default || linkspector.run;
+  if (typeof cli === "function") {
+    await cli();
+  } else {
+    console.error("⚠️ No valid entry point found in linkspector.");
+    process.exit(1);
+  }
+}
+
+main().catch((err) => {
+  console.error("❌ linkspector wrapper failed:", err);
+  process.exit(1);
+});