From ad4983754b5800c0c9ec76e37569fee8e3e72814 Mon Sep 17 00:00:00 2001 From: ThetaSinner Date: Tue, 21 Nov 2023 13:47:50 +0000 Subject: [PATCH] Start a manual testing guide --- guides/manual-testing.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 guides/manual-testing.md diff --git a/guides/manual-testing.md b/guides/manual-testing.md new file mode 100644 index 000000000..0f4b534f7 --- /dev/null +++ b/guides/manual-testing.md @@ -0,0 +1,26 @@ +### Manually testing the Scaffolding tool + +#### Ensuring you're using the right Scaffolding version + +With the Scaffolding repository checked out, switch to the Git revision you want to test. + +Start the Nix development environment for the Scaffolding tool using: + +``` +nix develop --override-input "versions/scaffolding" . +``` + +This will give you a shell which includes the Scaffolding built from your local repository. + +Stay in the current Nix shell and change directory to somewhere that you want to put your test project. +For example, `cd /tmp`. You're now ready to scaffold a new app with `hc-scaffold web-app`. + +When following the instructions that the Scaffolding outputs, ignore `nix develop` and instead run: + +``` +nix develop --override-input "versions/scaffolding" +``` + +Which will ensure that you keep using the updated Scaffolding tool inside the scaffolded hApp environment. + +Now you can proceed with testing your changes as needed.