Skip to content

Commit 8191682

Browse files
authored
Exclude changelog files from Vale checks (#1461)
1 parent 3486dcc commit 8191682

File tree

4 files changed

+24
-2
lines changed

4 files changed

+24
-2
lines changed

.github/workflows/vale.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ on:
66
- '**.md'
77
- '.vale/**'
88
- '.vale.ini'
9+
- '!**/changelog/**'
910

1011
jobs:
1112
vale:

.pre-commit-config.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ repos:
66
entry: bash -c 'vale --config=.vale.ini "$@"; exit 0' --
77
language: system
88
files: \.(md|mdx)$
9+
exclude: 'changelog/'
910
pass_filenames: true
10-
verbose: true
11+
verbose: true
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
extends: existence
2+
message: "Avoid time-relative terms like '%s' that become outdated"
3+
level: warning
4+
ignorecase: true
5+
tokens:
6+
- current
7+
- currently
8+
- presently
9+
- as of now
10+
- at this time
11+
- present
12+
- in the future
13+
- future
14+
- now
15+
- today
16+
- soon
17+
- latest
18+
- new
19+
- upcoming
20+
- old

.vale/styles/FernStyles/Please.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ message: "Avoid using '%s' in technical documentation."
33
level: warning
44
ignorecase: true
55
tokens:
6-
- please # Instead of "Please refer to the documentation", say "Refer to the documentation"
6+
- please

0 commit comments

Comments
 (0)