Merge pull request #133 from Electric-Coin-Company/nix-flake

A nix flake for the final rendered result

.github/workflows/merge-acceptance.yaml

@@ -24,3 +24,12 @@ jobs:
     - run: mdbook build
     - name: Check for Orphaned Files
       run: ./util/find-orphaned-files.sh
+
+  # Reference: https://github.com/marketplace/actions/install-nix
+  check-flake:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: cachix/install-nix-action@v22
+    - run: nix build
+    - run: nix flake check

README.md

@@ -26,6 +26,8 @@ git config --local core.hooksPath git-hooks
 
 ## Prerequisites
 
+Note: Nix users can rely on `flake.nix` which packages the final rendered HTML into `<prefix>/share/doc/tfl-book`. Users can install this via `nix profile install 'github:Electric-Coin-Company/tfl-book'`, or to build the local version `nix build`.
+
 ### Rust prerequisites
 
 - `cargo install mdbook`

flake.nix

@@ -0,0 +1,39 @@
+{
+  description = "The Zcash Trailing Finality Layer Book";
+
+  inputs.nixpkgs.url = "github:nixos/nixpkgs/23.11";
+
+  outputs = { self, nixpkgs }:
+  let
+    system = "x86_64-linux";
+    pkgs = nixpkgs.legacyPackages."${system}";
+
+    tfl-book-pkg = pkgs.stdenv.mkDerivation rec {
+      pname = "tfl-book";
+      version = "0.1.0"; # BUG: This should be derived from the `git describe --dirty`
+
+      buildInputs = with pkgs; [
+        graphviz
+        mdbook
+        mdbook-graphviz
+        mdbook-linkcheck
+        mdbook-katex
+      ];
+
+      src = ./.;
+
+      builder = pkgs.writeScript "${pname}-builder-${version}" ''
+        source "$stdenv/setup"
+        cp -a "$src" ./src
+        cd ./src
+        chmod -R u+w .
+        mdbook build
+        dest="$out/share/doc/${pname}/"
+        mkdir -p "$(dirname "$dest")"
+        cp -a ./build/html "$dest"
+      '';
+    };
+  in {
+    packages."${system}".default = tfl-book-pkg;
+  };
+}