Merge pull request #305 from DeterminateSystems/link-checker-pt2

Add external link checking

.github/workflows/test.yml

@@ -10,16 +10,35 @@ jobs:
   test:
     environment: test
     runs-on: ubuntu-22.04
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - name: git checkout
         uses: actions/checkout@v3
       - name: Check Nixpkgs input
         uses: DeterminateSystems/flake-checker-action@main
         with:
           fail-mode: true
+      - name: Restore Lychee cache
+        uses: actions/cache@v3
+        with:
+          path: .lycheecache
+          key: lychee-link-check
+          restore-keys: cache-lychee-
       - uses: DeterminateSystems/nix-installer-action@main
       - uses: DeterminateSystems/magic-nix-cache-action@main
       - name: Run Nix CI suite
         run: nix develop --command ci
+      - name: Check external links
+        uses: lycheeverse/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          args: >-
+            --cache
+            --verbose
+            --no-progress
+            ./dist
+          fail: true
       - name: Check flake templates
         run: ./scripts/check-flake-templates.sh

.gitignore

@@ -10,6 +10,9 @@ result
 # htmltest artifacts
 /tmp/
 
+# Lychee cache
+.lycheecache
+
 # îles artifacts
 /.iles-ssg-temp/
 /dist/

components.d.ts

@@ -43,7 +43,7 @@ declare module '@vue/runtime-core' {
     IconFaSolidMoon: typeof import('~icons/fa-solid/moon')['default']
     IconFaSolidSun: typeof import('~icons/fa-solid/sun')['default']
     IconFaWarning: typeof import('~icons/fa/warning')['default']
-    Island: typeof import('./node_modules/.pnpm/[email protected]_@types+node@18.18.6_typescript@5.2.2/node_modules/iles/dist/client/app/components/Island.vue')['default']
+    Island: typeof import('./node_modules/.pnpm/[email protected]_@types+node@18.19.3_typescript@5.3.3/node_modules/iles/dist/client/app/components/Island.vue')['default']
     Language: typeof import('./src/components/mdx/stateful/Language.vue')['default']
     Languages: typeof import('./src/components/mdx/stateful/Languages.vue')['default']
     Modal: typeof import('./src/components/layout/Modal.vue')['default']

flake.nix

@@ -49,6 +49,7 @@
 
               # Link checking
               htmltest
+              lychee
 
               # JS
               nodejs

lychee.toml

@@ -0,0 +1,3 @@
+exclude = [
+  'https://github.com\.*',
+] # TODO: remove this when we figure out a way around GitHub's rate limits

src/pages/concepts/channels.mdx

@@ -5,14 +5,6 @@ snippet: |
   Nix's original but no longer recommended system for discovering and depending on [Nix expressions](/concepts/nix-language)
 related: ["flakes", "pinning"]
 externalSources: [
-  {
-    title: "Channels",
-    href: "https://nixos.org/manual/nix/stable/package-management/channels",
-    source: {
-      title: "The Nix manual",
-      href: "https://nixos.org/manual/nix/stable"
-    }
-  },
   {
     title: "Nix channels",
     href: "https://nixos.wiki/wiki/Nix_channels",

src/pages/start/8.learn-more.mdx

@@ -105,10 +105,10 @@ Another powerful Nix feature is that you can use it to build [OCI]-compliant con
   },
   {
     title: "Home Manager configuration options",
-    href: "https://rycee.gitlab.io/home-manager/options",
+    href: "https://nix-community.github.io/home-manager/options.xhtml",
     source: {
       title: "The Home Manager manual",
-      href: "https://rycee.gitlab.io/home-manager"
+      href: "https://nix-community.github.io/home-manager",
     }
   }
 ]} client:load />