actions/golangci-lint-action
2
0
Fork 0
mirror of https://github.com/golangci/golangci-lint-action.git synced 2025-12-12 14:01:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: add experimental inside readme

Browse source
This commit is contained in:
Fernandez Ludovic 2025-11-21 04:27:06 +01:00
parent 988291118b
commit 921f54fb18
1 changed files with 42 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -275,6 +275,7 @@ You will also likely need to add the following `.gitattributes` file to ensure t
| [`skip-save-cache`](#skip-save-cache) | Don't save cache. |
| [`cache-invalidation-interval`](#cache-invalidation-interval) | Number of days before cache invalidation. |
| [`problem-matchers`](#problem-matchers) | Forces the usage of the embedded problem matchers. |
| [Experimental](#experimental) | Experimental options |
### Installation
@ -552,6 +553,47 @@ with:
</details>
### Experimental
The following options are experimental: those may or may not be supported in the future, and so they will be either converted into a dedicated option or removed.
List of comma-separated options.
<details>
<summary>Example</summary>
```yaml
uses: golangci/golangci-lint-action@v9
with:
experimental: "foo,bar"
```
</details>
#### `automatic-module-directories`
(optional)
This option will run golangci-lint in each module directory, useful for monorepos.
The automatic detection of modules uses the `working-directory` as the base directory if defined, otherwise the root directory.
> [!IMPORTANT]
> - The cache key will refer to the `working-directory` (if defined) because all the golangci-lint runs must use the same cache directory/key.
> - The version detection will only work if the project has a single module.
> - If the project has multiple modules, the custom build file must be located in the repository root ( or `working-directory`).
<details>
<summary>Example</summary>
```yaml
uses: golangci/golangci-lint-action@v9
with:
experimental: "automatic-module-directories"
```
</details>
## Annotations
Currently, GitHub parses the action's output and creates [annotations](https://github.blog/2018-12-14-introducing-check-runs-and-annotations/).