Skip to content

Commit 301c418

Browse files
authored
Merge pull request #74 from codacy/doc/update
doc: Add Troubleshotting section + clean up
2 parents 9a3ae32 + a73fdf3 commit 301c418

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ To install `codacy-cli` using Homebrew:
4545
brew install codacy/codacy-cli-v2/codacy-cli-v2
4646
```
4747

48-
## Linux
48+
### Linux
4949

5050
For Linux, we rely on the codacy-cli.sh script in the root. To download the CLI, run:
5151

@@ -66,7 +66,7 @@ Before running the analysis, install the specified tools:
6666
codacy-cli install
6767
```
6868

69-
### Run Analysis
69+
## Run Analysis
7070

7171
To run ESLint and output the results to the terminal:
7272

@@ -102,6 +102,16 @@ Some behaviors have changed with the new updates of the CLI. To rely on a specif
102102
export CODACY_CLI_V2_VERSION="1.0.0-main.133.3607792"
103103
```
104104

105-
### Example Repository
105+
## Example Repository
106106

107107
As an example, you can check https://github.com/troubleshoot-codacy/eslint-test-examples for a repository that has an action relying on this CLI.
108+
109+
## Troubleshooting
110+
111+
#### Errors related to `docker-credential-osxkeychain` not found when running analysis
112+
113+
Install the docker credential helper. For example, in MacOS:
114+
115+
```bash
116+
brew install docker-credential-helper
117+
```

0 commit comments

Comments
 (0)