Skip to content

Commit 1bc54a6

Browse files
Add GitHub workflow config to add Vale doc linting.
1 parent 50249c5 commit 1bc54a6

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

.github/workflows/vale-doc-lint.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Check Docusaurus docs with Vale linter
2+
3+
on: [pull_request]
4+
5+
jobs:
6+
vale:
7+
name: Vale doc linter
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v2
11+
- uses: errata-ai/vale-action@reviewdog
12+
with:
13+
# added, diff_context, file, nofilter
14+
# Default is added: results are filtered for added/modified files. Set to no filter when all files need to be checked.
15+
# More info: https://github.com/errata-ai/vale-action and https://github.com/reviewdog/reviewdog#filter-mode
16+
# filter_mode: nofilter
17+
# github-pr-check, github-pr-review, github-check
18+
reporter: github-pr-check
19+
# Set fail_on_error to true to make sure builds fail.
20+
fail_on_error: true
21+
files: docusaurus
22+
env:
23+
# Required, set by GitHub actions automatically:
24+
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
25+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

0 commit comments

Comments
 (0)