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

add vale style check #604

Merged
merged 1 commit into from
Oct 28, 2024
Merged
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
28 changes: 28 additions & 0 deletions .github/workflows/vale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Style check

on:
pull_request:
workflow_dispatch:

jobs:
style-job:
runs-on: ubuntu-latest
steps:
- name: Check out
uses: actions/checkout@v3

# For AsciiDoc users:
- name: Install Asciidoctor
run: sudo apt-get install -y asciidoctor

- name: Run Vale
uses: errata-ai/vale-action@reviewdog
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
with:
fail_on_error: true
reporter: github-pr-check
filter_mode: added
files: latest/bpg
continue-on-error: false

2 changes: 1 addition & 1 deletion bpg-docs.code-workspace
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"folders": [
{
"name": "📦 AmazonEKSDocsTachyonPreview",
"name": "📦 AmazonEKSBestPracticesDocs",
"path": "."
}
],
Expand Down
5 changes: 5 additions & 0 deletions vale/styles/BpgDocs/AwsBrand.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
extends: existence
message: "Don't write out 'AWS' literally. Use the variable '{aws}' instead."
level: error
raw:
- \bAWS\p{Z}+[\p{L}\p{N}]+\b
Loading