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

Close #949, update local dev package.json commands #950

Merged
merged 1 commit into from
Oct 21, 2024
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
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,25 +41,46 @@ Read about contributing in our [CONTRIBUTING.md document](CONTRIBUTING.md). Here
## Cheat sheet

*Once you've already read the contributing documentation, you can use these as quick reminders for running our internal tests.*
To set up for the integration tests, create the project on the server:

### `setup` before starting development of a feature/fix

Set up for the cucumber integration tests.

Add the feature branch name to your `.env` file:

```
BRANCH=42_feat_life_the_univers_and_everything
```

Then create the project on the server:

```bash
npm run setup
```

Use the syntax below to trigger specific tags:
### Run tests repeatedly

Run all cucumber tests that are not currently blocked by upstream changes:

```bash
npm run pass
```

Trigger cucumber tests with specific tags:

```bash
npm run cucumber -- "--tags" "@tagname"
npm run cucumber "@tagname"
```

To run the unit tests in isolation:
Run the unit tests:

```bash
npm run unit
```

If you or someone else changes the interview code in `./docassemble`, you have to clean up the old data on the server before running `setup` again:
### Always run `takedown` before running `setup` again

If you or someone else changes the interview code in our `./docassemble` directory, you have to delete the code currently on the testing server before running `setup` again. Also do this when you're done with the feature/fix or starting a new feature/fix.

```bash
npm run takedown
Expand Down
Loading