chore(workflows): Consolidate Vale linting into Reviewdog workflow (#67620)
## What Consolidates the Vale linting job from PR #65973 into the existing Reviewdog workflow. This adds Vale as a second documentation linting job alongside MarkdownLint, both using the same reviewdog reporter for consistency. Related to #65973 ## How **Workflow Changes** (`.github/workflows/reviewdog.yml`): - Updated workflow comments to reflect that both MarkdownLint and Vale run on docs - Added a new `vale` job that runs after the `markdownlint` job - Configured Vale to use `github-pr-review` reporter (matching MarkdownLint's configuration) - Uses `filter_mode: added` to only lint newly added content - Uses `fail_on_error: false` to keep Vale checks non-blocking **Vale Configuration Changes** (`docusaurus/vale.ini`): - Changed `MinAlertLevel` from `suggestion` to `warning` - This scopes Vale to only report warnings and errors, excluding suggestions ## Review guide 1. **`.github/workflows/reviewdog.yml`** - Review the Vale job configuration: - Verify the `errata-ai/vale-action` parameters are correct - Confirm `github-pr-review` is the appropriate reporter (changed from `github-pr-check` in the original PR #65973) - Check that `filter_mode: added` and `fail_on_error: false` are the desired settings 2. **`docusaurus/vale.ini`** - Review the MinAlertLevel change: - Confirm `MinAlertLevel = warning` is the desired behavior (excludes suggestions, only shows warnings and errors) - Note: The `airbyte.punctuation = NO` rule was already removed in master, so no changes needed there ## User Impact **Positive:** - Documentation PRs will now receive automated Vale linting feedback alongside MarkdownLint - Both linters use the same reporter type for consistent PR annotations - Vale will only flag warnings and errors, reducing noise from suggestions **Neutral:** - This supersedes the separate Vale workflow from PR #65973, which can be closed once this is merged - No impact to existing MarkdownLint checks ## Can this PR be safely reverted and rolled back? - [x] YES 💚 This only adds a new linting job to the Reviewdog workflow. Reverting would simply remove the Vale checks without affecting the existing MarkdownLint job or any other workflows. --- **Session Details:** - Requested by: Ian Alton (ian.alton@airbyte.io) - Link to Devin run: https://app.devin.ai/sessions/7993d1cba2464b48bbababe88bda0671 --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
This commit is contained in:
committed by
GitHub
parent
0f6a500868
commit
27ed20403e
19
.github/workflows/reviewdog.yml
vendored
19
.github/workflows/reviewdog.yml
vendored
@@ -1,6 +1,6 @@
|
||||
# This workflow runs reviewdog on pull requests.
|
||||
# Currently reviewdog is only used to run MarkDownLint on docs
|
||||
# Info: https://docs.airbyte.com/platform/next/contributing-to-airbyte/writing-docs#lint-with-markdownlint.
|
||||
# Currently reviewdog is only used to run MarkDownLint and Vale on docs
|
||||
# Info: https://docs.airbyte.com/platform/next/contributing-to-airbyte/writing-docs
|
||||
# However, this can be expanded later to include all changes in Airbyte
|
||||
name: Reviewdog
|
||||
|
||||
@@ -23,3 +23,18 @@ jobs:
|
||||
reporter: github-pr-review # Post as annotations on the Changed Files page
|
||||
level: warning # Don't show info, just warnings and errors
|
||||
filter_mode: added # Only check newly added content
|
||||
|
||||
vale:
|
||||
name: Docs / Vale
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # V5
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- uses: errata-ai/vale-action@d89dee975228ae261d22c15adcd03578634d429c # Pinned to V2.1.1
|
||||
with:
|
||||
vale_flags: --config=docusaurus/vale.ini --minAlertLevel=warning # Location of Vale's config file and min alert level for CI (local linters will still see suggestions)
|
||||
files: docs/ # Folder in which to lint
|
||||
filter_mode: added # Only lint things that have changed
|
||||
fail_on_error: false # Don't fail if the linter finds issues (compliance is optional)
|
||||
reporter: github-pr-review # Post as annotations on the Changed Files page
|
||||
|
||||
Reference in New Issue
Block a user