From 2359c9c3afabf6986ef5bf4f00b460cba9334ab6 Mon Sep 17 00:00:00 2001
From: Jordan Williams <jordan@jwillikers.com>
Date: Thu, 10 Oct 2024 11:46:39 -0500
Subject: [PATCH] Verify links in the README files

---
 .github/workflows/link-checker.yaml | 4 +++-
 .gitignore                          | 5 +++++
 .justfile                           | 3 ++-
 LICENSE.adoc                        | 6 +++---
 flake.nix                           | 1 +
 5 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/link-checker.yaml b/.github/workflows/link-checker.yaml
index e2d1cce..0b68c3e 100644
--- a/.github/workflows/link-checker.yaml
+++ b/.github/workflows/link-checker.yaml
@@ -26,7 +26,9 @@ jobs:
       # todo Cache bundler stuff?
       - name: Build with Jekyll
         run: nix build
+      - name: Convert the README files to html
+        run: nix develop --command asciidoctor {CODE_OF_CONDUCT,LICENSE,README}.adoc
       - name: Run lychee on the generated site
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: nix develop --command lychee --cache --no-progress --verbose result/srv/
+        run: nix develop --command lychee --cache --no-progress --verbose result/srv/ ./*.html
diff --git a/.gitignore b/.gitignore
index d644551..3f20b22 100644
--- a/.gitignore
+++ b/.gitignore
@@ -78,3 +78,8 @@ result
 
 # lychee
 .lycheecache
+
+# Asciidoctor
+CODE_OF_CONDUCT.html
+LICENSE.html
+README.html
diff --git a/.justfile b/.justfile
index 7b68d50..aec2016 100644
--- a/.justfile
+++ b/.justfile
@@ -4,7 +4,8 @@ alias c := check
 
 check: build
     yamllint .
-    lychee --cache _site/
+    asciidoctor {CODE_OF_CONDUCT,LICENSE,README}.adoc
+    lychee --cache _site/ *.html
 
 alias f := format
 alias fmt := format
diff --git a/LICENSE.adoc b/LICENSE.adoc
index f58ff0b..74accaf 100644
--- a/LICENSE.adoc
+++ b/LICENSE.adoc
@@ -1,7 +1,7 @@
 = GNU General Public License
 
 _Version 3, 29 June 2007_
-_Copyright © 2007 Free Software Foundation, Inc. &lt;<http://fsf.org/>&gt;_
+_Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>_
 
 Everyone is permitted to copy and distribute verbatim copies of this license
 document, but changing it is not allowed.
@@ -584,11 +584,11 @@ for a GUI interface, you would use an “about box”.
 You should also get your employer (if you work as a programmer) or school, if any, to
 sign a “copyright disclaimer” for the program, if necessary. For more
 information on this, and how to apply and follow the GNU GPL, see
-&lt;<http://www.gnu.org/licenses/>&gt;.
+<http://www.gnu.org/licenses/>.
 
 The GNU General Public License does not permit incorporating your program into
 proprietary programs. If your program is a subroutine library, you may consider it
 more useful to permit linking proprietary applications with the library. If this is
 what you want to do, use the GNU Lesser General Public License instead of this
 License. But first, please read
-&lt;<http://www.gnu.org/philosophy/why-not-lgpl.html>&gt;.
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/flake.nix b/flake.nix
index 2a00828..013a010 100644
--- a/flake.nix
+++ b/flake.nix
@@ -29,6 +29,7 @@
           extraConfigPaths = [ "${./.}/.ruby-version" ];
         };
         nativeBuildInputs = with pkgs; [
+          asciidoctor
           bundix
           fish
           gems