The official GitHub Action for Vale -- install, manage, and run Vale with ease.

Add the following (or similar) to one of your .github/workflows files:

name: reviewdog
on: [pull_request]

jobs:
  vale:
    name: runner / vale
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: errata-ai/vale-action@reviewdog

The recommended repository structure makes use of the existing .github directory to hold all of our Vale-related resources:

.github
├── styles
│   └── vocab.txt
└── workflows
    └── main.yml
.vale.ini
...

Where styles represents your StylesPath. The top-level .vale.ini file should reference this directory:

StylesPath = .github/styles
MinAlertLevel = suggestion

[*.md]
BasedOnStyles = Vale

You can further customize the linting processing by providing one of the following optional inputs.

NOTE: The provided version must be >= 2.16.0.

Specify the Vale CLI version to use.

with:
  version: 2.17.0

files specifies where Vale will look for files to lint.

with:
  files: path/to/lint

You can supply this value one of four ways:

• files: all (default): The repo's root directory; equivalent to calling vale ..

• files: path/to/lint: A single file or directory; equivalent to calling vale path/to/lint.

• files: '["input1", "input2"]': A JSON-formatted list of file or directory arguments; equivalent to calling vale input1 input2.

• files: 'input1,input2': A character-delimited list of files. The character is determined by the input value separator:

  with:
    separator: ","

Set the reporter type.

with:
  # github-pr-check, github-pr-review, github-check
  reporter: github-pr-check

By default, reviewdog will return exit code 0 even if it finds errors. If fail_on_error is enabled, reviewdog exits with 1 when at least one error was reported.

with:
  fail_on_error: true

Set the filter mode for reviewdog.

with:
  # added, diff_context, file, nofilter
  filter_mode: nofilter

Space-delimited list of flags for the Vale CLI. To see a full list of available flags, run vale -h.

with:
  vale_flags: "--glob=*.txt"

The GitHub token to use.

with:
  token: ${{secrets.VALE_GITHUB_TOKEN}}