templates/README: update regarding template lock file management

This commit is contained in:
Gaetan Lepage 2023-12-13 14:35:01 +01:00 committed by Gaétan Lepage
parent 13f22b5083
commit 41f5b167e7

View file

@ -6,4 +6,6 @@ It does this by overwriting the url of nixvim and other dependencies to a path w
It is also used in the github workflows, so that we can always check if the template is working or not
NOTE: It is important that we do not commit the `flake.lock` files here as that could cause problems with the check once any files are updated outside the wrapper. Also we cannot add `flake.lock` to `.gitignore` since nix will sometimes complain.
NOTE: It is important that we do not commit the `flake.lock` files here as that could cause problems with the check once any files are updated outside the wrapper.
That is why we add them to `.gitignore`.
Finally, the `nix flake check` command for templates should be called with the `--no-write-lock-file` flag.