Skip to content

Commit 67503c7

Browse files
committed
readme: improve
1 parent 832a5f0 commit 67503c7

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# golangci-lint-action
22

3-
Work in progress
3+
![docker image](https://github.com/golangci/golangci-lint-action/workflows/docker%20image/badge.svg)
4+
5+
Action that runs [golangci-lint](https://github.com/golangci/golangci-lint) and reports issues from linters.
6+
7+
You can put `.github/workflows/lint.yml` with following contents:
8+
```yaml
9+
name: golangci
10+
on: [push]
11+
jobs:
12+
golangci:
13+
name: lint
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Check out code into the Go module directory
17+
uses: actions/checkout@v1
18+
- name: golangci-lint
19+
uses: golangci/[email protected]
20+
with:
21+
github_token: ${{ secrets.github_token }}
22+
23+
```
424

525
Based on [reviewdog action](https://github.com/reviewdog/action-golangci-lint).

0 commit comments

Comments
 (0)