https://github.com/suzuki-shunsuke/github-action-golangci-lint
GitHub Actions for golangci-lint
https://github.com/suzuki-shunsuke/github-action-golangci-lint
Last synced: about 2 months ago
JSON representation
GitHub Actions for golangci-lint
- Host: GitHub
- URL: https://github.com/suzuki-shunsuke/github-action-golangci-lint
- Owner: suzuki-shunsuke
- License: mit
- Created: 2021-10-25T22:58:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:30:28.000Z (6 months ago)
- Last Synced: 2024-10-29T16:06:48.874Z (6 months ago)
- Language: Go
- Size: 243 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-action-golangci-lint
GitHub Actions for golangci-lint.
Run golangci-lint and notify the result with reviewdog.
This GitHub Actions does **not** install golangci-lint and reviewdog, so you have to install them in advance.
It allows to install tools outside this action.
We recommend [aqua](https://aquaproj.github.io/) to install them.
## Motivation
We know there are other GitHub Actions for golangci-lint.
They install golangci-lint automatically, but we would like to manage tools with [aqua](https://aquaproj.github.io/), which is a declarative CLI Version Manager written in Go.
By aqua, you can update tools continuously with Renovate very easily and use the same tool versions in both CI and your development environment.
This GitHub Actions does **not** install golangci-lint, so we can install them outside this action.
## Requirements
* [golangci-lint](https://golangci-lint.run/)
* [reviewdog](https://github.com/reviewdog/reviewdog)
## Example
```yaml
- uses: suzuki-shunsuke/[email protected]
```
```yaml
- uses: suzuki-shunsuke/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
working_directory: foo
timeout: 120s
```
## Inputs
### Required Inputs
Nothing.
### Optional Inputs
name | default value | description
--- | --- | ---
github_token | `github.token` | GitHub Access Token
working_directory | "" (current directory) | Woring Directory
timeout | "" (golangci-lint default timeout) | golangci-lint's `--timeout` option
## Outputs
Nothing.
## License
[MIT](LICENSE)