Skip to content

Commit fd96f6b

Browse files
chore: change Vale reporter to local and consolidate Vale configuration (#69813)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: [email protected] <[email protected]>
1 parent 5938dee commit fd96f6b

File tree

4 files changed

+8
-56
lines changed

4 files changed

+8
-56
lines changed

.github/workflows/reviewdog.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ jobs:
3434
- uses: errata-ai/vale-action@d89dee975228ae261d22c15adcd03578634d429c # Pinned to V2.1.1
3535
continue-on-error: true # Always pass, even if reviewdog can't post annotations (e.g., fork PRs with read-only tokens)
3636
with:
37-
vale_flags: --config=docusaurus/vale-ci.ini --minAlertLevel=warning # CI-specific config that disables certain rules (see vale-ci.ini vs vale.ini)
37+
vale_flags: --config=docusaurus/vale.ini --minAlertLevel=warning # Use vale.ini with minAlertLevel overridden to warning for CI
3838
files: docs/ # Folder in which to lint
3939
filter_mode: added # Only lint things that have changed
4040
fail_on_error: false # Don't fail if the linter finds issues (compliance is optional)
41-
reporter: github-pr-review # Post as annotations on the Changed Files page
41+
reporter: local # Output to job logs only, no PR annotations or comments

docs/community/contributing-to-airbyte/writing-docs.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -348,11 +348,12 @@ Vale and MarkDownLint are newly implemented. They might still generate false pos
348348

349349
Both Vale and MarkDownLint run automatically on pull requests through the [Reviewdog workflow](https://github.com/airbytehq/airbyte/blob/master/.github/workflows/reviewdog.yml). When you open or update a pull request that modifies documentation in `docs/**/*.md`, the workflow:
350350

351-
- Runs Vale with a minimum alert level of **warning** (errors and warnings are reported, suggestions are not)
352-
- Runs MarkDownLint to check for structural issues
353-
- Posts any violations as annotations on the "Files Changed" page in your pull request
351+
- Runs Vale with a minimum alert level of **warning** (errors and warnings are reported, suggestions are not). Vale prints violations to the CI job logs only (no PR annotations or comments).
352+
- Runs MarkDownLint to check for structural issues. MarkDownLint posts violations as annotations on the "Files changed" tab in your pull request.
354353
- Does not fail the build (compliance is optional but recommended)
355354

355+
To view Vale results in CI: open your PR's Checks tab → select "Docs / Vale" → expand the step that runs Vale to see the log output.
356+
356357
Running the linters locally before opening a pull request is optional but recommended. When you run the linters locally as described in the sections below, you'll see all violation levels including **suggestions**, which provide additional guidance that isn't shown in CI. This gives you the opportunity to improve your documentation beyond the minimum requirements before submitting for review.
357358

358359
### Lint with Vale

docusaurus/vale-ci.ini

Lines changed: 0 additions & 49 deletions
This file was deleted.

docusaurus/vale.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# This file controls Vale's behavior when linting your documentation locally.
2-
# For GitHub CI linting, see vale-ci.ini which disables certain rules for CI only.
1+
# This configuration is used for both local development and GitHub CI.
2+
# In CI, the workflow passes --minAlertLevel=warning to show warnings and errors only.
33

44
# Where styles and rules are located
55
StylesPath = ../docs/vale-styles

0 commit comments

Comments
 (0)