From 6800e5fd185095ec84bdd692b2bd45502f94891a Mon Sep 17 00:00:00 2001
From: Charles Hall <charles@computer.surgery>
Date: Thu, 14 Mar 2024 20:27:44 -0700
Subject: [PATCH] build book in ci, deploy it to gitlab pages

---
 .gitlab-ci.yml | 17 +++++++++++++++++
 engage.toml    | 10 ++++++++++
 flake.nix      |  3 +++
 3 files changed, 30 insertions(+)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 3b7016fb..8c880b9c 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -98,6 +98,10 @@ artifacts:
 
     - ./bin/nix-build-and-cache .#oci-image-aarch64-unknown-linux-musl
     - cp result oci-image-arm64v8.tar.gz
+
+    - ./bin/nix-build-and-cache .#book
+    # We can't just copy the symlink, we need to dereference it https://gitlab.com/gitlab-org/gitlab/-/issues/19746
+    - cp -r --dereference result public
   artifacts:
     paths:
       - x86_64-unknown-linux-musl
@@ -105,6 +109,7 @@ artifacts:
       - x86_64-unknown-linux-musl.deb
       - oci-image-amd64.tar.gz
       - oci-image-arm64v8.tar.gz
+      - public
   rules:
     # CI required for all MRs
     - if: $CI_PIPELINE_SOURCE == "merge_request_event"
@@ -165,3 +170,15 @@ oci-image:push-dockerhub:
     IMAGE_NAME: matrixconduit/matrix-conduit
   before_script:
     - docker login -u $DOCKER_HUB_USER -p $DOCKER_HUB_PASSWORD
+
+pages:
+  stage: publish
+  dependencies:
+    - artifacts
+  only:
+    - next
+  script:
+    - "true"
+  artifacts:
+    paths:
+      - public
diff --git a/engage.toml b/engage.toml
index 3e8884eb..cb284167 100644
--- a/engage.toml
+++ b/engage.toml
@@ -30,6 +30,11 @@ name = "cargo-clippy"
 group = "versions"
 script = "cargo clippy -- --version"
 
+[[task]]
+name = "lychee"
+group = "versions"
+script = "lychee --version"
+
 [[task]]
 name = "cargo-fmt"
 group = "lints"
@@ -51,6 +56,11 @@ name = "cargo-clippy"
 group = "lints"
 script = "cargo clippy --workspace --all-targets --color=always -- -D warnings"
 
+[[task]]
+name = "lychee"
+group = "lints"
+script = "lychee --offline docs"
+
 [[task]]
 name = "cargo"
 group = "tests"
diff --git a/flake.nix b/flake.nix
index 0e699e1d..9cd826b8 100644
--- a/flake.nix
+++ b/flake.nix
@@ -304,6 +304,9 @@
 
           # Needed for our script for Complement
           jq
+
+          # Needed for finding broken markdown links
+          lychee
         ]);
       };
     });