expand readme with all optional inputs

This commit is contained in:
Marko Baricevic 2020-05-03 16:10:11 +02:00
parent 666cc9164e
commit 73809ef511
No known key found for this signature in database
GPG key ID: 1C1A5B44A0E4674D

View file

@ -5,6 +5,7 @@
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]
@ -17,6 +18,11 @@ jobs:
uses: actions/checkout@v1
- name: golangci-lint
uses: golangci/golangci-lint-action@v0.0.2
# with:
# github_token: ${{ secrets.github_token }} #Optional Default: ''
# flags: --timeout 30m (golang-ci-lint flags) #Optional Default: ''
# directory: Working Directory #Optional Default: ''
# format: Output format of issues #Optional Default: 'githu-actions'
```
Based on [reviewdog action](https://github.com/reviewdog/action-golangci-lint).