extern/nixos-wiki-infra
1
0
Fork 1
mirror of https://github.com/Mic92/nixos-wiki-infra.git synced 2024-11-28 11:14:34 +01:00
Code Issues Packages Projects Releases Wiki Activity
4f79bc4c70
nixos-wiki-infra/checks/linkcheck
History
Jörg Thalheim 4f79bc4c70 linkcheck: add type annotations
2024-09-17 10:57:42 +02:00
..
pkgs ci: add broken link checker action 2024-09-17 09:51:24 +02:00
.envrc ci: add broken link checker action 2024-09-17 09:51:24 +02:00
.gitignore ci: add broken link checker action 2024-09-17 09:51:24 +02:00
allowed.links ci: add broken link checker action 2024-09-17 09:51:24 +02:00
lychee.sh add missing python3 to nix shebang 2024-09-17 10:57:42 +02:00
main.py linkcheck: add type annotations 2024-09-17 10:57:42 +02:00
README.md ci: add broken link checker action 2024-09-17 09:51:24 +02:00

README.md

What

wiki.nixos.org dead links checker gha powered by lychee

Runs twice a week, can be adjusted in the github action cron job. Need to manually edit links in wiki, nothing automated.

Initial run gave ~100 results and were fixed manually, see the entries before 16 Sep here.

Why

Dead links if detected early have a chance to prevent linkrot.

  • Why not use a broken-link-checker github action?
    • wrote this so that it is not tied in to gha (works locally)
    • gha will only call the script and upload artifact

Instructions

cd ./checks/linkcheck
direnv allow # or # nix develop ..#linkcheck
./lychee.sh

It can be run from anywhere so /path/to/checks/linkcheck/lychee.sh works but the report will be generated at /path/to/checks/linkcheck.

As usual, nix fmt works inside linkcheck dir.

TODO/Roadmap

  • archive all links found in lychee scan (see lychee --dump)
    • Since these links are prone to deletion it is our duty to archive them.
    • There was a cli tool for this, forgot what it is, rediscover it