From 41f5b167e7cfe2fe1ef90f7007708916bd65565d Mon Sep 17 00:00:00 2001 From: Gaetan Lepage Date: Wed, 13 Dec 2023 14:35:01 +0100 Subject: [PATCH] templates/README: update regarding template lock file management --- templates/_wrapper/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/templates/_wrapper/README.md b/templates/_wrapper/README.md index 854df5b1..dd437808 100644 --- a/templates/_wrapper/README.md +++ b/templates/_wrapper/README.md @@ -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.