From f361b3a87f4eade41c895837c216047e16c7a0d3 Mon Sep 17 00:00:00 2001
From: undergoundwires <git@undergroundwires.dev>
Date: Sun, 26 Jan 2025 15:09:47 +0100
Subject: [PATCH] Add external URL health checks in CI/CD

This commit adds automated checks for dead external URLs in the
documentation during CI/CD pipeline. It configures
`remark-lint-no-dead-urls` plugin with custom ignore patterns to handle
false positives.
This commit adds URL aliveness checks in CI/CD that was previously
missing, adding ignore rules for false negatives.

Changes:

- Add missing external URL checking in GitHub workflow.
- Add ignore patterns for false negatives.
- Remove fail fast feature from quality checks to receive results from
  all commands.
---
 .github/workflows/quality-checks.yaml |  2 ++
 .remark-lint-no-dead-urls.mjs         | 19 +++++++++++++++++++
 README.md                             |  2 +-
 package.json                          |  2 +-
 4 files changed, 23 insertions(+), 2 deletions(-)
 create mode 100644 .remark-lint-no-dead-urls.mjs

diff --git a/.github/workflows/quality-checks.yaml b/.github/workflows/quality-checks.yaml
index d65862a..ccb3b2e 100644
--- a/.github/workflows/quality-checks.yaml
+++ b/.github/workflows/quality-checks.yaml
@@ -11,7 +11,9 @@ jobs:
           - lint:css
           - lint:md
           - lint:md:urls:relative
+          - lint:md:urls:external
           - lint:md:consistency
+      fail-fast: false # Still interested to see results from other commands
     steps:
       - name: Checkout
         uses: actions/checkout@v4
diff --git a/.remark-lint-no-dead-urls.mjs b/.remark-lint-no-dead-urls.mjs
new file mode 100644
index 0000000..c8764cc
--- /dev/null
+++ b/.remark-lint-no-dead-urls.mjs
@@ -0,0 +1,19 @@
+import remarkLintNoDeadUrls from 'remark-lint-no-dead-urls';
+
+/** @type {import('remark-lint-no-dead-urls').Options} */
+const Options = {
+  skipUrlPatterns: [
+    // These return 403 (Forbidden) to checks
+    'codepen.io', // 'https://codepen.io'
+  ].map(buildUrlPattern),
+};
+
+/** @type {Omit<import('unified-engine').Preset} */
+export default {
+  plugins: [[remarkLintNoDeadUrls, Options]],
+};
+
+function buildUrlPattern(fqdn) {
+  const escaped = fqdn.replace(/\./g, '\\.');
+  return `^https://${escaped}/.*$`;
+}
diff --git a/README.md b/README.md
index 6e66e77..b490317 100644
--- a/README.md
+++ b/README.md
@@ -199,7 +199,7 @@ You can choose one of the following existing themes to begin:
 
 ##### Custom Themes
 
-Or you can create your own theme & import it. Check example themes at [existing themes](./src/themes/). [The HTML](./src/ez-consent.js#L18) uses only a few classes using [BEM](http://getbem.com/naming/) naming convention.
+Or you can create your own theme & import it. Check example themes at [existing themes](./src/themes/). [The HTML](./src/ez-consent.js#L18) uses only a few classes using [BEM](https://getbem.com/naming/) naming convention.
 
 You can also add your own class names using `css_classes` option, see [initialization](#2-initialize) for details.
 
diff --git a/package.json b/package.json
index 0f2e9b9..9e92c3f 100644
--- a/package.json
+++ b/package.json
@@ -11,7 +11,7 @@
     "lint:css": "stylelint \"**/*.css\"",
     "lint:md": "markdownlint **/*.md --ignore node_modules",
     "lint:md:urls:relative": "remark . --frail --use remark-validate-links",
-    "lint:md:urls:external": "remark . --frail --use remark-lint-no-dead-urls",
+    "lint:md:urls:external": "remark . --frail --rc-path .remark-lint-no-dead-urls.mjs",
     "lint:md:consistency": "remark . --frail --use remark-preset-lint-consistent"
   },
   "repository": {