-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
support yml extension on the config file
- Loading branch information
Showing
2 changed files
with
14 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,7 +29,7 @@ The `codacy-cli-v2` is a command-line tool for Codacy that supports analyzing co | |
|
||
### Important Concepts | ||
|
||
- **`.codacy/.codacy.yaml`**: Configuration file to specify `node` and `eslint` versions for the CLI. | ||
- **`.codacy/codacy.yaml`**: Configuration file to specify `node` and `eslint` versions for the CLI. | ||
```yaml | ||
runtimes: | ||
- [email protected] | ||
|
@@ -66,29 +66,29 @@ alias codacy-cli-v2="bash <(curl -Ls https://raw.githubusercontent.com/codacy/co | |
Before running the analysis, install the specified tools: | ||
|
||
```bash | ||
codacy-cli-v2 install | ||
codacy-cli install | ||
``` | ||
|
||
### Run Analysis | ||
|
||
To run ESLint and output the results to the terminal: | ||
|
||
```bash | ||
codacy-cli-v2 analyze --tool eslint | ||
codacy-cli analyze --tool eslint | ||
``` | ||
|
||
To store the results as SARIF in a file: | ||
|
||
```bash | ||
codacy-cli-v2 analyze -t eslint -o eslint.sarif | ||
codacy-cli analyze -t eslint -o eslint.sarif | ||
``` | ||
|
||
## Upload Results | ||
|
||
To upload a SARIF file to Codacy: | ||
|
||
```bash | ||
codacy-cli-v2 upload -s path/to/your.sarif -c your-commit-uuid -t your-project-token | ||
codacy-cli upload -s path/to/your.sarif -c your-commit-uuid -t your-project-token | ||
``` | ||
|
||
### Example Repository | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters