{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/483", "result": {"data":{"issuesJson":{"id":"161cc7da-05e3-50fd-bfd7-4fe6ba7685d9","title":"reviewdog/reviewdog: reviewdog 提供了一种通过轻松与任何 linter 工具集成来自动将审阅评论发布到代码托管服务（例如 GitHub）的方法。它使用 lint 工具的输出，并将其作为评论发布（如果发现的结果位于要审查的补丁的差异中）。","number":483,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposreviewdog/reviewdog
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n
\n \n \"reviewdog\"\n \n
\n

\n reviewdog - A code review dog who keeps your codebase healthy.\n

\n
\n \n \"LICENSE\"\n \n \n \"GoDoc\"\n \n \n \"releases\"\n \n \n \"nightly\n \n
\n
\n \n \"GitHub\n \n \n \"reviewdog\"\n \n \n \"release\"\n \n \"CircleCI\n \"Coverage\n \n
\n
\n \n \"GitLab\n \n \n \"action-bumpr\n \n \n \"Contributor\n \n \n \"GitHub\n \n \"Stars\"\n
\n
\n

reviewdog provides a way to post review comments to code hosting services,
\nsuch as GitHub, automatically by integrating with any linter tools with ease.
\nIt uses an output of lint tools and posts them as a comment if findings are in
\nthe diff of patches to review.

\n

reviewdog also supports running in the local environment to filter the output of lint tools
\nby diff.

\n

design doc

\n

Table of Contents

\n\n

\"github-pr-check
\n\"comment
\n\"commit
\n\"sample-comment.png\"
\n\"reviewdog-local-demo.gif\"

\n

Installation

\n
# Install the latest version. (Install it into ./bin/ by default).\n$ curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s\n\n# Specify installation directory ($(go env GOPATH)/bin/) and version.\n$ curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s -- -b $(go env GOPATH)/bin [vX.Y.Z]\n\n# In alpine linux (as it does not come with curl by default)\n$ wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s [vX.Y.Z]
\n

Nightly releases

\n

You can also use nightly reviewdog release
\nto try the latest reviewdog improvements every day!

\n
$ curl -sfL https://raw.githubusercontent.com/reviewdog/nightly/30fccfe9f47f7e6fd8b3c38aa0da11a6c9f04de7/install.sh | sh -s -- -b $(go env GOPATH)/bin
\n

GitHub Action: reviewdog/action-setup

\n
steps:\n- uses: reviewdog/action-setup@e04ffabe3898a0af8d0fb1af00c188831c4b5893 # v1.3.2\n  with:\n    reviewdog_version: latest # Optional. [latest,nightly,v.X.Y.Z]
\n

homebrew / linuxbrew

\n

You can also install reviewdog using brew:

\n
$ brew install reviewdog/tap/reviewdog\n$ brew upgrade reviewdog/tap/reviewdog
\n

Scoop on Windows

\n
> scoop install reviewdog\n
\n

Build with go install

\n
$ go install github.com/reviewdog/reviewdog/cmd/reviewdog@latest
\n

Input Format

\n

'errorformat'

\n

reviewdog accepts any compiler or linter result from stdin and parses it with
\nscan-f like 'errorformat',
\nwhich is the port of Vim's errorformat
\nfeature.

\n

For example, if the result format is {file}:{line number}:{column number}: {message},
\nerrorformat should be %f:%l:%c: %m and you can pass it as -efm arguments.

\n
$ golint ./...\ncomment_iowriter.go:11:6: exported type CommentWriter should have comment or be unexported\n$ golint ./... | reviewdog -efm=\"%f:%l:%c: %m\" -diff=\"git diff FETCH_HEAD\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
namedescription
%ffile name
%lline number
%ccolumn number
%merror message
%%the single '%' character
......
\n

Please see reviewdog/errorformat
\nand :h errorformat
\nif you want to deal with a more complex output. 'errorformat' can handle more
\ncomplex output like a multi-line error message.

\n

You can also try errorformat on the Playground!

\n

With this 'errorformat' feature, reviewdog can support any tool output with ease.

\n

Available pre-defined 'errorformat'

\n

But, you don't have to write 'errorformat' in many cases. reviewdog supports
\npre-defined errorformat for major tools.

\n

You can find available errorformat name by reviewdog -list and you can use it
\nwith -f={name}.

\n
$ reviewdog -list\ngolint          linter for Go source code                                       - https://github.com/golang/lint\ngovet           Vet examines Go source code and reports suspicious problems     - https://golang.org/cmd/vet/\nsbt             the interactive build tool                                      - http://www.scala-sbt.org/\n...
\n
$ golint ./... | reviewdog -f=golint -diff=\"git diff FETCH_HEAD\"
\n

You can add supported pre-defined 'errorformat' by contributing to reviewdog/errorformat

\n

Reviewdog Diagnostic Format (RDFormat)

\n

reviewdog supports Reviewdog Diagnostic Format (RDFormat) as a
\ngeneric diagnostic format and it supports both rdjson and
\nrdjsonl formats.

\n

This rdformat supports rich features like multiline ranged comments, severity,
\nrule code with URL, and code suggestions.

\n
$ <linter> | <convert-to-rdjson> | reviewdog -f=rdjson -reporter=github-pr-review\n# or\n$ <linter> | <convert-to-rdjsonl> | reviewdog -f=rdjsonl -reporter=github-pr-review
\n

Example: ESLint with RDFormat

\n

\"eslint

\n

You can use eslint-formatter-rdjson
\nto output rdjson as eslint output format.

\n
$ npm install --save-dev eslint-formatter-rdjson\n$ eslint -f rdjson . | reviewdog -f=rdjson -reporter=github-pr-review
\n

Or you can also use reviewdog/action-eslint for GitHub Actions.

\n

Diff

\n

\"reviewdog

\n

reviewdog supports diff (unified format) as an input format especially useful
\nfor code suggestions.
\nreviewdog can integrate with any code suggestions tools or formatters to report suggestions.

\n

-f.diff.strip: option for -f=diff: strip NUM leading components from diff file names (equivalent to 'patch -p') (default is 1 for git diff) (default 1)

\n
$ <any-code-fixer/formatter> # e.g. eslint --fix, gofmt\n$ TMPFILE=$(mktemp)\n$ git diff >\"${TMPFILE}\"\n$ git stash -u && git stash drop\n$ reviewdog -f=diff -f.diff.strip=1 -reporter=github-pr-review < \"${TMPFILE}\"
\n

Or you can also use reviewdog/action-suggester for GitHub Actions.

\n

If diagnostic tools support diff output format, you can pipe the diff directly.

\n
$ gofmt -s -d . | reviewdog -name=\"gofmt\" -f=diff -f.diff.strip=0 -reporter=github-pr-review\n$ shellcheck -f diff $(shfmt -f .) | reviewdog -f=diff
\n

checkstyle format

\n

reviewdog also accepts checkstyle XML format as well.
\nIf the linter supports checkstyle format as a report format, you can use
\n-f=checkstyle instead of using 'errorformat'.

\n
# Local\n$ eslint -f checkstyle . | reviewdog -f=checkstyle -diff=\"git diff\"\n\n# CI (overwrite tool name which is shown in review comment by -name arg)\n$ eslint -f checkstyle . | reviewdog -f=checkstyle -name=\"eslint\" -reporter=github-check
\n

Also, if you want to pass other Json/XML/etc... format to reviewdog, you can write a converter.

\n
$ <linter> | <convert-to-checkstyle> | reviewdog -f=checkstyle -name=\"<linter>\" -reporter=github-pr-check
\n

SARIF format

\n

reviewdog supports SARIF 2.1.0 JSON format.
\nYou can use reviewdog with -f=sarif option.

\n
# Local\n$ eslint -f @microsoft/eslint-formatter-sarif . | reviewdog -f=sarif -diff=\"git diff\"
\n

Code Suggestions

\n

\"eslint
\n\"reviewdog

\n

reviewdog supports code suggestions feature with rdformat or diff input.
\nYou can also use reviewdog/action-suggester for GitHub Actions.

\n

reviewdog can suggest code changes along with diagnostic results if a diagnostic tool supports code suggestions data.
\nYou can integrate reviewdog with any code fixing tools and any code formatter with diff input as well.

\n

Code Suggestions Support Table

\n

Note that not all reporters provide support for code suggestions.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
-reporterSuggestion support
localNO [1]
github-checkNO [2]
github-pr-checkNO [2]
github-annotationsNO [2]
github-pr-annotationsNO [2]
github-pr-reviewOK
gitlab-mr-discussionOK
gitlab-mr-commitNO [2]
gerrit-change-reviewNO [1]
bitbucket-code-reportNO [2]
gitea-pr-reviewNO [2]
\n\n

reviewdog config file

\n

reviewdog can also be controlled via the .reviewdog.yml configuration file instead of \"-f\" or \"-efm\" arguments.

\n

With .reviewdog.yml, you can run the same commands for both CI service and local
\nenvironment including editor integration with ease.

\n

.reviewdog.yml

\n
runner:\n  <tool-name>:\n    cmd: <command> # (required)\n    errorformat: # (optional if you use `format`)\n      - <list of errorformat>\n    format: <format-name> # (optional if you use `errorformat`. e.g. golint,rdjson,rdjsonl)\n    name: <tool-name> # (optional. you can overwrite <tool-name> defined by runner key)\n    level: <level> # (optional. same as -level flag. [info,warning,error])\n\n  # examples\n  golint:\n    cmd: golint ./...\n    errorformat:\n      - \"%f:%l:%c: %m\"\n    level: warning\n  govet:\n    cmd: go vet -all .\n    format: govet\n  your-awesome-linter:\n    cmd: awesome-linter run\n    format: rdjson\n    name: AwesomeLinter
\n
$ reviewdog -diff=\"git diff FETCH_HEAD\"\nproject/run_test.go:61:28: [golint] error strings should not end with punctuation\nproject/run.go:57:18: [errcheck]        defer os.Setenv(name, os.Getenv(name))\nproject/run.go:58:12: [errcheck]        os.Setenv(name, \"\")\n# You can use -runners to run only specified runners.\n$ reviewdog -diff=\"git diff FETCH_HEAD\" -runners=golint,govet\nproject/run_test.go:61:28: [golint] error strings should not end with punctuation\n# You can use -conf to specify config file path.\n$ reviewdog -conf=./.reviewdog.yml -reporter=github-pr-check
\n

Output format for project config based run is one of the following formats.

\n\n

Reporters

\n

reviewdog can report results both in the local environment and review services as
\ncontinuous integration.

\n

Reporter: Local (-reporter=local) [default]

\n

reviewdog can find newly introduced findings by filtering linter results
\nusing diff. You can pass the diff command as -diff arg.

\n
$ golint ./... | reviewdog -f=golint -diff=\"git diff FETCH_HEAD\"
\n

Reporter: GitHub PR Checks (-reporter=github-pr-check)

\n

\"github-pr-check
\n\"github-pr-check

\n

github-pr-check reporter reports results to GitHub Checks.

\n

You can change the report level for this reporter by level field in config
\nfile or -level flag. You can control GitHub status
\ncheck results with this feature. (default: error)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
LevelGitHub Status
infoneutral
warningneutral
errorfailure
\n

There are two options to use this reporter.

\n

Option 1) Run reviewdog from GitHub Actions w/ secrets.GITHUB_TOKEN

\n

Example: .github/workflows/reviewdog.yml

\n
- name: Run reviewdog\n  env:\n    REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n  run: |\n    golint ./... | reviewdog -f=golint -reporter=github-pr-check
\n

See GitHub Actions section too. You can also use public
\nreviewdog GitHub Actions.

\n

Option 2) Install reviewdog GitHub Apps

\n

reviewdog CLI sends a request to reviewdog GitHub App server and the server post
\nresults as GitHub Checks, because Check API is only supported for GitHub App and
\nGitHub Actions.

\n
    \n
  1. Install reviewdog Apps. https://github.com/apps/reviewdog
    2. \n
  2. Set REVIEWDOG_TOKEN or run reviewdog CLI in trusted CI providers.
    3. \n
\n\n
$ export REVIEWDOG_TOKEN=\"<token>\"\n$ reviewdog -reporter=github-pr-check
\n

Note: Token is not required if you run reviewdog in Travis or AppVeyor.

\n

Caution

\n

As described above, github-pr-check reporter with Option 2 depends on
\nreviewdog GitHub App server.
\nThe server is running with haya14busa's pocket money for now and I may break
\nthings, so I cannot ensure that the server is running 24h and 365 days.

\n

UPDATE: Started getting support by opencollective
\nand GitHub sponsor.
\nSee Supporting reviewdog

\n

You can use github-pr-review reporter or use run reviewdog under GitHub Actions
\nif you don't want to depend on reviewdog server.

\n

Reporter: GitHub Checks (-reporter=github-check)

\n

It's basically the same as -reporter=github-pr-check except it works not only for
\nPull Request but also for commit.

\n

\"sample

\n

You can create reviewdog badge for this reporter.

\n

Reporter: GitHub PullRequest review comment (-reporter=github-pr-review)

\n

\"sample-comment.png\"

\n

github-pr-review reporter reports results to GitHub PullRequest review comments
\nusing GitHub Personal API Access Token.
\nGitHub Enterprise is supported too.

\n\n
$ export REVIEWDOG_GITHUB_API_TOKEN=\"<token>\"\n$ reviewdog -reporter=github-pr-review
\n

For GitHub Enterprise, set the API endpoint by an environment variable.

\n
$ export GITHUB_API=\"https://example.githubenterprise.com/api/v3/\"\n$ export REVIEWDOG_INSECURE_SKIP_VERIFY=true # set this as you need to skip verifying SSL
\n

See GitHub Actions section too if you can use GitHub
\nActions. You can also use public reviewdog GitHub Actions.

\n

Reporter: GitHub Annotations (-reporter=github-annotations)

\n

github-annotations uses the GitHub Actions annotation format to output errors
\nand warnings to stdout e.g.

\n
::error line=11,col=41,file=app/index.md::[vale] reported by reviewdog 🐶%0A[demo.Spelling] Did you really mean 'boobarbaz'?%0A%0ARaw Output:%0A{\"message\": \"[demo.Spelling] Did you really mean 'boobarbaz'?\", \"location\": {\"path\": \"app/index.md\", \"range\": {\"start\": {\"line\": 11, \"column\": 41}}}, \"severity\": \"ERROR\"}\n
\n

This reporter requires a valid GitHub API token to generate a diff, but will not
\nuse the token to report errors.

\n

Reporter: GitHub PR Annotations (-reporter=github-pr-annotations)

\n

Same as github-annotations but only works for Pull Requests.

\n

Reporter: GitLab MergeRequest discussions (-reporter=gitlab-mr-discussion)

\n

\"gitlab-mr-discussion

\n

Required GitLab version: >= v10.8.0

\n

gitlab-mr-discussion reporter reports results to GitLab MergeRequest discussions using
\nGitLab Personal API Access token.
\nGet the token with api scope from https://gitlab.com/profile/personal_access_tokens.

\n
$ export REVIEWDOG_GITLAB_API_TOKEN=\"<token>\"\n$ reviewdog -reporter=gitlab-mr-discussion
\n

The CI_API_V4_URL environment variable, defined automatically by Gitlab CI (v11.7 onwards), will be used to find out the Gitlab API URL.

\n

Alternatively, GITLAB_API can also be defined, in which case it will take precedence over CI_API_V4_URL.

\n
$ export GITLAB_API=\"https://example.gitlab.com/api/v4\"\n$ export REVIEWDOG_INSECURE_SKIP_VERIFY=true # set this as you need to skip verifying SSL
\n

Reporter: GitLab MergeRequest commit (-reporter=gitlab-mr-commit)

\n

gitlab-mr-commit is similar to gitlab-mr-discussion reporter but reports results to each commit in GitLab MergeRequest.

\n

gitlab-mr-discussion is recommended, but you can use gitlab-mr-commit reporter
\nif your GitLab version is under v10.8.0.

\n
$ export REVIEWDOG_GITLAB_API_TOKEN=\"<token>\"\n$ reviewdog -reporter=gitlab-mr-commit
\n

Reporter: Gerrit Change review (-reporter=gerrit-change-review)

\n

gerrit-change-review reporter reports results to Gerrit Change using Gerrit Rest APIs.

\n

The reporter supports Basic Authentication and Git-cookie based authentication for reporting results.

\n

Set GERRIT_USERNAME and GERRIT_PASSWORD environment variables for basic authentication, and put GIT_GITCOOKIE_PATH for git cookie-based authentication.

\n
$ export GERRIT_CHANGE_ID=changeID\n$ export GERRIT_REVISION_ID=revisionID\n$ export GERRIT_BRANCH=master\n$ export GERRIT_ADDRESS=http://<gerrit-host>:<gerrit-port>\n$ reviewdog -reporter=gerrit-change-review
\n

Reporter: Bitbucket Code Insights Reports (-reporter=bitbucket-code-report)

\n

\"bitbucket-code-report\"
\n\"bitbucket-code-annotations\"

\n

bitbucket-code-report generates the annotated
\nBitbucket Code Insights report.

\n

For now, only the no-filter mode is supported, so the whole project is scanned on every run.
\nReports are stored per commit and can be viewed per commit from Bitbucket Pipelines UI or
\nin Pull Request. In the Pull Request UI affected code lines will be annotated in the diff,
\nas well as you will be able to filter the annotations by This pull request or All.

\n

If running from Bitbucket Pipelines, no additional configuration is needed (even credentials).
\nIf running locally or from some other CI system you would need to provide Bitbucket API credentials:

\n\n
$ export BITBUCKET_USER=\"my_user\"\n$ export BITBUCKET_PASSWORD=\"my_password\"\n$ reviewdog -reporter=bitbucket-code-report
\n

To post a report to the Bitbucket Server use BITBUCKET_SERVER_URL variable:

\n
$ export BITBUCKET_USER=\"my_user\"\n$ export BITBUCKET_PASSWORD=\"my_password\"\n$ export BITBUCKET_SERVER_URL=\"https://bitbucket.my-company.com\"\n$ reviewdog -reporter=bitbucket-code-report
\n

Supported CI services

\n

GitHub Actions

\n

Example: .github/workflows/reviewdog.yml

\n
name: reviewdog\non: [pull_request]\njobs:\n  reviewdog:\n    name: reviewdog\n    runs-on: ubuntu-latest\n    steps:\n      # ...\n      - uses: reviewdog/action-setup@e04ffabe3898a0af8d0fb1af00c188831c4b5893 # v1.3.2\n        with:\n          reviewdog_version: latest # Optional. [latest,nightly,v.X.Y.Z]\n      - name: Run reviewdog\n        env:\n          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        run: |\n          reviewdog -reporter=github-pr-check -runners=golint,govet\n          # or\n          reviewdog -reporter=github-pr-review -runners=golint,govet
\n
\nExample (github-check reporter):\n

.github/workflows/reviewdog

\n

Only github-check reporter can run on the push event too.

\n
name: reviewdog (github-check)\non:\n  push:\n    branches:\n      - master\n  pull_request:\n\njobs:\n  reviewdog:\n    name: reviewdog\n    runs-on: ubuntu-latest\n    steps:\n      # ...\n      - name: Run reviewdog\n        env:\n          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        run: |\n          reviewdog -reporter=github-check -runners=golint,govet
\n
\n

Public Reviewdog GitHub Actions

\n

You can use public GitHub Actions to start using reviewdog with ease! 🎉 ▶️ 🎉

\n\n

... and more on GitHub Marketplace.

\n

Missing actions? Check out reviewdog/action-template and create a new reviewdog action!

\n

Please open a Pull Request to add your created reviewdog actions here ✨.
\nI can also put your repositories under reviewdog org and co-maintain the actions.
\nExample: action-tflint.

\n

Graceful Degradation for Pull Requests from forked repositories

\n

\"Graceful

\n

GITHUB_TOKEN for Pull Requests from a forked repository doesn't have write
\naccess to Check API nor Review API due to GitHub Actions
\nrestriction.

\n

Instead, reviewdog uses Logging commands of GitHub
\nActions
\nto post results as
\nannotations
\nsimilar to github-pr-check reporter.

\n

Note that there is a limitation for annotations created by logging commands,
\nsuch as max # of annotations per run.
\nYou can check GitHub Actions log to see full results in such cases.

\n

reviewdog badge \"reviewdog\"

\n

As github-check reporter support running on commit, we can create reviewdog
\nGitHub Action badge
\nto check the result against master commit for example. 🎉

\n

Example:

\n
<!-- Replace <OWNER> and <REPOSITORY>. It assumes workflow name is \"reviewdog\" -->\n[![reviewdog](https://github.com/<OWNER>/<REPOSITORY>/workflows/reviewdog/badge.svg?branch=master&event=push)](https://github.com/<OWNER>/<REPOSITORY>/actions?query=workflow%3Areviewdog+event%3Apush+branch%3Amaster)\n
\n

Travis CI

\n

Travis CI (-reporter=github-pr-check)

\n

If you use -reporter=github-pr-check in Travis CI, you don't need to set REVIEWDOG_TOKEN.

\n

Example:

\n
install:\n  - mkdir -p ~/bin/ && export PATH=\"~/bin/:$PATH\"\n  - curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh| sh -s -- -b ~/bin\n\nscript:\n  - reviewdog -conf=.reviewdog.yml -reporter=github-pr-check
\n

Travis CI (-reporter=github-pr-review)

\n

Store GitHub API token by travis encryption keys.

\n
$ gem install travis\n$ travis encrypt REVIEWDOG_GITHUB_API_TOKEN=<token> --add env.global
\n

Example:

\n
env:\n  global:\n    - secure: <token>\n\ninstall:\n  - mkdir -p ~/bin/ && export PATH=\"~/bin/:$PATH\"\n  - curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh| sh -s -- -b ~/bin\n\nscript:\n  - >-\n    golint ./... | reviewdog -f=golint -reporter=github-pr-review
\n

Examples

\n\n

Circle CI

\n

Store REVIEWDOG_GITHUB_API_TOKEN (or REVIEWDOG_TOKEN for github-pr-check) in
\nEnvironment variables - CircleCI

\n

.circleci/config.yml sample

\n
version: 2\njobs:\n  build:\n    docker:\n      - image: golang:latest\n    steps:\n      - checkout\n      - run: curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh| sh -s -- -b ./bin\n      - run: go vet ./... 2>&1 | ./bin/reviewdog -f=govet -reporter=github-pr-review\n\n      # Deprecated: prefer GitHub Actions to use github-pr-check reporter.\n      - run: go vet ./... 2>&1 | ./bin/reviewdog -f=govet -reporter=github-pr-check
\n

GitLab CI

\n

Store REVIEWDOG_GITLAB_API_TOKEN in GitLab CI variable.

\n

.gitlab-ci.yml sample

\n
reviewdog:\n  script:\n    - reviewdog -reporter=gitlab-mr-discussion\n    # Or\n    - reviewdog -reporter=gitlab-mr-commit
\n

Bitbucket Pipelines

\n

No additional configuration is needed.

\n

bitbucket-pipelines.yml sample

\n
pipelines:\n  default:\n    - step:\n        name: Reviewdog\n        image: golangci/golangci-lint:v1.31-alpine\n        script:\n          - wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | \n              sh -s -- -b $(go env GOPATH)/bin\n          - golangci-lint run --out-format=line-number ./... | reviewdog -f=golangci-lint -reporter=bitbucket-code-report
\n

Common (Jenkins, local, etc...)

\n

You can use reviewdog to post review comments from anywhere with following
\nenvironment variables.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
namedescription
CI_PULL_REQUESTPull Request number (e.g. 14)
CI_COMMITSHA1 for the current build
CI_REPO_OWNERrepository owner (e.g. \"reviewdog\" for https://github.com/reviewdog/errorformat)
CI_REPO_NAMErepository name (e.g. \"errorformat\" for https://github.com/reviewdog/errorformat)
CI_BRANCH[optional] branch of the commit
\n
$ export CI_PULL_REQUEST=14\n$ export CI_REPO_OWNER=haya14busa\n$ export CI_REPO_NAME=reviewdog\n$ export CI_COMMIT=$(git rev-parse HEAD)
\n

and set a token if required.

\n
$ REVIEWDOG_TOKEN=\"<token>\"\n$ REVIEWDOG_GITHUB_API_TOKEN=\"<token>\"\n$ REVIEWDOG_GITLAB_API_TOKEN=\"<token>\"
\n

If a CI service doesn't provide information such as Pull Request ID - reviewdog can guess it by a branch name and commit SHA.
\nJust pass the flag guess:

\n
$ reviewdog -conf=.reviewdog.yml -reporter=github-pr-check -guess
\n

Jenkins with GitHub pull request builder plugin

\n\n
$ export CI_PULL_REQUEST=${ghprbPullId}\n$ export CI_REPO_OWNER=haya14busa\n$ export CI_REPO_NAME=reviewdog\n$ export CI_COMMIT=${ghprbActualCommit}\n$ export REVIEWDOG_INSECURE_SKIP_VERIFY=true # set this as you need\n\n# To submit via reviewdog server using github-pr-check reporter\n$ REVIEWDOG_TOKEN=\"<token>\" reviewdog -reporter=github-pr-check\n# Or, to submit directly via API using github-pr-review reporter\n$ REVIEWDOG_GITHUB_API_TOKEN=\"<token>\" reviewdog -reporter=github-pr-review\n# Or, to submit directly via API using github-pr-check reporter (requires GitHub App Account configured)\n$ REVIEWDOG_SKIP_DOGHOUSE=true REVIEWDOG_GITHUB_API_TOKEN=\"<token>\" reviewdog -reporter=github-pr-check
\n

Exit codes

\n

By default (-fail-level=none) reviewdog will return 0 as exit code even if it finds errors.
\nreviewdog will exit with code 1 with -fail-level=[any,info,warning,error] flag if it finds at least 1 issue with severity greater than or equal to the given level.
\nThis can be helpful when you are using it as a step in your CI pipeline and want to mark the step failed if any error found by linter.

\n

You can also use -level flag to configure default report revel.

\n

Filter mode

\n

reviewdog filter results by diff and you can control how reviewdog filter results by -filter-mode flag.
\nAvailable filter modes are as below.

\n

added (default)

\n

Filter results by added/modified lines.

\n

diff_context

\n

Filter results by diff context. i.e. changed lines +-N lines (N=3 for example).

\n

file

\n

Filter results by added/modified file. i.e. reviewdog will report results as long as they are in added/modified file even if the results are not in actual diff.

\n

nofilter

\n

Do not filter any results. Useful for posting results as comments as much as possible and check other results in console at the same time.

\n

-fail-on-error also works with any filter-mode and can catch all results from any linters with nofilter mode.

\n

Example:

\n
$ reviewdog -reporter=github-pr-review -filter-mode=nofilter -fail-on-error
\n

Filter Mode Support Table

\n

Note that not all reporters provide full support for filter mode due to API limitation.
\ne.g. github-pr-review reporter uses GitHub Review
\nAPI but this API don't support posting comments outside diff context,
\nso reviewdog will use Check annotation as fallback to post those comments [1].

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
-reporter \\ -filter-modeaddeddiff_contextfilenofilter
localOKOKOKOK
github-checkOKOKOKOK
github-pr-checkOKOKOKOK
github-pr-reviewOKOKPartially Supported [1]Partially Supported [1]
github-pr-annotationsOKOKOKOK
gitlab-mr-discussionOKOKOKPartially Supported [2]
gitlab-mr-commitOKPartially Supported [2]Partially Supported [2]Partially Supported [2]
gerrit-change-reviewOKOK? [3]OK? [3]Partially Supported? [2][3]
bitbucket-code-reportNO [4]NO [4]NO [4]OK
gitea-pr-reviewOKOKPartially Supported [2]Partially Supported [2]
\n\n

Debugging

\n

Use the -tee flag to show debug info.

\n
reviewdog -filter-mode=nofilter -tee
\n

Articles

\n\n

🐦 Author

\n

haya14busa \"GitHub

\n

Contributors

\n

\"Contributors\"

\n

Supporting reviewdog

\n

Become GitHub Sponsor for each contributor
\nor become a backer or sponsor from opencollective.

\n

\"Become

","updatedAt":"2025-05-21T16:19:02Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"安全扫描","color":"bf5886"}},{"node":{"name":"reviewdog","color":"acc832"}}]},"comments":{"edges":[]}}},"pageContext":{"number":483,"previous":{"title":"dzikoysk/reposilite: 轻量级且易于使用的存储库管理器，用于 JVM 生态系统中基于 Maven 的私服","number":482},"next":{"title":"BurntSushi/ripgrep: 一个面向行的搜索工具，它递归地搜索当前目录中的正则表达式模式。默认情况下，ripgrep 将遵守 gitignore 规则并自动跳过隐藏文件/目录和二进制文件。","number":484}}}, "staticQueryHashes": ["151096407","2861350382"]}