Merge pull request #43 from DeterminateSystems/link-check-readme

Provide external link checking for README
DeterminateSystems · Nov 4, 2024 · 61819e4 · 61819e4
2 parents afd03f6 + 1732b48
commit 61819e4
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/.envrc b/.envrc
@@ -0,0 +1 @@
+use flake
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,6 +15,18 @@ on:
       - labeled
 
 jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: DeterminateSystems/nix-installer-action@main
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+
+      - name: Check external links
+        run: |
+          nix develop --command \
+            lychee README.md
+
   test-modules:
     strategy:
       matrix:

diff --git a/flake.nix b/flake.nix
@@ -116,8 +116,13 @@
           default = pkgs.mkShell {
             name = "determinate-dev";
 
-            buildInputs = with pkgs; [
+            packages = with pkgs; [
+              lychee
               nixpkgs-fmt
+
+              (writeScriptBin "check-readme-links" ''
+                lychee README.md
+              '')
             ];
           };
         });