Development Shell
A Nix dev shell is available, providing nixpkgs-fmt and just. To enter the dev shell, run:
nix develop ./dev
An .envrc is also provided, so it is recommended to use direnv to automatically enter the dev shell when you cd into the project directory. See this tutorial.
Adding a new service
The project repository is structure to make addition of new services easy. Here’s how to add a new service:
See https://github.com/cachix/devenv/tree/main/src/modules/services for inspiration.
If you don’t find a new service there, see https://github.com/NixOS/nixpkgs/tree/master/nixos/modules/services.
-
Create a new file
./nix/services/<service-name>.nixfile (see ./nix/services/redis.nix for inspiration) - Add the service to the list in ./nix/services/default.nix.
-
Create a new test file
./nix/services/<service-name>_test.nix(see ./nix/services/redis_test.nix). - Add the test to ./test/flake.nix.
Run the service
just run <service-name>Run the tests for the service
The previous command will run the services but not the tests. To run the tests, use:
just test <service-name>or test all services:
just test-allAdd documentation for the new service
It is important to add documentation along with any new services you are contributing. Create a new file ./doc/<service-name>.md (see Clickhouse for example) and add the service to the list in Supported services.
It is recommended to add documentation for non-trivial tasks. For example, grafana documentation mentions how to change the default database backend.
Documentation
For contributing to docs, see https://github.com/flake-parts/community.flake.parts#guidelines-for-writing-docs
We use emanote to render our documentation. The source files are in the doc directory. To run the docs, use:
just doc # Or, `cd doc && nix run`