Skip to content

Commit

Permalink
Add Smoke tests to README
Browse files Browse the repository at this point in the history
  • Loading branch information
razor-x committed Feb 17, 2023
1 parent 02571d6 commit 30fa51b
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,26 @@ $ npm install
[npm]: https://www.npmjs.com/
[nvm]: https://github.com/creationix/nvm

### Smoke tests

Any test file ending in `.test.js` is a smoke test
and runs separately from tests ending in `.spec.js`.
A smoke test verifies the server passes certain external checks.
During the GitHub Actions check, the Docker container is built and started,
then the smoke tests make requests to the server in a separate process.

To run the smoke tests locally, first start the test server with

```
$ npm start:test
```

and then in a separate terminal, run the smoke tests with

```
$ npm test:smoke
```

### Publishing

Use the [`npm version`][npm-version] command to release a new version.
Expand Down

0 comments on commit 30fa51b

Please sign in to comment.