Skip to content

Commit df0f4b3

Browse files
committed
Setting up vale linter using Microsoft, Readability, and Hugo packages with CNCF vocabulary additions
Signed-off-by: Nate W <[email protected]>
1 parent da23ea7 commit df0f4b3

File tree

5 files changed

+61
-0
lines changed

5 files changed

+61
-0
lines changed

.github/styles/Vocab/CNCF/accept.txt

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Aniszczyk
2+
API
3+
(?i)approvers
4+
architected
5+
(?i)autoscal*
6+
cloud native
7+
CNCF
8+
containerd
9+
cyber
10+
datacenter(s\b|\b)
11+
Datadog
12+
declaratively
13+
gRPC
14+
idempotence
15+
Ispas
16+
Jihoon
17+
K8s
18+
Katelin
19+
KubeCon
20+
(?i)multitenan*
21+
misconfiguration
22+
open source
23+
overdemand
24+
Ramer
25+
reusability
26+
rollout
27+
Seo
28+
Seokho
29+
(?i)serverless
30+
SRE
31+
subnet
32+
virtualiz*
33+
VM

.github/styles/Vocab/CNCF/reject.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
cloud-native
2+
K8
3+
open-source

.github/workflows/vale.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Editorial review
2+
on: [pull_request]
3+
4+
jobs:
5+
vale:
6+
name: runner / vale
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v3
10+
- uses: errata-ai/vale-action@reviewdog
11+
with:
12+
files: content/en
13+
fail_on_error: true

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@
22
public/
33
resources/
44
node_modules/
5+
.github/styles/*
6+
!.github/styles/Vocab
57
.hugo_build.lock
68
.DS_Store

.vale.ini

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
StylesPath = .github/styles
2+
3+
MinAlertLevel = error
4+
5+
Packages = Microsoft, Readability, Hugo
6+
Vocab = CNCF
7+
8+
[*.md]
9+
BasedOnStyles = Vale, Microsoft, Readability
10+
Microsoft.Contractions = NO

0 commit comments

Comments
 (0)