Skip to content

Commit

Permalink
feat: add CI mode info to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vlasy committed May 27, 2021
1 parent 109652e commit 8ab52e5
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ Swift | 🚧
* [Supported Languages](#What-language-is-supported)
* [Configuration](#configuration-%EF%B8%8F)
* [Practices](#Practices)
* [CI Mode](#CI-mode)
* [GitHub CI Action](#GitHub-Ci-Action)
* [Support](#support-%EF%B8%8F-%EF%B8%8F)
* [Contributing](#Contributing--)
Expand Down Expand Up @@ -142,6 +143,7 @@ Options:
-j --json print report in JSON (default: false)
--html [path] save report in HTML file (default: false, default path: ./report.html)
-r --recursive scan all components recursively in all sub folders (default: false)
--no-recursive disable recursive scan in CI mode
-h, --help output usage information
Examples:
Expand Down Expand Up @@ -282,6 +284,11 @@ practices:
measurePullRequestCount: 500
```

### CI Mode
When running DX Scanner with `--ci` flag, it runs in CI Mode. In CI Mode, DX SCanner uses `CIReporter` for its output and runs recursively by default (i.e. the `--recursive` flag is turned on).

If you want to disable recursive scan in CI mode, use the `--no-recursive` flag.

### Github CI Action

**Basic example**: run DX Scanner on each push to the repo
Expand Down

0 comments on commit 8ab52e5

Please sign in to comment.