Documentation

menu

CIshare

Once you have the garnix GitHub app enabled for your repo and added a flake file to the root of your repo, every git push to the repo will be picked up by garnix.

garnix will read your flake.nix file and analyze its flake outputs. By default it will then build all linux packages, linux checks, linux devShells and all home-, darwin- and nixosConfigurations.

You will see logs and statuses of these builds both on GitHub (as commit and PR checks) and on app.garnix.io.

By convention, lots of nix packages will — while being built — also execute all the software's test-suites. You can stick to that, or alternatively you can add test-suites as flake checks.

(garnix will not build all buildable outputs. For the default configuration and how to tweak it, see the yaml config docs.)