Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start a manual testing guide #159

Merged
merged 1 commit into from
Nov 22, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions guides/manual-testing.md
Original file line number Diff line number Diff line change
@@ -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" <path-to-local-scaffolding-clone>
```

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.