Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions .github/workflows/pr-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]
with:
files: all
fail_on_error: true
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down