Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup vale linter #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/styles/Vocab/CNCF/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Aniszczyk
API
(?i)approvers
architected
(?i)autoscal*
cloud native
CNCF
containerd
cyber
datacenter(s\b|\b)
Datadog
declaratively
gRPC
idempotence
Ispas
Jihoon
K8s
Katelin
KubeCon
(?i)multitenan*
misconfiguration
open source
overdemand
Ramer
reusability
rollout
Seo
Seokho
(?i)serverless
SRE
subnet
virtualiz*
VM
3 changes: 3 additions & 0 deletions .github/styles/Vocab/CNCF/reject.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
cloud-native
K8
open-source
13 changes: 13 additions & 0 deletions .github/workflows/vale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Editorial review
on: [pull_request]

jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: errata-ai/vale-action@reviewdog
with:
files: content/en
fail_on_error: true
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@
public/
resources/
node_modules/
.github/styles/*
!.github/styles/Vocab
.hugo_build.lock
.DS_Store
10 changes: 10 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
StylesPath = .github/styles

MinAlertLevel = error

Packages = Microsoft, Readability, Hugo
Vocab = CNCF

[*.md]
BasedOnStyles = Vale, Microsoft, Readability
Microsoft.Contractions = NO