All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- #1845 Normalize file path in
related_locations
too.
- #1846 Unexpected error
exit code when using
-reporter=github-[pr-]check
with-fail-on-error=true
. See the below breaking changes section for more details.
- #1858 Remove original_output from rdjson/rdjsonl reporters' output
-
#1854 (Actually No Breaking changes)
-fail-on-error
flag is deprecated. Use-fail-level=[none,any,error,warning,info]
flag instead. You can reproduce the same behavior with-fail-level=any
for most reporters (reviewdog will exit with 1 if it find any severity level). As forgithub-[pr-]check
reporter you can reproduce the same behavior with-fail-level=error
(#1846).-fail-on-error
is just deprecated and it's not removed yet. Please update the flag while it's working.
v0.20.1 - 2024-07-10
- #1835 Fix -filter-mode didn't work with github-[pr-]check reporter for graceful degradation cases. i.e. GitHub token doesn't have write permission (e.g. PR from forked repo).
v0.20.0 - 2024-07-07
This version is created by mistake and is the same as v0.19.0. We left both versions as-is so that it won't break existing clients who already use v0.20.0.
v0.19.0 - 2024-07-07
- #1804 Support deleting outdated comments in github-pr-review reporter. Note that it won't delete comments if there is a reply considering there can be a meaningful discussion.
- #1806 Add -reporter=rdjson/rdjsonl which outputs rdjson/rdjsonl format to stdout. It also changes the default behavior of -diff and -filter-mode for local reporters. If -filter-mode is not provided (-filter-mode=default) and -diff flag is not provided, reviewdog automatically set -filter-mode=nofilter.
- #1807 Add -reporter=sarif which outputs SARIF format to stdout. You can upload the output SARIF to GitHub and see code scanning alerts.
- #1809 Support posting comments outside diff context as a file comment in github-pr-review reporter
- #1846 the behavior of
-fail-on-error
changed with-github-[pr-]check
. Previously, reviewdog didn't exit with 1 if it find issues with warning and info level. Now reviewdog will exit with 1 with any level. The previous behavior can be restored with-fail-level=error
flag with the upcoming release.
v0.18.1 - 2024-06-22
- #1792 Introduce
__reviewdog__
HTML comment metadata and fingerprint for identifying existing posted comments forgithub-pr-review
reporter. This resolve duplicated comments issue with related location feature.
v0.18.0 - 2024-06-17
This release supports related locations forgithub-pr-review
reporter.
You can pass related_locations
with rdjson
/ rdjsonl
and sarif
format.
- #1770 Add related locations support for
github-pr-review
reporter
v0.17.5 - 2024-06-01
- #1722 Add a fallback to
git diff
command to get diff forgithub-check
/github-pr-check
reporters with GitHub Actions (in other words, when not in DogHouse server).
v0.17.4 - 2024-04-19
- #1714 Use GitHub API to get a merge base commit and add
git fetch
command to get merge base and head commits
v0.17.3 - 2024-04-14
- #1697 Add a fallback to
git diff
command to get diff of a GitHub pull request
v0.17.2 - 2024-03-11
- #933 Fix go vet errorformat
v0.17.1 - 2024-02-08
- #1651 Revert #1576: Support
--filter-mode=file
ingithub-pr-review
. Reasons: #1645 - #1653 fix: SARIF parser: parse with no region result. fix originalOutput field
- #1657 Fix sending incorrect line numbers to BitBucket Server Code Insight API. (fixes #1652)
v0.17.0 - 2024-01-22
- #1623 Add reporter for GitHub PR annotations
github-pr-annotations
v0.16.0 - 2023-12-17
- #1573 Add filter tests for file/nofilter mode
- #1576 Support
--filter-mode=file
ingithub-pr-review
- #1596 Use
CI_MERGE_REQUEST_DIFF_BASE_SHA
envvar if available ingitlab-mr-discussion
- #1521 strict check of pr-review write permission
- #1617 Add reporter to Gitea PR review comments
gitea-pr-review
v0.15.0 - 2023-09-02
- #1554 Add SARIF format input support.
v0.14.2 - 2023-06-17
- #1170 Calculate check conclusion from annotations
- #1433 Add path link support for GitHub Enterprise
- #1447 Support determining build info on more GitHub Actions events
v0.14.1 - 2022-04-21
- #1160 Remove needless git command dependency by GitRelWorkdir func
- #1125 Allow BITBUCKET_SERVER_URL to have subpath
v0.14.0 - 2022-02-11
- #1118 Support end_lnum (%e) and end_col (%k) errorformat
v0.13.1 - 2021-12-28
- #1012 Use GitLab suggestions in merge request comments
- #1014 Fix incorrect detection of the
GITHUB_TOKEN
permissions. fixes #1010 - #1017 Fix suggestions that include fenced code blocks. fixes #999
- #1084 Fix DEPRECATED to Deprecated
v0.13.0 - 2021-07-22
- #996 Added support for Bitbucket Pipes executed within Pipelines.
- #997 Added support for Bitbucket Server to
bitbucket-code-report
reporter
v0.12.0 - 2021-06-26
- #888 Allow GitHub PR reporting for a forked repository iff it's triggered by
pull_request_target
- #976 Treat
GITHUB_API_URL
environment variable as same asGITHUB_API
, so users can use reviewdog in GitHub Actions in Enterprise Server without settingGITHUB_API
v0.11.0 - 2020-10-25
reviewdog v0.11 introduced Reviewdog Diagnostic Format (RDFormat) as generic machine-readable diagnostic format and it unlocks new rich features like code suggestions.
- #629 Introduced Reviewdog Diagnostic Format.
- #674 #703 Support rdjsonl/rdjson as input format
- #680 github-pr-review: Support multiline comments
- #675 #698 github-pr-review: Support suggested changes
- #699 Support diff input format (
-f=diff
). Useful for suggested changes. - #700 Support to show code(rule), code URL and severity in GitHub and GitLab reporters.
- #678 github-pr-review: Support Code Suggestions
- Introduced reviewdog/action-suggester action.
- Introduced reviewdog/action-setup GitHub Action which installs reviewdog easily including nightly release.
- #769 Integration with Bitbucket Code Insights and Bitbucket Pipelines
v0.10.2 - 2020-08-04
- #709 Check for GITHUB_ACTIONS instead of GITHUB_ACTION
v0.10.1 - 2020-06-30
- #563 Use
CI_API_V4_URL
environment variable when present.
- #609 reviewdog command will fail with unexpected tool's error for github-check/github-pr-check reporters as well. (@haya14busa)
- #603 Fixed detection of Pull Requests from forked repo. (@haya14busa)
v0.10.0 - 2020-05-07
With v0.10.0 release, now reviewdog can find issues outside diff by controlling
filtering behavior with -filter-mode
. Also, you can ensure to check reported
results by exit 1 with -fail-on-error
.
Example
$ cd subdir/ && reviewdog -filter-mode=file -fail-on-error -reporter=github-pr-review
- #446
Added
-fail-on-error
flag (document) and improved exit code handling. (@DmitryLanda, @haya14busa) - #187
Added
-filter-mode
flag [added
,diff_context
,file
,nofilter
] (document) which controls how reviewdog filter results. (@Le6ow5k1, @haya14busa) - #69 Support gerrit! (@staticmukesh)
- #548 Introduced nightly release (reviewdog/nightly). (@haya14busa)
- #461 All reporters now supports sub-directory run. (@haya14busa)
github-check
reporter won't report results outside diff by default now. You need to use-filter-mode=nofilter
to keep the same behavior.
See https://github.com/reviewdog/reviewdog/releases for older release note.