gasparev / disruptor Goto Github PK

$ ./nix-shell.sh
...
$ cd projects/bzl4
$ bazel build //...

At the moment, the project is built with {x86/x64, aarch64} architecture in mind, targeting GNU Linux-based distributions. Machine should either have user namespaces for unprivileged users enabled or have nix pre-installed in single-user mode.

To be implemented:

• MacOS support
• Fallback to proot for machines without support for user namespaces for unprivileged users

Simply type ./nix-shell.sh to be dropped into a shell with all batteries included.

Project utilizes nix to deliver a uniform, homogeneous development environment for each of its users & contributors - you are going to be using the same dependencies (bash, core utils, system libraries, bazel etc.), installed from the same source and configured in the same way. No more “works on my machine”-syndrome, as everyone has reproducible and identical working environments.

Note: Dependencies are automatically loaded / unloaded, as the user traverses the project tree - i.e. entering projects/bzl4 will result in loading up all of the project dependencies, while moving out of the example project tree will unload bazel. This is done to stay relatively lean in terms of what the average user needs to load.

• One can install nix globally for the user, which will then prevent the nix-shell.sh script from running everything from chrooted environment
• Nix with daemon enabled is not supported (so called multi-user installation) - this is due to nix configuration that happens on the fly, which would need to be propagated to daemon

It has been decided to track important choices in this project, with the help of Architectural Decision Records (ADRs for short, concept explained here or here). The main intent is to ensure everyone developing the project is well aligned with it's goals, always can quickly get up to speed or propose a new direction.

The ADRs are to be placed in docs/adrs directory of this repository and follow conventions described in the initial adr.