Skip to content

Testing CI/CD by adding vale to actions #2022

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 31, 2025
+15 −1
Merged

Testing CI/CD by adding vale to actions #2022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9c74982
Testing CI/CD by adding vale to actions
esmerel Jul 29, 2025
c94f226
test deliberate warning
esmerel Jul 29, 2025
c041ab8
Intro a warning
esmerel Jul 29, 2025
f812914
fail on warning
esmerel Jul 29, 2025
e9255d7
vale: fixing introduced errors
esmerel Jul 29, 2025
8198274
Contributing: adding info about vale as a github action
esmerel Jul 29, 2025
b4423c3
Update CONTRIBUTING.md
esmerel Jul 29, 2025
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
View file
Open in desktop
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
View file
Open in desktop
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