v3.0.0

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 push using a github-pr-* reporter previously reported nothing (this is not PullRequest build, exit 0). They now lint, and can fail. Pin reviewdog_version: 0.17.0 to keep the old behavior.
• The level input is honored. It was read from action.yml and never used. Checks that concluded neutral can now conclude failure. Leave level unset for the previous behavior.
• fail_on_error: true fails 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. Use fail_level: any to 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 @reviewdog tracks the branch, which is now v3. Pin @v3, or @v2 to 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. workdir is now declared and documented.
• Caching. Binaries go in the runner's tool cache, and sync: false lets you restore a cached StylesPath instead of re-downloading every package each run.
• Downloads are verified against each release's published checksums.

Fixed

• Crash on large output — write EPIPE when reviewdog exited before reading it all (#122)
• An empty files list failing with lstat : 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 push events (#103)
• The level input being ignored (#106)
• Wildcards in files — use the glob input; the warning now says so (#123)
• Scheduled runs on runners that write a thin event payload (#69)
• vale_flags splitting 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

v2.1.2

What's Changed

Full Changelog: v2...2.1.2

v2.1.1

Note

As of this release, you need to install format-specific dependencies on your own. See the updated README for an example.

What's Changed

• Add clarity on not using quotes with flags by @CollierCZ in #126
• #97: Catch Vale runtime errors properly by @rmoff in #133

New Contributors

• @CollierCZ made their first contribution in #126
• @rmoff made their first contribution in #133

Full Changelog: v2...v2.1.1

v2.1.0

What's Changed

• Fix the default value of reporter input in README.md by @haru52 in #71
• Adds instructions in README for viewing available flags by @wildmanonline in #72
• Remove single quotes from vale_flags example by @lithammer in #83
• docs: use actions/checkout@v3 by @themr0c in #85
• Add CodeQL workflow for GitHub code scanning by @lgtm-com in #87
• Remove the need to explicitly pass GITHUB_TOKEN by @ezzatron in #94
• Fix --level reviewdog option when fail_on_error is false by @daniele-pini in #99
• Refactor prerequisite installation by @dcousineau in #110
• Make Reviewdog URL an input by @mheap in #112
• Use GH Annotations via ReviewDog to associate output with the correct check by @mheap in #118

New Contributors

• @haru52 made their first contribution in #71
• @wildmanonline made their first contribution in #72
• @lithammer made their first contribution in #83
• @themr0c made their first contribution in #85
• @lgtm-com made their first contribution in #87
• @ezzatron made their first contribution in #94
• @daniele-pini made their first contribution in #99
• @dcousineau made their first contribution in #110
• @mheap made their first contribution in #112

Full Changelog: v2...v2.1.0

v2.0.1

Remove `level`

v2.0.0

Remove Git-related tests

v1.5.0

Updates Vale to v2.15.2.

v1.4.3

See #49.

v1.4.2

Fixes #38.

v1.4.1

Update README.md