Skip to content

Commit 824628e

Browse files
committed
Try to add Vale checks
1 parent 64b0a13 commit 824628e

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

.github/workflows/vale-checks.yaml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Vale documentation checks
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
paths:
8+
- 'docs/**' # Only run on changes to the docs directory
9+
10+
workflow_dispatch:
11+
# Manual trigger
12+
13+
14+
concurrency:
15+
group: ${{ github.workflow }}-${{ github.ref }}
16+
cancel-in-progress: true
17+
18+
jobs:
19+
vale:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
- uses: errata-ai/vale-action@v2.1.1
24+
with:
25+
working-directory: "docs"
26+
fetch-depth: 0

docs/.vale.ini

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Core settings appear at the top
2+
# (the "global" section).
3+
MinAlertLevel = warning
4+
Packages = write-good, Readability
5+
6+
# [formats]
7+
# Format associations appear under
8+
# the optional "formats" section.
9+
10+
[*.md]
11+
# Format-specific settings appear
12+
# under a user-provided "glob"
13+
# pattern.
14+
BasedOnStyles = Vale, write-good, Readability
15+
# Disable Vale spellcheck. We already have spellcheck at home (in Make).
16+
Vale.Spelling = NO
17+

0 commit comments

Comments
 (0)