integration-tour 1.0.9 → 1.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/cli.js +687 -287
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -35,7 +35,7 @@ Other pipelines run the same commands, with the key in `INTEGRATION_TOUR_LICENSE
|
|
|
35
35
|
## Commands
|
|
36
36
|
|
|
37
37
|
```
|
|
38
|
-
integration-tour render <spec file or URL> [--edits <flow files or folder>] [--formats mp4,gif,html] [--out <folder>] [--allow-private-refs]
|
|
38
|
+
integration-tour render <spec file or URL> [--edits <flow files or folder>] [--formats mp4,gif,html] [--out <folder>] [--allow-private-refs] [--yes]
|
|
39
39
|
integration-tour check <spec file or URL> [--edits <flow files or folder>] [--allow-private-refs]
|
|
40
40
|
```
|
|
41
41
|
|
|
@@ -57,6 +57,8 @@ integration-tour check openapi.yaml --edits docs/flows/
|
|
|
57
57
|
|
|
58
58
|
`--allow-private-refs` lets the spec's references reach this machine and private networks, which they otherwise don't (see below): pass it for a spec you trust that references an internal schema server.
|
|
59
59
|
|
|
60
|
+
Before `render` writes anything in a terminal, it says what it hid on its own (a credential's field, a key by its shape) and lists what the videos show that may be personal or internal (an email address at a real domain, a phone number, a host on a private network, a card, bank account or ID number, a long random value that may be a key), then asks whether they hold no secrets or personal data. Anything but yes writes nothing. `--yes` answers yes, for a script you've checked. It never asks in CI, or where nothing can answer, so a pipeline runs as it always has: check a video in the app, or with a terminal, before its flow file goes in the repo.
|
|
61
|
+
|
|
60
62
|
Both commands exit with 1 when something failed, and 2 when the command itself is wrong. `--help`, alone or after a command, prints a summary of them, and `--version` the package's version.
|
|
61
63
|
|
|
62
64
|
## The flow file
|