Merge pull request #352 from mhkarimi1383/add-controller-tools-nix

feat(chores): Add missing tools to nix-shell
openebs · Dec 16, 2024 · 5c68557 · 5c68557
2 parents 0bb55b4 + 0313fa2
commit 5c68557
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 4 deletions.
diff --git a/.envrc b/.envrc
@@ -0,0 +1 @@
+use nix
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -45,8 +45,10 @@ jobs:
 
       - uses: cachix/install-nix-action@v22
       - uses: rrbutani/[email protected]
+        env:
+          HOME: /home/runner
         with:
-            file: shell.nix
+          file: shell.nix
 
       - name: Check if the chart follows a valid semver version
         run: |

diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ tags
 *.swn
 *.idea
 *.test
+coverage.txt
diff --git a/docs/developer-setup.md b/docs/developer-setup.md
@@ -33,7 +33,7 @@ git remote -v
 ```
 
 Install the build dependencies.
-  * Run `make bootstrap` to install the required Go tools
+  * Run `make bootstrap` to install the required Go tools, Nix users can run `nix-shell`, it will bring up a shell with required tools installed
 
 ## Git Development Workflow
 

diff --git a/nix/.gitignore b/nix/.gitignore
@@ -0,0 +1,2 @@
+.go/
+.tmp/
diff --git a/shell.nix b/shell.nix
@@ -5,8 +5,25 @@ in
 pkgs.mkShell {
   name = "scripts-shell";
   buildInputs = with pkgs; [
+    chart-testing
+    ginkgo
+    git
+    go_1_19
+    golint
+    kubectl
+    kubernetes-helm
+    gnumake
+    minikube
     semver-tool
     yq-go
-    chart-testing
   ];
-}
+  shellHook = ''
+    export HOME=${builtins.getEnv "HOME"}
+    export GOPATH=$(pwd)/nix/.go
+    export GOCACHE=$(pwd)/nix/.go/cache
+    export TMPDIR=$(pwd)/nix/.tmp
+    export PATH=$GOPATH/bin:$PATH
+    mkdir -p "$TMPDIR"
+    make bootstrap
+  '';
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,3 +7,4 @@ tags @@
     *.swn
     *.idea
     *.test
+    coverage.txt