Skip to content

Commit e1ff6fb

Browse files
committed
docs: improve examples
1 parent 4145754 commit e1ff6fb

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,6 @@ The action runs [golangci-lint](https://github.com/golangci/golangci-lint) and r
2020

2121
If you value it, consider supporting us, we appreciate it! :heart:
2222

23-
## Compatibility
24-
25-
* `v6.0.0+` removes `annotations` option, removes the default output format (`github-actions`).
26-
* `v5.0.0+` removes `skip-pkg-cache` and `skip-build-cache` because the cache related to Go itself is already handled by `actions/setup-go`.
27-
* `v4.0.0+` requires an explicit `actions/setup-go` installation step before using this action: `uses: actions/setup-go@v5`.
28-
The `skip-go-installation` option has been removed.
29-
* `v2.0.0+` works with `golangci-lint` version >= `v1.28.3`
30-
* `v1.2.2` is deprecated due to we forgot to change the minimum version of `golangci-lint` to `v1.28.3` ([issue](https://github.com/golangci/golangci-lint-action/issues/39))
31-
* `v1.2.1` works with `golangci-lint` version >= `v1.14.0` ([issue](https://github.com/golangci/golangci-lint-action/issues/39))
32-
3323
## How to use
3424

3525
We recommend running this action in a job separate from other jobs (`go test`, etc.)
@@ -74,10 +64,6 @@ jobs:
7464
<details>
7565
<summary>Multiple OS Example</summary>
7666
77-
If you need to run linters for specific operating systems, you will need to use the action `>=v2`.
78-
79-
Here is a sample configuration file:
80-
8167
```yaml
8268
name: golangci-lint
8369
on:
@@ -119,6 +105,16 @@ You will also likely need to add the following `.gitattributes` file to ensure t
119105

120106
</details>
121107

108+
## Compatibility
109+
110+
* `v6.0.0+` removes `annotations` option, removes the default output format (`github-actions`).
111+
* `v5.0.0+` removes `skip-pkg-cache` and `skip-build-cache` because the cache related to Go itself is already handled by `actions/setup-go`.
112+
* `v4.0.0+` requires an explicit `actions/setup-go` installation step before using this action: `uses: actions/setup-go@v5`.
113+
The `skip-go-installation` option has been removed.
114+
* `v2.0.0+` works with `golangci-lint` version >= `v1.28.3`
115+
* `v1.2.2` is deprecated due to we forgot to change the minimum version of `golangci-lint` to `v1.28.3` ([issue](https://github.com/golangci/golangci-lint-action/issues/39))
116+
* `v1.2.1` works with `golangci-lint` version >= `v1.14.0` ([issue](https://github.com/golangci/golangci-lint-action/issues/39))
117+
122118
## Options
123119

124120
### `version`

0 commit comments

Comments
 (0)