chore(nix): build and develop with nix (#172)

* chore(nix): build and develop with nix

* docs: adds nix flake instructions

.github/workflows/on-push-nixbuild.yml

@@ -0,0 +1,23 @@
+name: nix build
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  e2e-with-nix:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cachix/install-nix-action@v27
+        with:
+          github_access_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - run: nix flake check
+      - run: nix build .#nightly --verbose

.watch.yaml

@@ -1,15 +1,29 @@
-
 ## Funzzy events file
 # more details see: https://github.com/cristianoliveira/funzzy
 #
 # list here all the events and the commands that it should execute
 
-- name: run my unit tests @quick
-  run: 'make test'
+- name: build @quick
+  run: 'make build'
+  run_on_init: true
   change: '**/*.go'
 
 - name: run lint @quick
   run: 'make lint'
+  run_on_init: true
+  change: '**/*.go'
+
+- name: build nix
+  run:
+    - nix flake check
+    - nix build .#nightly --verbose
+  run_on_init: true
+  change: 
+    - '**/*.go'
+    - '**/*.nix'
+
+- name: run my unit tests @quick
+  run: 'make test'
   change: '**/*.go'
 
 - name: run tests with tag test-only @quick
@@ -19,3 +33,14 @@
 - name: run integration tests
   run: 'make integration'
   change: 'tests/*'
+
+- name: after all stage file
+  run: 
+    - git add {{relative_filepath}}
+    - git add -p # start a quick review and stage the rest
+  change: 
+    - 'README.md'
+    - 'Makefile'
+    - '**/*.nix'
+    - '**/*.go'
+    - 'tests/*'

Makefile

@@ -91,3 +91,6 @@ setup-golant:
 
 deps:
 	@go list -f '{{join .Imports "\n"}}{{"\n"}}{{join .TestImports "\n"}}' ./... | sort | uniq | grep -v ergo | go get
+
+nixbuild:
+	@nix build .#nightly

README.md

@@ -90,7 +90,9 @@ I use Unix-based systems on a daily basis, so I am not able to test each build a
 ### Nix
 
 ```bash
-nix profile install 'github:cristianoliveira/nixpkgs#funzzy'
+nix profile install 'github:cristianoliveira/ergo#nightly'
+// or
+nix profile install 'github:cristianoliveira/nixpkgs#ergoProxy'
 ```
 
 ### Go

flake.nix

@@ -0,0 +1,36 @@
+{
+  description = "New flake";
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs";
+    utils.url = "github:numtide/flake-utils";
+  };
+  outputs = { self, nixpkgs, utils }: 
+    utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = import nixpkgs { 
+          inherit system;
+          # Inject the namespace copkgs into the package set
+          overlays = [ 
+              (_: prev: {
+                copkgs = {
+                  ergoProxy = pkgs.callPackage ./nix/package.nix { inherit pkgs; };
+                  nightly = pkgs.callPackage ./nix/package-nightly.nix { 
+                    inherit pkgs;
+                  };
+                };
+              }
+            )
+          ];
+        };
+      in {
+        devShells.default = import ./nix/dev-env.nix {
+          inherit pkgs;
+        };
+
+        packages = {
+          default = pkgs.copkgs.ergoProxy;
+          ergoProxy = pkgs.copkgs.ergoProxy;
+          nightly = pkgs.copkgs.nightly;
+        };
+    });
+}

nix/dev-env.nix

@@ -0,0 +1,11 @@
+{ pkgs ? import <nixpkgs> {} }:
+  pkgs.mkShell {
+    # buildInputs is for dependencies you'd need "at run time",
+    # were you to to use nix-build not nix-shell and build whatever you were working on
+    buildInputs = [
+      pkgs.go
+      pkgs.copkgs.ergoProxy
+    ];
+
+    shell = pkgs.zsh;
+  }

nix/package-nightly.nix

@@ -0,0 +1,29 @@
+{ pkgs, ... }:
+  let 
+    _version = "v0.4.1-nighlty";
+  in
+    pkgs.buildGoModule {
+      # name of our derivation
+      name = "ergo-proxy";
+      version = "${_version}";
+      doCheck = true;
+
+      # sources that will be used for our derivation.
+      src = ../.;
+
+      modSha256 = "sha256-yXWM59zoZkQPpOouJoUd5KWfpdCBw47wknb+hYy6rh0=";
+
+      vendorHash = "sha256-yXWM59zoZkQPpOouJoUd5KWfpdCBw47wknb+hYy6rh0=";
+
+      ldflags = [
+        "-s" "-w"
+        "-X main.VERSION=${_version}"
+      ];
+
+      meta = with pkgs.lib; {
+        description = "Ergo: The reverse proxy agent for local domain management";
+        homepage = "https://github.com/cristianoliveira/ergo";
+        license = licenses.mit;
+        maintainers = with maintainers; [ cristianoliveira ];
+      };
+    }

nix/package.nix

@@ -0,0 +1,33 @@
+{ pkgs, ... }:
+  let 
+    _version = "v0.4.1";
+  in
+    pkgs.buildGoModule {
+      # name of our derivation
+      name = "ergo-proxy";
+      version = "${_version}";
+
+      # sources that will be used for our derivation.
+      src = pkgs.fetchFromGitHub {
+        owner = "cristianoliveira";
+        repo = "ergo";
+        rev = _version;
+        sha256 = "sha256-C3lJWuRyGuvo33kvj3ktWKYuUZ2yJ8pDBNX7YZn6wNM=";
+      };
+
+      modSha256 = "0fagi529m1gf5jrqdlg9vxxq4yz9k9q8h92ch0gahp43kxfbgr4q";
+
+      vendorHash = "sha256-yXWM59zoZkQPpOouJoUd5KWfpdCBw47wknb+hYy6rh0=";
+
+      ldflags = [
+        "-s" "-w"
+        "-X main.VERSION=${_version}"
+      ];
+
+      meta = with pkgs.lib; {
+        description = "Ergo: The reverse proxy agent for local domain management";
+        homepage = "https://github.com/cristianoliveira/ergo";
+        license = licenses.mit;
+        maintainers = with maintainers; [ cristianoliveira ];
+      };
+    }