Skip to content

Commit 01491d4

Browse files
authored
add vale style check (#604)
1 parent 3cbb38e commit 01491d4

File tree

3 files changed

+34
-1
lines changed

3 files changed

+34
-1
lines changed

.github/workflows/vale.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Style check
2+
3+
on:
4+
pull_request:
5+
workflow_dispatch:
6+
7+
jobs:
8+
style-job:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Check out
12+
uses: actions/checkout@v3
13+
14+
# For AsciiDoc users:
15+
- name: Install Asciidoctor
16+
run: sudo apt-get install -y asciidoctor
17+
18+
- name: Run Vale
19+
uses: errata-ai/vale-action@reviewdog
20+
env:
21+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
22+
with:
23+
fail_on_error: true
24+
reporter: github-pr-check
25+
filter_mode: added
26+
files: latest/bpg
27+
continue-on-error: false
28+

bpg-docs.code-workspace

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"folders": [
33
{
4-
"name": "📦 AmazonEKSDocsTachyonPreview",
4+
"name": "📦 AmazonEKSBestPracticesDocs",
55
"path": "."
66
}
77
],

vale/styles/BpgDocs/AwsBrand.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
extends: existence
2+
message: "Don't write out 'AWS' literally. Use the variable '{aws}' instead."
3+
level: error
4+
raw:
5+
- \bAWS\p{Z}+[\p{L}\p{N}]+\b

0 commit comments

Comments
 (0)