Skip to content

Commit ca8befd

Browse files
committed
doc: improve options documentation
1 parent d9c9b53 commit ca8befd

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

+24-8
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,9 @@ You will also likely need to add the following `.gitattributes` file to ensure t
100100

101101
## Options
102102

103-
`version`: (required) The version of golangci-lint to use.
103+
### `version`
104+
105+
(required) The version of golangci-lint to use.
104106
* When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
105107
* When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
106108

@@ -111,7 +113,9 @@ with:
111113
# ...
112114
```
113115

114-
`install-mode`: (optional) The mode to install golangci-lint.
116+
### `install-mode`
117+
118+
(optional) The mode to install golangci-lint.
115119
It can be `binary` or `goinstall`.
116120
The default value is `binary`.
117121

@@ -122,7 +126,9 @@ with:
122126
# ...
123127
```
124128

125-
`only-new-issues`: (optional) Show only new issues.
129+
### `only-new-issues`
130+
131+
(optional) Show only new issues.
126132
If you are using `merge_group` event (merge queue) you should add the option `fetch-depth: 0` to `actions/checkout` step.
127133
The default value is `false`.
128134

@@ -133,7 +139,9 @@ with:
133139
# ...
134140
```
135141

136-
`working-directory`: (optional) working directory, useful for monorepos.
142+
### `working-directory`
143+
144+
(optional) working directory, useful for monorepos.
137145

138146
```yml
139147
uses: golangci/golangci-lint-action@v5
@@ -142,7 +150,9 @@ with:
142150
# ...
143151
```
144152

145-
`skip-cache`: (optional) If set to `true`, then all caching functionality will be completely disabled,
153+
### `skip-cache`
154+
155+
(optional) If set to `true`, then all caching functionality will be completely disabled,
146156
takes precedence over all other caching options.
147157
The default value is `false`.
148158

@@ -153,7 +163,9 @@ with:
153163
# ...
154164
```
155165

156-
`skip-save-cache`: (optional) If set to `true`, caches will not be saved, but they may still be restored, required `skip-cache: false`.
166+
### `skip-save-cache`
167+
168+
(optional) If set to `true`, caches will not be saved, but they may still be restored, required `skip-cache: false`.
157169
The default value is `false`.
158170

159171
```yml
@@ -163,7 +175,9 @@ with:
163175
# ...
164176
```
165177

166-
`annotations`: (optional) To enable/disable GitHub Action annotations.
178+
### `annotations`
179+
180+
(optional) To enable/disable GitHub Action annotations.
167181
If disabled (`false`), the output format(s) will follow the golangci-lint configuration file and use the same default as golangci-lint (i.e. `colored-line-number`).
168182
https://golangci-lint.run/usage/configuration/#output-configuration
169183
The default value is `true`.
@@ -175,7 +189,9 @@ with:
175189
# ...
176190
```
177191

178-
`args`: (optional) golangci-lint command line arguments.
192+
### `args`
193+
194+
(optional) golangci-lint command line arguments.
179195
Note: By default, the `.golangci.yml` file should be at the root of the repository.
180196
The location of the configuration file can be changed by using `--config=`
181197

0 commit comments

Comments
 (0)