CICD: Detect broken HTML links in the documentation as part of the pipeline (#3439)

.github/workflows/pr_check_git_status.yml

@@ -19,7 +19,7 @@ jobs:
         go-version: stable
     - run: go install golang.org/x/tools/cmd/stringer@latest
     - run: go fmt ./...
-    - run: bin/fmtjson $(find . -type f -name \*.json -print)
+    - run: bin/fmtjson $(find . -type f -name "*.json" ! -name "package-lock.json" -print)
     - run: go mod tidy
     - run: go generate ./...
     - uses: CatChen/check-git-status-action@v1

.gitignore

@@ -1,3 +1,4 @@
+/node_modules/
 /tmp
 /commands/types/dnscontrol.d.ts
 dnscontrol-Darwin
@@ -28,6 +29,7 @@ stack.sh
 types-dnscontrol.d.ts
 
 dist/
+node_modules/
 
 // Test artifact:
 *.ACTUAL

.linkspector.yml

@@ -0,0 +1,14 @@
+useGitIgnore: true
+dirs:
+  - documentation
+files:
+  - README.md
+  - SECURITY.md
+ignorePatterns:
+  - pattern: '.*?plain=1$'
+  - pattern: '.*.md#$'
+  - pattern: '^https://cloud.digitalocean.com/settings/applications'
+  - pattern: '^https://dns.hetzner.com/settings/api-token'
+  - pattern: '^https://github.com/StackExchange/dnscontrol/settings/.*$'
+  - pattern: '^https://gitlab.com/cafferata/dnscontrol/-/pipelines/new.*$'
+  - pattern: '^https://my.easyname.com/en/account/api'

.nvmrc

@@ -0,0 +1 @@
+lts/*

bin/generate-all.sh

@@ -7,7 +7,7 @@ if [[ -x node_modules/.bin/prettier ]]; then
 fi
 
 # JSON
-bin/fmtjson $(find . -type f -name \*.json -print)
+bin/fmtjson $(find . -type f -name "*.json" ! -name "package-lock.json" -print)
 
 # dnsconfig.js-compatible files:
 for i in pkg/js/parse_tests/*.js ; do dnscontrol fmt -i $i -o $i ; done

package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "@umbrelladocs/linkspector": "^0.3.13"
+  }
+}