Flake (#164)

Simple flake for multi cabal home Uses haskell-flake-utils (experimental) to provide build and devShell with nix flakes: ``` nix build .#rhine-gloss result/bin/rhine-gloss-gears ``` ``` nix develop cabal build rhine ``` Co-authored-by: Manuel Bärenz <[email protected]>
turion · Jun 20, 2022 · 35625e7 · 35625e7
1 parent a43d98b
commit 35625e7
Show file tree

Hide file tree

Showing 19 changed files with 158 additions and 84 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -37,3 +37,24 @@ jobs:
       - name: Cabal test
         run: |
           cabal test all --enable-tests --test-show-details=Always --project-file=cabal.project.${{ matrix.ghc }}
+  build-flake:
+    name: Nix Flake
+    strategy:
+      matrix:
+        os:
+          - ubuntu-20.04
+          - macos-12
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/[email protected]
+      - uses: cachix/install-nix-action@v15
+      - name: Build default package (rhine)
+        run: nix build
+      - name: Build default package (rhine-examples)
+        run: nix build .#rhine-examples
+      - name: Build default package (rhine-gloss)
+        run: nix build .#rhine-gloss
+      - name: Run tests
+        run: nix develop -c cabal test all
+      # nix flake check breaks on IFD in multi-platform flake https://github.com/NixOS/nix/issues/4265
+      # - run: nix flake check
diff --git a/.gitignore b/.gitignore
@@ -17,3 +17,4 @@ cabal.sandbox.config
 *.eventlog
 .stack-work/
 cabal.project.local
+result
diff --git a/Contributing.md b/Contributing.md
@@ -23,8 +23,8 @@
 
 ### GHC, cabal, stack, nix
 
-* Rhine should be compilable with `cabal`, `nix` and `stack`.
-  If in doubt, use `cabal` and `nix`.
+* Rhine should be compilable with `cabal`, `nix` (including flakes) and `stack`.
+  If in doubt, use `cabal` and `nix` (preferably flakes with `nix develop`).
 * Rhine does not make an effort to support old GHC versions,
   but it does make an effort to support _new_ versions.
   Check `.travis.yml` for supported GHC versions.

diff --git a/README.md b/README.md
@@ -38,6 +38,7 @@ constraints on clocks come into effect, enforcing clock safety.
 
 A typical example,
 which can be run as `cd rhine-examples/ && cabal run Demonstration`,
+(or using nix flakes with `nix develop` followed `cabal run Demonstration`),
 would be:
 
 ```haskell

diff --git a/default.nix b/default.nix
@@ -1,12 +1,9 @@
-attrs@{ ... }:
-
 let
-  localPackages = import ./nix/localPackages.nix attrs;
+  lock = builtins.fromJSON (builtins.readFile ./flake.lock);
+  flake-compat-src = fetchTarball {
+    url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
+    sha256 = lock.nodes.flake-compat.locked.narHash;
+  };
+  flake-compat = import flake-compat-src { src =  ./.; };
 in
-{
-  inherit (localPackages)
-    rhine
-    rhine-gloss
-    rhine-examples
-  ;
-}
+flake-compat.defaultNix
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
@@ -0,0 +1,38 @@
+{
+  description = "rhine";
+  nixConfig.bash-prompt = "\[rhine\]$ ";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs";
+    flake-utils.url = "github:numtide/flake-utils";
+
+    flake-compat = {
+      url = "github:edolstra/flake-compat";
+      flake = false;
+    };
+
+    haskell-flake-utils = {
+      url = "github:ivanovs-4/haskell-flake-utils";
+      inputs.nixpkgs.follows = "nixpkgs";
+      inputs.flake-utils.follows = "flake-utils";
+    };
+  };
+
+outputs = { self, nixpkgs, flake-utils, haskell-flake-utils, flake-compat, ... }:
+  haskell-flake-utils.lib.simpleCabalProject2flake {
+    inherit self nixpkgs;
+
+    systems = [
+      # Tested in CI
+      "x86_64-linux"
+      "x86_64-darwin"
+      # Tested by maintainers
+      "aarch64-darwin"
+      # Not sure we can test this in CI
+      "i686-linux"
+    ];
+
+    name = "rhine";
+    packageNames = [ "rhine-gloss" "rhine-examples" ];
+  };
+}
diff --git a/nix/all-ghcs.nix b/nix/all-ghcs.nix
diff --git a/nix/defaults.nix b/nix/defaults.nix
diff --git a/nix/localPackages.nix b/nix/localPackages.nix
diff --git a/nix/shellFrom.nix b/nix/shellFrom.nix
diff --git a/rhine-examples/default.nix b/rhine-examples/default.nix
diff --git a/rhine-examples/shell.nix b/rhine-examples/shell.nix
diff --git a/rhine-gloss/default.nix b/rhine-gloss/default.nix
diff --git a/rhine-gloss/shell.nix b/rhine-gloss/shell.nix
diff --git a/rhine-gloss/stack_NixOS.yaml b/rhine-gloss/stack_NixOS.yaml
diff --git a/rhine/default.nix b/rhine/default.nix
diff --git a/rhine/shell.nix b/rhine/shell.nix
diff --git a/shell.nix b/shell.nix
@@ -1,4 +1,9 @@
 let
-  mypkgs = import ./. {};
-  shellFrom = import ./nix/shellFrom.nix {};
-in shellFrom mypkgs.rhine-gloss
+  lock = builtins.fromJSON (builtins.readFile ./flake.lock);
+  flake-compat-src = fetchTarball {
+    url = "https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
+    sha256 = lock.nodes.flake-compat.locked.narHash;
+  };
+  flake-compat = import flake-compat-src { src =  ./.; };
+in
+flake-compat.shellNix