docs: improve option examples

golangci · May 26, 2024 · 725e015 · 725e015
1 parent 32b7e66
commit 725e015
Showing 1 changed file with 94 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -56,7 +56,8 @@ jobs:
 We recommend running this action in a job separate from other jobs (`go test`, etc.)
 because different jobs [run in parallel](https://help.github.com/en/actions/getting-started-with-github-actions/core-concepts-for-github-actions#job).
 
-### Multiple OS Support
+<details>
+<summary>Multiple OS Support</summary>
 
 If you need to run linters for specific operating systems, you will need to use the action `>=v2`.
 
@@ -80,7 +81,7 @@ jobs:
   golangci:
     strategy:
       matrix:
-        go: ['1.22']
+        go: [stable]
         os: [ubuntu-latest, macos-latest, windows-latest]
     name: lint
     runs-on: ${{ matrix.os }}
@@ -101,6 +102,8 @@ You will also likely need to add the following `.gitattributes` file to ensure t
 *.go text eol=lf
 ```
 
+</details>
+
 ## Options
 
 ### `version`
@@ -112,13 +115,18 @@ The version of golangci-lint to use.
 * When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
 * When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
 
+<details>
+<summary>Example</summary>
+
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
   version: v1.58
   # ...
 ```
 
+</details>
+
 ### `install-mode`
 
 (optional)
@@ -127,146 +135,191 @@ The mode to install golangci-lint: it can be `binary` or `goinstall`.
 
 The default value is `binary`.
 
+<details>
+<summary>Example</summary>
+
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
   install-mode: "goinstall"
   # ...
 ```
 
-### `only-new-issues`
+</details>
+
+### `github-token`
 
 (optional)
 
-Show only new issues.
+When using `only-new-issues` option, the GitHub API is used, so a token is required.
 
-The default value is `false`.
+By default, it uses the `github.token` from the action.
+
+<details>
+<summary>Example</summary>
 
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
-  only-new-issues: true
+  github-token: xxx
   # ...
 ```
 
-* `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`.
-* `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`.
-* `merge_group`: the action gets the diff by using `--new-from-rev` option (relies on git).
-   You should add the option `fetch-depth: 0` to `actions/checkout` step.
+</details>
 
-### `github-token`
+### `only-new-issues`
 
 (optional)
 
-When using `only-new-issues` option, the GitHub API is used, so a token is required.
+Show only new issues.
 
-By default, it uses the `github.token` from the action.
+The default value is `false`.
+
+* `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`.
+* `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`.
+* `merge_group`: the action gets the diff by using `--new-from-rev` option (relies on git).
+  You should add the option `fetch-depth: 0` to `actions/checkout` step.
+
+<details>
+<summary>Example</summary>
 
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
-  github-token: xxx
+  only-new-issues: true
   # ...
 ```
 
+</details>
+
 ### `working-directory`
 
 (optional)
 
 Working directory, useful for monorepos.
 
+<details>
+<summary>Example</summary>
+
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
   working-directory: somedir
   # ...
 ```
 
-### `skip-cache`
+</details>
+
+### `args`
 
 (optional)
 
-If set to `true`, then all caching functionality will be completely disabled,
-takes precedence over all other caching options.
+golangci-lint command line arguments.
 
-The default value is `false`.
+Note: By default, the `.golangci.yml` file should be at the root of the repository.
+The location of the configuration file can be changed by using `--config=`
+
+<details>
+<summary>Example</summary>
 
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
-  skip-cache: true
+  args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
   # ...
 ```
 
-### `skip-save-cache`
+</details>
+
+### `problem-matchers`
 
 (optional)
 
-If set to `true`, caches will not be saved, but they may still be restored, required `skip-cache: false`.
+Force the usage of the embedded problem matchers.
+
+By default, the [problem matcher of Go (`actions/setup-go`)](https://github.com/actions/setup-go/blob/main/matchers.json) already handles the golangci-lint output (`colored-line-number`).
+
+Works only with `colored-line-number` (the golangci-lint default).
+
+https://golangci-lint.run/usage/configuration/#output-configuration
 
 The default value is `false`.
 
+<details>
+<summary>Example</summary>
+
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
-  skip-save-cache: true
+  problem-matchers: true
   # ...
 ```
 
-### `cache-invalidation-interval`
+</details>
+
+### `skip-cache`
 
 (optional)
 
-Periodically invalidate the cache every `cache-invalidation-interval` days to ensure that outdated data is removed and fresh data is loaded.
+If set to `true`, then all caching functionality will be completely disabled,
+takes precedence over all other caching options.
 
-The default value is `7`.
+The default value is `false`.
+
+<details>
+<summary>Example</summary>
 
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
-  cache-invalidation-interval: 15
+  skip-cache: true
   # ...
 ```
 
-If set the number is `<= 0`, the cache will be always invalidate (Not recommended).
+</details>
 
-### `problem-matchers`
+### `skip-save-cache`
 
 (optional)
 
-Force the usage of the embedded problem matchers.
-
-By default, the [problem matcher of Go (`actions/setup-go`)](https://github.com/actions/setup-go/blob/main/matchers.json) already handles the golangci-lint output (`colored-line-number`). 
-
-Works only with `colored-line-number` (the golangci-lint default).
-
-https://golangci-lint.run/usage/configuration/#output-configuration
+If set to `true`, caches will not be saved, but they may still be restored, required `skip-cache: false`.
 
 The default value is `false`.
 
+<details>
+<summary>Example</summary>
+
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
-  problem-matchers: true
+  skip-save-cache: true
   # ...
 ```
 
-### `args`
+</details>
+
+### `cache-invalidation-interval`
 
 (optional)
 
-golangci-lint command line arguments.
+Periodically invalidate the cache every `cache-invalidation-interval` days to ensure that outdated data is removed and fresh data is loaded.
 
-Note: By default, the `.golangci.yml` file should be at the root of the repository.
-The location of the configuration file can be changed by using `--config=`
+The default value is `7`.
+
+If set the number is `<= 0`, the cache will be always invalidate (Not recommended).
+
+<details>
+<summary>Example</summary>
 
 ```yml
 uses: golangci/golangci-lint-action@v6
 with:
-  args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0
+  cache-invalidation-interval: 15
   # ...
 ```
 
+</details>
+
 ## Annotations
 
 Currently, GitHub parses the action's output and creates [annotations](https://github.blog/2018-12-14-introducing-check-runs-and-annotations/).