Skip to content

Commit

Permalink
Setup Vale linter as a GHA workflow (#2953)
Browse files Browse the repository at this point in the history
* Add vale GHA

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update condition

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

* Update .github/styles/Kedro/ignore.txt

Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* add some styles

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>

* Remove styles for now

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>

---------

Signed-off-by: Ankita Katiyar <ankitakatiyar2401@gmail.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
  • Loading branch information
ankatiyar and stichbury authored Aug 22, 2023
1 parent ce24b3d commit 7065cac
Show file tree
Hide file tree
Showing 6 changed files with 172 additions and 1 deletion.
6 changes: 6 additions & 0 deletions .github/styles/Kedro/Spellings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
extends: spelling
message: "Did you really mean '%s'?"
level: warning
ignore:
- Kedro/ignore.txt
- Kedro/ignore-names.txt
111 changes: 111 additions & 0 deletions .github/styles/Kedro/ignore-names.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
Ahdra
Aris
Alves
Alam
Andrew
Andrii
Anton
Antony
Ankita
Batori
Braccialli
Brummitt
Cano
Carvalho
Cvetanka
Czakon
Chan
Comym
Couto
Daiha
Dada
Danov
Datta
DeBold
Deepyaman
Deriabin
Diaz
Dmitrii
Dmitry
Emamjome
Erins
Gabriel
Gundaniya
Guilherme
Hamza
Hoang
Holzer
Huong
Helmhold
Ignacio
Ivaniuk
Ivan
Jakub
Jannic
Jankowski
Jitendra
Jiri
Jo
Joel
Juan
Kadiri
Kaiser
Kaltsas
Kanchwala
Katiyar
Khan
Kirilenko
Kiyohito
Klein
Kunii
Kumar
Lais
Laura
Liam
Lim
Lorena
Machado
Mackay
Malte
Malloy
Marcin
Meisam
Merali
Merel
Milne
Nasef
Nechevska
Nero
Nguyen
Nikolaos
Nikolic
Nok
Okwa
Oza
Paricio
Patel
Peteris
Pilla
Rashida
Ravi
Richard
Schwarzmann
Sorokin
Stichbury
Susanna
Sajid
Stephanie
Takieddine
Theisen
Tynan
Tsaousis
Valtazanos
Vladimir
Waylon
Westenra
Wong
Wrigley
Yolan
Yetunde
Zablocki
Zain
31 changes: 31 additions & 0 deletions .github/styles/Kedro/ignore.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Kedro
Kedro's
Kubeflow
Databricks
Conda
conda
Cookiecutter
config
fsspec
Kaggle
namespace
namespaces
namespaced
regressors
repo
Repo
dbx
MLflow
csv
yaml
matplotlib
Matplotlib
IPython
APIs
networkx
Plotly
Pylint
SQLAlchemy
Astro
Xebia
pytest
16 changes: 16 additions & 0 deletions .github/workflows/docs-language-linter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Language Linter for Kedro Docs
on:
pull_request:
paths:
- "docs/**"
- '**.md'

jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: errata-ai/vale-action@reviewdog
with:
reporter: github-pr-review
2 changes: 1 addition & 1 deletion .github/workflows/docs-only-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ on:
- '**.md'

jobs:
lint-tests:
lint:
strategy:
matrix:
os: [ ubuntu-latest ]
Expand Down
7 changes: 7 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
StylesPath = .github/styles

MinAlertLevel = suggestion

[*.md]
BasedOnStyles = Vale, Kedro
Vale.Spelling = NO

0 comments on commit 7065cac

Please sign in to comment.