GitHub Actions + Vale
The official GitHub Action for Vale -- install, manage, and run Vale with ease.
Usage
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
Repository Structure
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
Inputs
You can further customize the linting processing by providing one of the following optional inputs.
version
(default: latest)
NOTE: The provided version must be
>= 2.16.0
.
Specify the Vale CLI version to use.
with:
version: 2.17.0
files
(default: all)
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 callingvale .
. -
files: path/to/lint
: A single file or directory; equivalent to callingvale path/to/lint
. -
files: '["input1", "input2"]'
: A JSON-formatted list of file or directory arguments; equivalent to callingvale input1 input2
. -
files: 'input1,input2'
: A character-delimited list of files. The character is determined by the input valueseparator
:with: separator: ","
reporter
(default: github-pr-check)
Set the reporter type.
with:
# github-pr-check, github-pr-review, github-check
reporter: github-pr-check
fail_on_error
(default: false)
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
filter_mode
(default: added)
Set the filter mode for
reviewdog
.
with:
# added, diff_context, file, nofilter
filter_mode: nofilter
vale_flags
(default: "")
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"
token
(default: secrets.GITHUB_TOKEN
)
The GitHub token to use.
with:
token: ${{secrets.VALE_GITHUB_TOKEN}}