automate link checking with lychee

ethereum-optimism · Jan 10, 2022 · a898f87 · a898f87
1 parent c6596da
commit a898f87
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -38,3 +38,13 @@ jobs:
 
       - name: Lint
         run: yarn lint:check
+
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@v1.2.0
+        with:
+          fail: true
diff --git a/package.json b/package.json
@@ -9,8 +9,10 @@
     "markdownlint-cli2": "^0.3.2"
   },
   "scripts": {
+    "setup": "yarn install && cargo install lychee",
     "lint": "yarn lint:fix && yarn lint:check",
     "lint:fix": "markdownlint-cli2-fix \"./specs/**/*.md\" \"#node_modules\"",
-    "lint:check": "markdownlint-cli2 \"./specs/**/*.md\" \"#node_modules\""
+    "lint:check": "markdownlint-cli2 \"./specs/**/*.md\" \"#node_modules\"",
+    "lint:links": "lychee \"./specs/**/*.md\" --base ."
   }
 }