diff --git a/.github/workflows/style_docstr.yml b/.github/workflows/style_docstr.yml new file mode 100644 index 00000000..2dcbdbcb --- /dev/null +++ b/.github/workflows/style_docstr.yml @@ -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 }}