Feat/nix shell

[ESCristiano]

PR Description

Add a nix-shell environment to contemplate all essential bao-project dependencies, allowing developers to effortlessly work across all bao-project repositories.

The user can utilize the bao-project nix-shell in three ways:

1. Run a standalone command within the bao-project nix-shell environment;

make -C ci/nix nix-shell-run cmd="your command"

2. Run a Ci Rule within the bao-project nix-shell environment;

For example, to run format check:

make -C ci/nix format-check

3. Open an interactive bao-project nix-shell environment.

make -C ci/nix nix-shell

Supported Bao-Project Repositories

The ultimate goal is to provide support for all the bao-projects repositories. Currently, the nix-shell only handles dependencies for bao-docs. Support for the remaining repositories will be incorporated in the future.

Type of change

• feat: introduces a new functionality
  • Logical unit: nix/shell.nix
  • Logical unit: nix/Makefile

Checklist:

• The changes generate no new warnings when building the project. If so, I have justified above.
• I have run the CI checkers before submitting the PR to avoid unnecessary runs of the workflow.

[AfonsoSantos96]

Fix typo to command

[ESCristiano]

I will fix the typo.

[AfonsoSantos96]

@param command-to-run The command to run inside the nix-shell.
I understood the description but it is in order to obey the doxygen comment style @param <variable_name> <description>

[ESCristiano]

I understand your comment, however, I just followed the description used in other rules on the makefile.

[josecm]

We should also modify the README introduction to highlight we have this build environment two.

[josecm]

@ESCristiano I've updated the README introduction to mention the nix-shell facility.

[ESCristiano]

@josecm I've incorporated your suggestion and now nix can be used in a similar way as docker.

I've also updated the PR description to reflect these changes.

[josecm]

Although we have no documentation on this, I typically make variables that can be passed by the user upper case, so:

Suggested change

	@nix-shell $(nix_dir)/shell.nix --run "$(cmd)"
	@nix-shell $(nix_dir)/shell.nix --run "$(CMD)"

[josecm]

I'd say first we could drop the nixprefixes on the make targets because this makefile is standalone, specifying nix shell is redundant as this is a the nix makefile.

Also, it would be possible to have a single target and recipe that would behave differently if CMD was specified by the user. In sum, something like:

Suggested change

	nix-shell:
	@nix-shell $(nix_dir)/shell.nix
	nix-shell-run:
	@nix-shell $(nix_dir)/shell.nix --run "$(cmd)"
	ifneq ($(CMD),)
	CMD:= --run $(CMD)
	endif
	shell:
	@nix-shell $(nix_dir)/shell.nix $(CMD)

[josecm]

I'd say the root dir by default should be:

Suggested change

	root_dir?=$(realpath ..)
	root_dir?=$(realpath ../../)

Which, by our convention on how the ci repo should be included in the project's repos, should be the repo top-level directory and where all commands by default should run. And then, in the recipes:

nix-shell:
	@cd $(root_dir) && nix-shell $(nix_dir)/shell.nix

nix-shell-run:
	@cd $(root_dir) && nix-shell $(nix_dir)/shell.nix --run "$(cmd)"

[josecm]

Since we have the nix only makefile, I think the modifications for this file should be removed.

[josecm]

I don't think these are actually needed.

[josecm]

Suggested change

	.PHONY: all
	.PHONY: all nix-shell nix-shell-run