Open
Conversation
Contributor
Vale Style Check Results
Warnings (16)
✅ Check passed |
Contributor
|
Contributor
PR Preview
Pages included in this preview
Preview auto-deploys on push. Will be cleaned up when PR closes. |
Design for adding Vale style linting to GitHub Actions PR checks: - Block merging on style errors - Inline annotations + PR summary comments - Smart config detection per product area - Shared content resolution script (reusable by other workflows) - Docker-based Vale execution (matches local setup)
Detailed step-by-step plan for implementing Vale CI: - Task 1: Shared content resolution script - Task 2: Vale check script with config mapping - Task 3: GitHub Actions workflow - Task 4: Testing procedure - Task 5: Documentation updates - Task 6: Final verification
Resolves content/shared/* files to their consuming product pages by searching for matching source: frontmatter. Reusable by Vale, link-checker, and other workflows that need shared content expansion.
Maps files to product-specific Vale configs matching lefthook.yml: - cloud-dedicated, cloud-serverless, v2 use product configs - Other content uses root .vale.ini - Non-content uses .vale-instructions.ini Runs Vale via Docker for version consistency with local dev.
Runs Vale on PR changes with product-specific configs: - Blocks merging on errors - Shows warnings/suggestions as annotations - Posts summary comment for humans and AI agents - Uses Docker for Vale version consistency
Add `|| [[ -n "$f" ]]` to while read loops to catch the last line even when input doesn't end with a newline. This is a common bash pitfall where `while read` skips the final line without a terminator.
jstirnaman
force-pushed
the
docs-v2-jts-vale-ci
branch
from
1148bfd to
bd593d5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds Vale style linting to GitHub Actions that blocks PRs on errors and provides actionable feedback.
Changes:
.github/scripts/resolve-shared-content.sh- Resolves shared content files to their consuming product pages.github/scripts/vale-check.sh- Maps files to product-specific Vale configs and runs Vale via Docker.github/workflows/pr-vale-check.yml- CI workflow with annotations and PR commentsTest plan