Skip to content

Update vale linter configuration #873

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.

Sign up for GitHub

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

Merged
kprosise merged 1 commit into from
Nov 17, 2025
Merged

Update vale linter configuration #873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 5 additions & 6 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
name: reviewdog
on:
pull_request:
branches:
- main
on: [pull_request]

jobs:
vale:
name: runner / vale
Expand All @@ -11,9 +9,10 @@ jobs:
- name: Install docutils
run: sudo apt-get install -y docutils
- uses: actions/checkout@v4
- uses: errata-ai/vale-action@reviewdog
- uses: errata-ai/vale-action@v2.1.1
with:
reporter: github-pr-check
files: source/
reporter: github-pr-review
fail_on_error: false
env:
# Required, set by GitHub actions automatically:
Expand Down
12 changes: 6 additions & 6 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
############################# Core Settings ###################################
StylesPath = styles
StylesPath = .github/styles
MinAlertLevel = suggestion

Packages = https://github.com/foundriesio/fio-style/releases/download/v2.5.0/Fio-docs.zip
Packages = https://github.com/foundriesio/fio-style/releases/latest/download/Fio-docs.zip

# You can add different terms to either accept or reject by adding them to vocab.
# This can be useful if you are using a new term or writing to a specific audience.
Expand All @@ -26,13 +26,13 @@ Packages = https://github.com/foundriesio/fio-style/releases/download/v2.5.0/Fio
################################ Format #######################################

# Associations: Useful for alternative file extension; <alt-name> = <common>.
[formats]
mdx = md
#[formats]
#mdx = md

# Vale supports a lot of markup languages. ReStructuredText and Markdown being
# what we will usually be using. Different styles can be set for different file
# formats
[*.{md,rst}]
[*.{rst}]

# Based on will enable ALL rules that make up the style
BasedOnStyles = Fio-docs
Expand All @@ -45,8 +45,8 @@ BasedOnStyles = Fio-docs
#Fio-docs.Branding-and-names = NO
#Fio-docs.InclusiveLanguage = NO
#Vale.Spelling = NO
Fio-docs.expand-acronyms = NO

# Severity level can be modified for a rule as well:
#Vale.Spelling = warning
#Fio-docs.Branding-and-names = suggestion
Fio-docs.expand-acronyms = suggestion