Skip to content

Commit 27a883d

Browse files
authored
Merge pull request #2022 from fluent/lynettemiles/sc-142989/ci-cd-vale
2 parents 63218e2 + b4423c3 commit 27a883d

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

.github/workflows/pr-lint.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,13 @@ jobs:
2121
steps:
2222
- uses: actions/checkout@v4
2323
- uses: ludeeus/action-shellcheck@master
24+
25+
vale:
26+
name: runner / vale
27+
runs-on: ubuntu-latest
28+
steps:
29+
- uses: actions/checkout@v4
30+
- uses: errata-ai/[email protected]
31+
with:
32+
files: all
33+
fail_on_error: true

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,15 @@ the prose of your pull requests and adds suggestions to improve style and clarit
132132
There is a [VSCode plugin for Vale](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode)
133133
which outputs suggestions to the problems pane in the IDE.
134134

135+
The Fluent Bit repository runs Vale as a GitHub Action on updated text in new pull
136+
requests. Vale suggestions, errors, and warnings will display in GitHub on the
137+
**Files changed** page.
138+
135139
[See the Vale tests for Fluent Bit](https://github.com/fluent/fluent-bit-docs/tree/master/vale-styles).
136140

137141
Most Vale tests are at the `suggestion` level and won't block merging.
138142

139-
The following tests are at a `error` level and will prevent merging:
143+
The following tests are at `error` level and will cause a test failure:
140144

141145
- [AmSpelling](https://developers.google.com/style/word-list)
142146
- [Ampersand](https://developers.google.com/style/word-list#ampersand)

0 commit comments

Comments
 (0)