Skip to content

Commit f2944cc

Browse files
authored
chore: add documentation linter (#206)
1 parent fdf4677 commit f2944cc

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

.github/styles/vocab.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
(?i)Failover
2+
(?i)Postgres.*
3+
(?i)Psycopg

.github/workflows/vale.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Document Linter
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- '*'
10+
11+
jobs:
12+
vale:
13+
name: Documentation Linter using Vale
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
- uses: errata-ai/vale-action@reviewdog

.vale.ini

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
StylesPath = .github/styles
2+
MinAlertLevel = suggestion
3+
4+
[*.md]
5+
BasedOnStyles = Vale

0 commit comments

Comments
 (0)