Skip to content

Commit 9551b25

Browse files
authored
docs: typos and notes
1 parent f51fbec commit 9551b25

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ The action runs [golangci-lint](https://github.com/golangci/golangci-lint) and r
1212

1313
## Supporting Us
1414

15-
<!-- [![GitHub Sponsors](https://img.shields.io/badge/GitHub-Donate-blue?logo=github&style=for-the-badge)](https://github.com/sponsors/golangci) -->
15+
[![GitHub Sponsors](https://img.shields.io/badge/GitHub-Donate-blue?logo=github&style=for-the-badge)](https://github.com/sponsors/golangci)
1616
[![Open Collective backers and sponsors](https://img.shields.io/badge/OpenCollective-Donate-blue?logo=opencollective&style=for-the-badge)](https://opencollective.com/golangci-lint)
1717
[![Linter Authors](https://img.shields.io/badge/Linter_Authors-Donate-blue?style=for-the-badge)](https://golangci-lint.run/product/thanks/)
1818

1919
`golangci-lint` is a free and open-source project built by volunteers.
2020

21-
If you value it, consider supporting us, we appreciate it! :heart:
21+
If you value it, consider supporting us; we appreciate it! :heart:
2222

2323
## How to use
2424

@@ -251,7 +251,7 @@ You will also likely need to add the following `.gitattributes` file to ensure t
251251
* `v4.0.0+` requires an explicit `actions/setup-go` installation step before using this action: `uses: actions/setup-go@v5`.
252252
The `skip-go-installation` option has been removed.
253253
* `v2.0.0+` works with `golangci-lint` version >= `v1.28.3`
254-
* `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))
254+
* `v1.2.2` is deprecated because we forgot to change the minimum version of `golangci-lint` to `v1.28.3` ([issue](https://github.com/golangci/golangci-lint-action/issues/39))
255255
* `v1.2.1` works with `golangci-lint` version >= `v1.14.0` ([issue](https://github.com/golangci/golangci-lint-action/issues/39))
256256

257257
## Options
@@ -325,10 +325,10 @@ with:
325325

326326
This option is `true` by default.
327327

328-
If the GitHub Action detects configuration file the validation will be performed unless this option is set to `false`.
328+
If the GitHub Action detects a configuration file, the validation will be performed unless this option is set to `false`.
329329
If there is no configuration file, the validation is skipped.
330330

331-
The JSONSchema used to validate the configuration depends on the version of golangci-lint you are using.
331+
The JSON Schema used to validate the configuration depends on the version of golangci-lint you are using.
332332

333333
<details>
334334
<summary>Example</summary>
@@ -350,8 +350,8 @@ Show only new issues.
350350

351351
The default value is `false`.
352352

353-
* `pull_request` and `pull_request_target`: the action gets the diff of the PR content from the [GitHub API](https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#get-a-pull-request) and use it with `--new-from-patch`.
354-
* `push`: the action gets the diff of the push content (difference between commits before and after the push) from the [GitHub API](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#compare-two-commits) and use it with `--new-from-patch`.
353+
* `pull_request` and `pull_request_target`: the action gets the diff of the PR content from the [GitHub API](https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#get-a-pull-request) and uses it with `--new-from-patch`.
354+
* `push`: the action gets the diff of the push content (difference between commits before and after the push) from the [GitHub API](https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#compare-two-commits) and uses it with `--new-from-patch`.
355355
* `merge_group`: the action gets the diff by using `--new-from-rev` option (relies on git).
356356
You should add the option `fetch-depth: 0` to `actions/checkout` step.
357357

@@ -391,8 +391,12 @@ with:
391391

392392
golangci-lint command line arguments.
393393

394-
Note: By default, the `.golangci.yml` file should be at the root of the repository.
395-
The location of the configuration file can be changed by using `--config=`
394+
> [!NOTE]
395+
> By default, the `.golangci.yml` file should be at the root of the repository.
396+
> The location of the configuration file can be changed by using `--config=`.
397+
398+
> [!IMPORTANT]
399+
> Adding a `=` between the flag name and its value is important because the action parses the arguments on spaces.
396400

397401
<details>
398402
<summary>Example</summary>
@@ -459,7 +463,7 @@ with:
459463

460464
(optional)
461465

462-
If set to `true`, caches will not be saved, but they may still be restored, required `skip-cache: false`.
466+
If set to `true`, caches will not be saved, but they may still be restored, requiring `skip-cache: false`.
463467

464468
The default value is `false`.
465469

@@ -483,7 +487,7 @@ Periodically invalidate the cache every `cache-invalidation-interval` days to en
483487

484488
The default value is `7`.
485489

486-
If set the number is `<= 0`, the cache will be always invalidate (Not recommended).
490+
If the number is `<= 0`, the cache will always be invalidated (Not recommended).
487491

488492
<details>
489493
<summary>Example</summary>
@@ -518,7 +522,7 @@ permissions:
518522
pull-requests: read
519523
```
520524
521-
For annotations to work use the default format output (`text`) and either use `actions/setup-go` in the job or enable the internal [problem matchers](#problem-matchers).
525+
For annotations to work, use the default format output (`text`) and either use `actions/setup-go` in the job or enable the internal [problem matchers](#problem-matchers).
522526

523527
## Performance
524528

0 commit comments

Comments
 (0)