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.

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

Setup Vale with a minimal configuration #330

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Setup Vale with a minimal configuration #330

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
28 changes: 28 additions & 0 deletions .github/workflows/style_docstr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# check spelling, codestyle
name: Style and Docstring Check

on: [pull_request, workflow_dispatch]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
vale:
name: Vale
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
# this is equivalent to
# vale --config doc/.vale.ini doc pyvista examples
- name: "Run Vale"
uses: errata-ai/vale-action@reviewdog
with:
files: '["doc", "src", "examples"]'
vale_flags: "--config=doc/.vale.ini"
reporter: github-pr-check
level: error
filter_mode: nofilter
fail_on_error: true
version: 2.29.5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Loading