Simplification of Nix flake and removal of GHC 8 (#245)

Co-authored-by: CristhianMotoche <[email protected]>
Co-authored-by: Sebastián Estrella <[email protected]>

Author: 3 people

.envrc

@@ -0,0 +1 @@
+use flake

.github/workflows/build.yml

@@ -15,9 +15,6 @@ jobs:
           - macos-13      # x86_64-darwin
           - macos-latest  # aarch64-darwin
           - ubuntu-latest # x86_64-linux
-        ghc:
-          - ghc8107
-          - ghc902
       fail-fast: true
     runs-on: ${{ matrix.os }}
     timeout-minutes: 30
@@ -28,9 +25,9 @@ jobs:
           extra-conf: accept-flake-config = true
       - uses: DeterminateSystems/magic-nix-cache-action@v7
       - name: Compile code ${{ matrix.ghc }}
-        run: nix build .#test-${{ matrix.ghc }}
+        run: nix build .#test
       - name: Run tests ${{ matrix.ghc }}
-        run: nix run .#test-${{ matrix.ghc }}
+        run: nix run .#test
 
   docker:
     uses: ./.github/workflows/reusable-docker.yml

.gitignore

@@ -6,7 +6,6 @@
 *.o
 .cabal-sandbox/
 .direnv/
-.envrc
 .hpc
 .hsenv
 .tool-versions

Dockerfile

@@ -1,4 +1,4 @@
-FROM utdemir/ghc-musl:v24-ghc902 AS build
+FROM quay.io/benz0li/ghc-musl:9.6.6 AS build
 WORKDIR /usr/src/app
 COPY hapistrano.cabal .
 RUN cabal update && \
@@ -8,7 +8,7 @@ RUN cabal build --enable-executable-static && \
     cp $(cabal exec which hap) hap
 
 FROM alpine:3.15
-MAINTAINER Nicolas Vivar <nvivar@stackbuilders.com>
+MAINTAINER Cristhian Motoche <cmotoche@stackbuilders.com>
 RUN apk update && \
     apk add \
       ca-certificates \

docs/NIX.md

@@ -22,40 +22,27 @@ sudo launchctl start org.nixos.nix-daemon
 ```
 
 If the following messages appear running the scripts detailed in the section
-below, it means that the Nix is not able to talk with the cache, in which case
-is recommended to go over the steps detailed in this section again:
+below, it means that Nix is not picking up the substituters we described
+earlier and is unable to use them as a derivation cache: 
 
 ```
 warning: ignoring untrusted substituter 'https://cache.iog.io'
 ```
+in which case
+it is recommended to go over the steps detailed in this section again, or look for alternative ways to add extra substituters in [nix.conf](https://nix.dev/manual/nix/2.18/command-ref/conf-file).
 
-## Switching between different GHC versions
+## Enabling the development environment
 
-The `bin` directory, holds all available shells:
+To enable the development environment exposed by the project's [Nix flake](../flake.nix), you can start a development shell by running the following command from within the project's root:
 
 ```
-ls bin | grep ghc
+nix develop
 ```
 
-To spawn a new shell with a pre-defined GHC version, choose one of the scripts
-listed above and run the following command:
+Alternatively, if you are using [nix-direnv](https://github.com/nix-community/nix-direnv) (recommended), you can run:
 
-```sh
-./bin/ghc90
 ```
-
-Once inside the shell, verify the GHC version matches the script name:
-
-```
-ghc --version
+direnv allow
 ```
 
-After that, all commands detailed in the [Getting
-Started](../README.md#getting-started) section should work the same.
-
-Alternatively, to run a command without spawning a new shell use the `-c`
-option:
-
-```sh
-./bin/ghc90 -c <command>
-```
+that will enable the development shell according to the contents of [.envrc](../.envrc). It is advisable not to run `direnv allow` blindly and always check the contents of [.envrc](../.envrc) files first to ensure nothing malicious is executed.

flake.lock

@@ -21,45 +21,37 @@
     # https://input-output-hk.github.io/haskell.nix/tutorials/getting-started-flakes.html
     flake-utils.lib.eachDefaultSystem (system:
       let
-        pkgs = import nixpkgs {
-          inherit system;
-          inherit (haskellNix) config;
-          overlays = [
-            haskellNix.overlay
-            (final: prev: {
-              hapistrano-ghc8107 = final.haskell-nix.cabalProject' {
-                src = final.haskell-nix.haskellLib.cleanGit {
-                  name = "hapistrano";
-                  src = ./.;
-                };
-                compiler-nix-name = "ghc8107";
+        overlays = [
+          haskellNix.overlay
+          (final: prev: {
+            hapistrano = final.haskell-nix.cabalProject' {
+              src = final.haskell-nix.haskellLib.cleanGit {
+                name = "hapistrano";
+                src = ./.;
               };
-              hapistrano-ghc902 = final.haskell-nix.cabalProject' {
-                src = final.haskell-nix.haskellLib.cleanGit {
-                  name = "hapistrano";
-                  src = ./.;
-                };
-                compiler-nix-name = "ghc902";
+              # This is used by `nix develop .` to open a shell for use with
+              # `cabal`, `hlint` and `haskell-language-server`
+              shell.tools = {
+                cabal = {};
+                hlint = {};
+                haskell-language-server = {};
               };
-            })
-          ];
-        };
-        flake-ghc8107 = pkgs.hapistrano-ghc8107.flake { };
-        flake-ghc902 = pkgs.hapistrano-ghc902.flake { };
+              compiler-nix-name = "ghc966";
+            };
+          })
+        ];       
+        pkgs = import nixpkgs { inherit system overlays; inherit (haskellNix) config; };
+        flake = pkgs.hapistrano.flake { };
       in rec {
         apps = {
-          test-ghc8107 = {
-            type = "app";
-            program = "${packages.test-ghc8107}/bin/test";
-          };
-          test-ghc902 = {
+          test = {
             type = "app";
-            program = "${packages.test-ghc902}/bin/test";
+            program = "${packages.test}/bin/test";
           };
         };
         packages = {
-          default = flake-ghc8107.packages."hapistrano:exe:hap";
-          test-ghc8107 = flake-ghc8107.packages."hapistrano:test:test".overrideAttrs (_: {
+          default = flake.packages."hapistrano:exe:hap";
+          test = flake.packages."hapistrano:test:test".overrideAttrs (_: {
             postFixup = ''
               wrapProgram $out/bin/test \
                 --set PATH ${pkgs.lib.makeBinPath [
@@ -71,23 +63,6 @@
                 ]}
             '';
           });
-          test-ghc902 = flake-ghc902.packages."hapistrano:test:test".overrideAttrs (_: {
-            postFixup = ''
-              wrapProgram $out/bin/test \
-                --set PATH ${pkgs.lib.makeBinPath [
-                  pkgs.bash
-                  pkgs.coreutils
-                  pkgs.findutils
-                  pkgs.git
-                  pkgs.zsh
-                ]}
-            '';
-          });
-        };
-        devShells = {
-          default = devShells.ghc902;
-          ghc8107 = flake-ghc8107.devShells.default;
-          ghc902 = flake-ghc902.devShells.default;
         };
       });
 }

flake.nix

@@ -28,7 +28,7 @@ category:            System
 homepage:            https://github.com/stackbuilders/hapistrano
 bug-reports:         https://github.com/stackbuilders/hapistrano/issues
 build-type:          Simple
-tested-with:         GHC==8.10.17, GHC==9.0.2
+tested-with:         GHC==9.6.6
 extra-doc-files:     CHANGELOG.md
                    , README.md
 
@@ -66,7 +66,7 @@ library
                      , text               >= 1.2 && < 3
                      , typed-process      >= 0.2 && < 0.3
                      , time               >= 1.5 && < 1.13
-                     , transformers       >= 0.4 && < 0.6
+                     , transformers       >= 0.4 && < 0.7
                      , exceptions         >= 0.10 && < 0.11
                      , yaml               >= 0.11.7 && < 0.12
   if flag(dev)