readme: improve
This commit is contained in:
parent
832a5f00c9
commit
67503c7b3d
22
README.md
22
README.md
@ -1,5 +1,25 @@
|
||||
# golangci-lint-action
|
||||
|
||||
Work in progress
|
||||

|
||||
|
||||
Action that runs [golangci-lint](https://github.com/golangci/golangci-lint) and reports issues from linters.
|
||||
|
||||
You can put `.github/workflows/lint.yml` with following contents:
|
||||
```yaml
|
||||
name: golangci
|
||||
on: [push]
|
||||
jobs:
|
||||
golangci:
|
||||
name: lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out code into the Go module directory
|
||||
uses: actions/checkout@v1
|
||||
- name: golangci-lint
|
||||
uses: golangci/golangci-lint-action@v0.0.2
|
||||
with:
|
||||
github_token: ${{ secrets.github_token }}
|
||||
|
||||
```
|
||||
|
||||
Based on [reviewdog action](https://github.com/reviewdog/action-golangci-lint).
|
||||
|
Loading…
x
Reference in New Issue
Block a user