🐶 Automated code review tool integrated with any code analysis tools regardless of programming language
It's basically same as -reporter=github-pr-check except it works not only for Pull Request but also for commit. Also, it reports results outside Pull Request diff too.
Now reviewdog works well with too many annotations (like 50+ annotations).
09e366a .reviewdog.yml: use warning level for errcheck,revive,golagnci
010a353 Add 'set +o pipefail'
a99e92e Add GitHub Actions badge
c766996 Add a link to Marketplace
f9b30cf Add an article about GitHub Actions integration
1629231 Add docuemnt for github-check reporter
2e35779 Add example link for creating reviewdog GitHub Actions
5340ace Add https://github.com/reviewdog/action-shellcheck
eb4cf23 Add https://github.com/reviewdog/action-stylelint
22ef718 Add link to GitHub Actions page
09286c5 Add misspell action
dde68ca Add on: push GitHub Actions workflow and run reviewdog with -reporter=github-check
bf55b11 Add reviewdog/action-eslint
75ce74c Add reviewdog/action-misspell to README
43561fe Add reviewdog/action-vint
3b4056b Adds wemake-python-styleguide
31b7db5 Clean up code
dc2166d Create FUNDING.yml
9480036 Delete unused parameters.
d70c5a9 Do not set CreateCheckRunOptions.HeadBranch
6983ba1 Dump GitHub Context in on push workflow
b0d83cc Fill in title and summary
66cd989 Fix opencollective link
a1660a5 Fix typo
e715059 Fix typo
6dafb69 Fix typo. Thanks misspell!
bcaa694 Fix typos.
2d7e23e Implement new reporter: github-check
77f767a Improve document about reviewdog setup
79dcb9c Introduce reviewdog/action-golangci-lint
7942ea5 Introduce reviewdog/action-shellcheck
060879d Mention reviewdog/action-tflint in README
0138713 Merge pull request #292 from reviewdog/update-doc
509a53a Merge pull request #293 from reviewdog/introduce-action-golangci-lint
8f033c3 Merge pull request #294 from reviewdog/action-doc
434ad95 Merge pull request #295 from reviewdog/renovate/github.com-reviewdog-errorformat-digest
69af7f8 Merge pull request #296 from reviewdog/improve-setup-reviewdog
e9846ae Merge pull request #297 from reviewdog/action-test
b2e148b Merge pull request #298 from reviewdog/brew-doc
8e39390 Merge pull request #299 from reviewdog/action-misspell
265c5d5 Merge pull request #301 from reviewdog/add-article
9e0489d Merge pull request #302 from reviewdog/renovate/golang.org-x-net-digest
008a26f Merge pull request #304 from reviewdog/renovate/github.com-mgechev-revive-digest
e25041f Merge pull request #305 from reviewdog/renovate/mvdan.cc-unparam-digest
d1fdc0f Merge pull request #308 from reviewdog/renovate/github.com-reviewdog-errorformat-digest
b61b258 Merge pull request #309 from shopetan/master
1d6a3c8 Merge pull request #312 from reviewdog/arnottcr-go112
e0ea865 Merge pull request #314 from reviewdog/fix-go112
22b611d Merge pull request #315 from reviewdog/fix-circleci
7733d45 Merge pull request #317 from reviewdog/fix-travis
65220f9 Merge pull request #318 from reviewdog/readme-efm-playground
6b2b3c5 Merge pull request #319 from reviewdog/add-action-stylelint
df28470 Merge pull request #320 from reviewdog/action-vint
7508115 Merge pull request #321 from reviewdog/action-eslint
9218198 Merge pull request #323 from reviewdog/action-shellcheck
388dcbe Merge pull request #324 from reviewdog/add-action-shellcheck
72e9bb1 Merge pull request #325 from reviewdog/add-tflint
9759395 Merge pull request #327 from reviewdog/needless-branch
c3a0a3e Merge pull request #328 from reviewdog/check-limit
95ccf8d Merge pull request #330 from reviewdog/remainig-as-summary
456d77b Merge pull request #331 from reviewdog/golangci-warn
b7ebbbc Merge pull request #333 from reviewdog/github-check-reporter
81f21e9 Merge pull request #334 from reviewdog/fix-check-name
dbcfe58 Merge pull request #337 from reviewdog/renovate/gopkg.in-yaml.v2-2.x
8b17c72 Merge pull request #338 from reviewdog/renovate/golang.org-x-lint-digest
6608494 Merge pull request #339 from i-sevostyanov/cleanup
9deb7b8 Merge pull request #340 from mgrachev/cleanup-code
9704772 Merge pull request #341 from reviewdog/change-level
766c7d5 Merge pull request #342 from reviewdog/renovate/cloud.google.com-go-0.x
de12753 Merge pull request #344 from ruudk/patch-1
058da20 Merge pull request #346 from reviewdog/renovate/github.com-xanzy-go-gitlab-0.x
35d3577 Merge pull request #351 from reviewdog/renovate/github.com-justinas-nosurf-1.x
3367e88 Merge pull request #352 from ruudk/patch-1
4a85fae Merge pull request #358 from reviewdog/renovate/golang.org-x-oauth2-digest
7c54052 Merge pull request #361 from sobolevn/patch-1
45d5832 Merge pull request #362 from Streppel/bugfix/359
be7015d Merge pull request #363 from reviewdog/renovate/github.com-reviewdog-errorformat-digest
d8bd0bc Merge pull request #364 from reviewdog/tweak-github-check
ad98420 Merge pull request #365 from reviewdog/github-check-doc
4de9dbc Nil slice declaration.
af0a9cb Redudant import alias.
1cf1421 Redudant type conversion.
0a813bb Redundant parentheses.
f97a4e3 Remove debug code
86f47d1 Remove loginc from /_ah/warmup as go112 doesn't support it
58502b9 Remove needless GetPullRequest from interface
8c51c2e Remove redundant words from README
9d4d010 Remove variable from struct of github.CheckRunAnnotation
6f823e9 Remove variable from struct of github.CheckRunAnnotation
2989191 Revert "debug: add test code to test reviewdog"
9411005 Revert debug code
29ec8d5 Run Go Test on GitHub Actions
1a9cc54 Sort imports.
4e78a95 Support more than 50 annotations
83d1113 Update README to mention public github actions
54b2cfd Update REAME to mension the errorformat playground
8ad5124 Update document about GitHub Actions platform
035d4b9 Update github.com/mgechev/revive commit hash to 88015cc
eb4553c Update github.com/reviewdog/errorformat commit hash to 041eefc
8a05cae Update github.com/reviewdog/errorformat commit hash to 85eb1c3
692d3d2 Update github.com/reviewdog/errorformat commit hash to 8ffc512
c9df2f4 Update golang.org/x/lint commit hash to fdd1cda
e62accd Update golang.org/x/net commit hash to ef20fe5
a2d3671 Update golang.org/x/oauth2 commit hash to 5d9234d
3994ae9 Update module cloud.google.com/go to v0.49.0
1cec8ec Update module justinas/nosurf to v1
d1a87a0 Update module xanzy/go-gitlab to v0.22.1
b86b27e Update module yaml to v2.2.7
75ec5e1 Update mvdan.cc/unparam commit hash to 960b1ec
e84c9f7 Use %f|%l col %c| as basic format to avoid emoji rendering
44d981d add sudo
711f8a9 chagne tool name for golint with reviewdog on push
85a2d30 cienv: support on push GitHub Actions workflow
c840bb2 circleci: do not use || true
4aa17de debug: add test code
892822e debug: add test code to test reviewdog
c8b8567 doghouse: Do not pass nil TransactionOption
e0ab5a3 doghouse: Find installation from GitHub API and fix nil ptr exception
a9215ff doghouse: Use "Forwarded" header
28b0006 doghouse: rm app_dev.yaml which is no longer used
ffb49eb doghouse: use different http client to find Installation ID
044a97f fix test on GitHub Actions
0b0cab9 fixes #359
90b1c0a github-check: disable filtering for pull-request
35f495b github-pr-check: always fill check run name
221fb2e github-pr-check: fix missing name
eba86ca github-pr-review: add simple test for summary text
6bce37f github-pr-review: remove abuse
from a summary comment
3fd1a39 github-pr-review: use
Now, you can use -reporter=github-pr-check on GitHub Actions without installing reviewdog GitHub App! doc
on: [pull_request]
jobs:
reviewdog:
name: reviewdog
runs-on: ubuntu-latest
steps:
# ...
- name: Run reviewdog
env:
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
golint ./... | reviewdog -f=golint -reporter=github-pr-check
$ reviewdog -diff="git diff master" -runners=golint,govet
You can change report level for this github-pr-check reporter by level
field in config
file or -level
flag.
You can control GitHub status check result with this feature. (default: error)
Level | GitHub Status |
---|---|
info |
neutral |
warning |
neutral |
error |
failure |
runner:
golint:
cmd: golint ./...
errorformat:
- "%f:%l:%c: %m"
level: warning
govet:
cmd: go tool vet -all -shadowstrict .
If a CI service doesn't provide information such as Pull Request ID - reviewdog can guess it by branch name and commit SHA.
Just pass the flag guess
:
$ reviewdog -conf=.reviewdog.yml -reporter=github-pr-check -guess
265ed56 Add a sample image for github-pr-check reporter on GitHub Actions d001fef Add an example image for github-pr-check on GitHub Action from forked repo 981f7f6 Add installation instruction by homebrew 639aac3 Add more error context ec762c1 Add onetime backer image too 532f5c6 Add renovate.json b5c8762 Always update Travis IP addresses before checking ae311cd Change report level for reviewdog on GitHub Actions 4160c1b Check only when token is not present e5ba4b1 Do not re-use context after errgroup.WithContext fe4e46c Do not run GitLab CI for master branch 88360e3 Dump GitHub Context f9c043e Dump GitHub Event 2a2047d Fix GitHub event data 2ccd46a Fix isPr b7d2c93 Fix links 6cce5b3 Fix more typos. Thank you, @php-coder! 3f5ca42 Get Pull Request ID by branch name or commit hash 2f86f4d Implement -runners flag to specify which runners to run in conf file 04044d3 Introduce GitHub Actions for Go build f2a84e3 Introduce reviewdog on GitHub Action 0476178 Merge branch 'master' into bumpup_go-github 4361d2a Merge pull request #190 from mgrachev/feature/get-pull-request-id 5b48d1f Merge pull request #218 from reviewdog/tap-install c067ff0 Merge pull request #220 from reviewdog/update 75d25d2 Merge pull request #222 from ques0942/bumpup_go-github 03b5291 Merge pull request #224 from shogo82148/workaround-for-honnef.co-go-tools 7670e22 Merge pull request #227 from Code-Hex/master 449ea40 Merge pull request #228 from reviewdog/fix-gitlab 6141be1 Merge pull request #229 from reviewdog/renovate/configure 48fe9aa Merge pull request #230 from reviewdog/renovate/pin-dependencies bd8bdf8 Merge pull request #231 from reviewdog/renovate/golang.org-x-tools-digest eb365fd Merge pull request #232 from reviewdog/renovate-config b16b9cc Merge pull request #233 from reviewdog/renovate/github.com-reviewdog-errorformat-digest 21aa6e0 Merge pull request #236 from reviewdog/renovate/github.com-xanzy-go-gitlab-0.x 304919c Merge pull request #237 from reviewdog/renovate/textlint-11.x 428a8ae Merge pull request #238 from reviewdog/renovate/github.com-kylelemons-godebug-1.x 788b92f Merge pull request #248 from reviewdog/renovate/textlint-rule-no-dead-link-4.x fb17299 Merge pull request #250 from reviewdog/renovate/github.com-google-go-cmp-0.x 99fb028 Merge pull request #251 from shogo82148/lock-npm-pakcage 39fc104 Merge pull request #252 from shogo82148/go-mod-tidy 161973a Merge pull request #259 from reviewdog/renovate/github.com-google-go-github-v27-28.x dff1fc5 Merge pull request #262 from reviewdog/renovate/docker-circleci-golang-1.x 494112b Merge pull request #264 from Attsun1031/fix-typo 56b6bc1 Merge pull request #265 from arnottcr/modup d261e1d Merge pull request #267 from reviewdog/renovate/github.com-google-go-github-v28-28.x 430d5c5 Merge pull request #268 from reviewdog/renovate/golang.org-x-net-digest 098875c Merge pull request #270 from reviewdog/renovate/golang.org-x-sync-digest 6bcf94c Merge pull request #271 from reviewdog/haya14busa-patch-2 599674d Merge pull request #273 from reviewdog/reviewdog-on-github-actions 5a7a040 Merge pull request #275 from reviewdog/check-action 946b3e5 Merge pull request #281 from review-dog/support-fork-pr d12f712 Merge pull request #282 from reviewdog/update-travis-ip d5ce8c9 Merge pull request #283 from reviewdog/runners 9078b65 Merge pull request #284 from reviewdog/update-linter-mod ce0cffd Merge pull request #285 from reviewdog/go1.13 b8b3a24 Merge pull request #286 from reviewdog/github-actions-env e9c80d8 Merge pull request #287 from reviewdog/change-conclusion e991bfd Merge pull request #288 from reviewdog/renovate/golang.org-x-tools-digest 9af031c Merge pull request #289 from reviewdog/fix-gitlab-ci-master-build 0548fd7 Merge pull request #290 from reviewdog/fix-renovate-pin-cofig 2bf4e59 Merge pull request #291 from reviewdog/tidy bed8b3b Move renovate config file under .github dir 311f75f Pin dependencies bd64b4e Propagate level for project run for github-pr-check 13f6bf8 Remove CI_* envs from GitHub Actions config 53ee847 Remove needless CI_REPOSITORY 19f4207 Remove needless go get aaecd27 Rename report level to just "level" 69b80b9 Report results to stdout when Check API is not avaialble especially for GitHub Actions a3f95bb Report the # of results outside diff c8b2bbb Return error for empty response and add tests 12bc24a Specify github-pr-check-action for GitHub Action reviewdog config 385b10a Specify govet runner to for GitHub Actions 069af87 Stop using named return 011e861 Support Check API w/o Doghouse using GitHub Action token 0b61b62 Support GitHub Actions Environment c4be39a Support changing report level for github-pr-check reporter b6d18a9 Support re-run event 4e03c65 Support specifying report level from config file cfad248 Update README for -runners flag e81d719 Update circleci/golang Docker tag to v1.13 a578fca Update dependencies 6043589 Update dependencies 6be7b28 Update dependencies e5ae743 Update dependency textlint to v11 92ac2a8 Update dependency textlint-rule-no-dead-link to v4.4.4 1a06e5e Update document for level feature 2441f6a Update documents b22dcda Update errorformat 7f6b9d4 Update github.com/reviewdog/errorformat commit hash to b91f67e 20f1b5a Update golang.org/x/net commit hash to 24e19bd 292d29a Update golang.org/x/sync commit hash to cd5d95a 9d8fc9b Update golang.org/x/tools commit hash to 31e00f4 a2144ed Update golang.org/x/tools commit hash to 919acb9 e128d22 Update linter/go.mod b6720f0 Update module google/go-cmp to v0.3.1 d8c8b37 Update module google/go-github/v27 to v28 c059224 Update module google/go-github/v28 to v28.1.1 0bd627f Update module kylelemons/godebug to v1 102577d Update module xanzy/go-gitlab to v0.19.0 0f9e6ac Use ++ (report example) b600e7a Use -level=info for textlint 38709e7 Use -runners=golint for GitHub Actions db9143a Use :preserveSemverRanges for renovate bot cb23119 Use Go 1.13 c71c0ee Use github-pr-check reporter for GitHub Action flow too 2e8574b Use github.event.pull_request.head.sha as CI_COMMIT 7e5c5ad Use level in config file 644da56 Use neutral as default conclusion for Check API 25a455a Write document for github-pr-check reporter on GitHub Actions 856a5c2 add comment to IsInGitHubAction 337caca add go.mod and go.sum for CI tools 8402625 fix tests babf2b4 fix typo 5ec34d1 fix typo 63a853d fixup go.mod and go-github usage 04adf80 gitlab: Set GO111MODULE=on 202da5d gitlab: run only golint 418c8b5 go mod tidy 64d6ec9 lock the version of npm packages dbf0ebc simplify code cd486af tweak README ca97eed unused and gosimple are deprecated 2257fd7 update dependencies and go mod tidy ff2f920 upgrade module dependencies, remove indirects ba14be4 workaround for failing honnef.co/go/tools install
This release contains a few bug fixes and from this release, the installation method changed.
Example:
# Specify installation directory ($(go env GOPATH)/bin/) and version.
$ curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh| sh -s -- -b $(go env GOPATH)/bin [vX.Y.Z]
Also, we moved the repository under reviewdog organization and looking for maintainers (#196). This release contains a few improvement of workflow for org development, like deploy automation of doghouse server.
Added -reporter=gitlab-mr-discussion and -reporter=gitlab-mr-commit options.
$ export REVIEWDOG_GITLAB_API_TOKEN="<token>"
$ export GITLAB_API="https://example.gitlab.com/api/v4"
$ reviewdog -reporter=gitlab-mr-discussion
GitLab CI is also supported.
Store REVIEWDOG_GITLAB_API_TOKEN
in GitLab CI variable.
reviwedog:
script:
- reviewdog -reporter=gitlab-mr-discussion
# Or
- reviewdog -reporter=gitlab-mr-commit
GitLab support (-reporter=gitlab-mr-commit
) is implemenbed by @nakatanakatana and @masamotod :+1:
reviewdog with GitHub Checks feature. https://help.github.com/articles/about-status-checks/#checks
REVIEWDOG_TOKEN
or run reviewdog CLI in trusted CI providers.https://reviewdog.app/gh/{owner}/{repo-name}
.$ export REVIEWDOG_TOKEN="xxxxx"
$ reviewdog -conf=.reviewdog.yml -reporter=github-pr-check
Deprecate -ci flag #132.
Use -reporter
flag instead.
Example:
$ reviewdog -ci=travis
=>
$ reviewdog -reporter=github-pr-review
0.9.7 (2017-08-09)
As of version 0.9.7, reviewdog completely switched to use new Pull Reqeust Review Comments API including GitHub Enterprise. If your GitHub Enterprise version is too low to use this new API, please use reviewdog version < 0.9.7
0.9.6 (2017-03-02)
Support running reviewdog in sub directory for CI (Supported GitHub & GitHub Enterprise)
e.g.
cd sub/dir && golint . | reviewdog -f=golint -ci=circleci