Skip to content

Commit 30fa51b

Browse files
committed
Add Smoke tests to README
1 parent 02571d6 commit 30fa51b

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,26 @@ $ npm install
223223
[npm]: https://www.npmjs.com/
224224
[nvm]: https://github.com/creationix/nvm
225225

226+
### Smoke tests
227+
228+
Any test file ending in `.test.js` is a smoke test
229+
and runs separately from tests ending in `.spec.js`.
230+
A smoke test verifies the server passes certain external checks.
231+
During the GitHub Actions check, the Docker container is built and started,
232+
then the smoke tests make requests to the server in a separate process.
233+
234+
To run the smoke tests locally, first start the test server with
235+
236+
```
237+
$ npm start:test
238+
```
239+
240+
and then in a separate terminal, run the smoke tests with
241+
242+
```
243+
$ npm test:smoke
244+
```
245+
226246
### Publishing
227247

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

0 commit comments

Comments
 (0)