diff --git a/.github/workflows/pr-lint.yaml b/.github/workflows/pr-lint.yaml index 6460e74d8..0fc492b31 100644 --- a/.github/workflows/pr-lint.yaml +++ b/.github/workflows/pr-lint.yaml @@ -21,3 +21,13 @@ jobs: steps: - uses: actions/checkout@v4 - uses: ludeeus/action-shellcheck@master + + vale: + name: runner / vale + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: errata-ai/vale-action@v2.1.1 + with: + files: all + fail_on_error: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3abd7c1d5..b5a11b55e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -132,11 +132,15 @@ the prose of your pull requests and adds suggestions to improve style and clarit There is a [VSCode plugin for Vale](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode) which outputs suggestions to the problems pane in the IDE. +The Fluent Bit repository runs Vale as a GitHub Action on updated text in new pull +requests. Vale suggestions, errors, and warnings will display in GitHub on the +**Files changed** page. + [See the Vale tests for Fluent Bit](https://github.com/fluent/fluent-bit-docs/tree/master/vale-styles). Most Vale tests are at the `suggestion` level and won't block merging. -The following tests are at a `error` level and will prevent merging: +The following tests are at `error` level and will cause a test failure: - [AmSpelling](https://developers.google.com/style/word-list) - [Ampersand](https://developers.google.com/style/word-list#ampersand)