actions/golangci-lint-action
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: improve readme

Browse Source
This commit is contained in:
Fernandez Ludovic 2024-05-07 02:02:33 +02:00
parent 23faadfdeb
commit 5815a4b917
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -48,7 +48,7 @@ jobs:
with: with:
go-version: '1.22' go-version: '1.22'
- name: golangci-lint - name: golangci-lint
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
version: latest version: latest
``` ```
@ -90,7 +90,7 @@ jobs:
with: with:
go-version: ${{ matrix.go }} go-version: ${{ matrix.go }}
- name: golangci-lint - name: golangci-lint
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
version: latest version: latest
``` ```
@ -113,7 +113,7 @@ The version of golangci-lint to use.
* When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit. * When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
```yml ```yml
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
version: latest version: latest
# ... # ...
@ -128,7 +128,7 @@ The mode to install golangci-lint: it can be `binary` or `goinstall`.
The default value is `binary`. The default value is `binary`.
```yml ```yml
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
install-mode: "goinstall" install-mode: "goinstall"
# ... # ...
@ -143,7 +143,7 @@ Show only new issues.
The default value is `false`. The default value is `false`.
```yml ```yml
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
only-new-issues: true only-new-issues: true
# ... # ...
@ -161,7 +161,7 @@ with:
Working directory, useful for monorepos. Working directory, useful for monorepos.
```yml ```yml
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
working-directory: somedir working-directory: somedir
# ... # ...
@ -177,7 +177,7 @@ takes precedence over all other caching options.
The default value is `false`. The default value is `false`.
```yml ```yml
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
skip-cache: true skip-cache: true
# ... # ...
@ -192,7 +192,7 @@ If set to `true`, caches will not be saved, but they may still be restored, requ
The default value is `false`. The default value is `false`.
```yml ```yml
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
skip-save-cache: true skip-save-cache: true
# ... # ...
@ -207,7 +207,7 @@ Periodically invalidate the cache every `cache-invalidation-interval` days to en
The default value is `7`. The default value is `7`.
```yml ```yml
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
cache-invalidation-interval: 15 cache-invalidation-interval: 15
# ... # ...
@ -230,7 +230,7 @@ https://golangci-lint.run/usage/configuration/#output-configuration
The default value is `false`. The default value is `false`.
```yml ```yml
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
problem-matchers: true problem-matchers: true
# ... # ...
@ -246,7 +246,7 @@ Note: By default, the `.golangci.yml` file should be at the root of the reposito
The location of the configuration file can be changed by using `--config=` The location of the configuration file can be changed by using `--config=`
```yml ```yml
uses: golangci/golangci-lint-action@v5 uses: golangci/golangci-lint-action@v6
with: with:
args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0 args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
# ... # ...