Skip to content

Commit 5ea8167

Browse files
committed
chore: update contribution
1 parent 99a7e5d commit 5ea8167

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,24 @@ To update snapshots, run `npm run e2e -- -u`.
196196

197197
If you made any changes, make sure to compile the code before running the tests.
198198

199+
### Smoke tests
200+
201+
Smokes are for testing the CLI in different environments.
202+
203+
To run them locally, please follow the steps described in the smoke GitHub actions: [smoke-basic](.github/workflows/smoke.yaml), [smoke-plugins](.github/workflows/smoke-plugins.yaml), [smoke-rebilly](.github/workflows/smoke-rebilly.yaml).
204+
205+
To update smoke tests for the `build-docs` command (which sometimes fails due to external package updates), please follow the steps below:
206+
207+
```sh
208+
# Build and install the current CLI build locally
209+
npm run compile
210+
npm run pack:prepare
211+
npm i -g redocly-cli.tgz
212+
213+
# Re-build the docs
214+
(cd __tests__/smoke/ && redocly build-docs openapi.yaml -o pre-built/redoc.html)
215+
```
216+
199217
### Performance benchmark
200218

201219
To run the performance benchmark locally, you should have `hyperfine` (v1.16.1+) installed on your machine.

0 commit comments

Comments
 (0)