diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml new file mode 100644 index 0000000..8cc831b --- /dev/null +++ b/.github/workflows/vale.yml @@ -0,0 +1,26 @@ +name: docs / vale + +on: + pull_request: + paths: + - '**/*.md' + - 'docs/**' + - '.github/**' + +jobs: + vale: + name: Vale / lint docs + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v4 + + - name: Fetch Vale styles + run: | + git clone https://github.com/errata-ai/styles.git ./.vale/styles + + - name: Run Vale using official action + uses: errata-ai/vale-action@v2 + with: + config: ./.vale.ini + stylesPath: ./.vale/styles diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000..d44efcd --- /dev/null +++ b/.vale.ini @@ -0,0 +1,5 @@ +StylesPath = ./.vale/styles +MinAlertLevel = suggestion + +[*.md] +BasedOnStyles = Microsoft, Technical