Breaking
Nothing was renamed or removed, but several behaviors changed. Each has a way back.
- reviewdog 0.17.0 → 0.21.0. Workflows triggered on
pushusing agithub-pr-*reporter previously reported nothing (this is not PullRequest build, exit 0). They now lint, and can fail. Pinreviewdog_version: 0.17.0to keep the old behavior. - The
levelinput is honored. It was read fromaction.ymland never used. Checks that concluded neutral can now conclude failure. Leavelevelunset for the previous behavior. fail_on_error: truefails on errors only. It previously failed on a finding of any severity for every reporter except the check ones, so a lone suggestion ended the run. Usefail_level: anyto restore that.- GitHub's 10-annotation limit no longer fails the job when
fail_on_error: false. You get a warning naming how many alerts went unshown. - Pinning
@reviewdogtracks the branch, which is now v3. Pin@v3, or@v2to stay put.
Added
- Suggested fixes. Alerts that Vale knows how to resolve are posted as suggested changes you can commit from the pull request — the same replacements the language server offers. Requires
reporter: github-pr-review. - macOS, Windows, and ARM runners. The action previously only ran on Linux x86-64.
- New inputs:
config,filter,glob,min_alert_level,fail_level,sync,reviewdog_version.workdiris now declared and documented. - Caching. Binaries go in the runner's tool cache, and
sync: falselets you restore a cachedStylesPathinstead of re-downloading every package each run. - Downloads are verified against each release's published checksums.
Fixed
- Crash on large output —
write EPIPEwhen reviewdog exited before reading it all (#122) - An empty
fileslist failing withlstat : no such file or directory(#141) - Pull requests whose diff exceeds 20,000 lines (#153)
- The annotation limit failing runs regardless of
fail_on_error(#89, #150) - A warning failing the workflow under
fail_on_error: true(#84) - Nothing reported on
pushevents (#103) - The
levelinput being ignored (#106) - Wildcards in
files— use theglobinput; the warning now says so (#123) - Scheduled runs on runners that write a thin event payload (#69)
vale_flagssplitting on whitespace, which broke--filter='.Level == "error"'- Vale's own error is reported when it exits with a runtime error, instead of an exit code
Internal
The action now ships as a single bundled dist/index.js; node_modules is no longer committed, taking the repository from 1,035 tracked files to 23. CI fails if the bundle is out of date with the source.
Full Changelog: 2.1.2...v3.0.0