disable broken linkchecker CI test

Author: Mic92

.github/workflows/test.yml

@@ -5,21 +5,25 @@ on:
   pull_request: {}
 
 jobs:
-  linkcheck:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-      with:
-       fetch-depth: 0
-    - uses: cachix/install-nix-action@v31
-      with:
-        nix_path: nixpkgs=channel:nixos-unstable
-    - uses: cachix/cachix-action@v16
-      with:
-        name: nix-dev
-        authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
-    - name: Run linkcheck
-      run: nix-shell --run "make linkcheck"
+  # The linkchecker runs into rate limits 100% of the time in CI for a very long time
+  # It requires caching to not hit all endpoints each time.
+  # Lychee might be an alternative that does that check:
+  # https://github.com/nix-community/awesome-nix/blob/242818562cc0d2d1464f7ca06880d4902569647b/.github/workflows/check-link.yml#L24
+  #linkcheck:
+  #  runs-on: ubuntu-latest
+  #  steps:
+  #  - uses: actions/checkout@v4
+  #    with:
+  #     fetch-depth: 0
+  #  - uses: cachix/install-nix-action@v31
+  #    with:
+  #      nix_path: nixpkgs=channel:nixos-unstable
+  #  - uses: cachix/cachix-action@v16
+  #    with:
+  #      name: nix-dev
+  #      authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
+  #  - name: Run linkcheck
+  #    run: nix-shell --run "make linkcheck"
   codeblock:
     runs-on: ubuntu-latest
     steps: