From 59659243cd4ababda605e79b4a9c2e6d83e24c86 Mon Sep 17 00:00:00 2001 From: Cynthia Fox Date: Wed, 17 May 2023 06:59:35 -0400 Subject: [PATCH] PR_TEMPLATE: Note nix3 test method in checklist (#3972) * PR_TEMPLATE: Note nix3 test method in checklist Allows for running with the `nixpkgs` from the lock file, as well as using a more familiar interface for users of the experimental CLI, which would've avoided me opening #3971. Also updates the corresponding note in `docs/contributing.adoc` to have the correct invocation path. * PR_TEMPLATE: `the experimental CLI` -> `Flakes` --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- docs/contributing.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fd0a266be..6ad69b0b5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,7 +23,7 @@ Also make sure to read the guidelines found at - [ ] Code formatted with `./format`. -- [ ] Code tested through `nix-shell --pure tests -A run.all`. +- [ ] Code tested through `nix-shell --pure tests -A run.all` or `nix develop --ignore-environment .#all` using Flakes. - [ ] Test cases updated/added. See [example](https://github.com/nix-community/home-manager/commit/f3fbb50b68df20da47f9b0def5607857fcc0d021#diff-b61a6d542f9036550ba9c401c80f00ef). diff --git a/docs/contributing.adoc b/docs/contributing.adoc index 45c0ed551..5061b3902 100644 --- a/docs/contributing.adoc +++ b/docs/contributing.adoc @@ -263,4 +263,4 @@ $ nix-shell --pure tests -A run.alacritty-empty-settings However, those invocations will impurely source the system’s nixpkgs, and may cause failures. To run against the nixpkgs from the flake.lock, use instead e.g. [source,console] -$ nix develop --ignore-environment .#tests.all +$ nix develop --ignore-environment .#all