Clean up .vale.ini before deslop validation harness#1535
Closed
justinegeffen wants to merge 12 commits into
Closed
Clean up .vale.ini before deslop validation harness#1535justinegeffen wants to merge 12 commits into
justinegeffen wants to merge 12 commits into
Conversation
- Collapse duplicate `[*.md]` and `[*.mdx]` sections into `[*.{md,mdx}]`
- Consolidate two `BlockIgnores` directives into a single line, and move
them under the section glob so `.md` files also ignore code fences and
frontmatter (previously only `.mdx` did)
- Drop `Packages = write-good` so the vendored copy under
`.github/styles/write-good/` is the source of truth instead of the Vale
hub. CI still runs `vale sync` via errata-ai/vale-action; the vendored
copy keeps local + CI output deterministic and aligned
- Remove the misleading trailing comment about "paths to check" — Vale
takes paths from the CLI invocation, not `.vale.ini`
Verified `vale ls-config` parses cleanly and that linting a sample .md
file still surfaces the expected Seqera and write-good findings.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Drop platform-enterprise_versioned_docs from the Vale file list. Versioned docs are frozen snapshots; findings there are noise that reviewers can't act on without editing a release archive. - Flip fail_on_error from false to true. The Seqera substitution rules (Tower → Seqera Platform, etc.) are declared at level: error in .github/styles/Seqera/*.yml. Leaving fail_on_error: false meant the declared severity was purely cosmetic — terminology errors posted as comments but never gated merges. With fail_on_error: true the gate matches the configured severity. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Previously Vale only ran when a contributor commented /editorial-review on a PR — the same on-demand path used for the LLM editorial review. Vale is fast, cheap, and deterministic; it should run on every PR push without anyone opting in. - New workflow .github/workflows/vale.yml triggers on pull_request when doc files, styles, or .vale.ini change. Same scope and same fail_on_error: true configuration as the previous job (which was already adjusted on this branch). - Remove the vale-lint job from docs-review.yml and the summary references to it. docs-review.yml is now LLM-only. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4 tasks
Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
write-good was referenced in BasedOnStyles but no longer vendored or fetched via `vale sync`, which broke CI with "style 'write-good' does not exist on StylesPath". The only active rule it contributed was Passive at suggestion level, which the editorial-review agents already cover. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
2 participants
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
Tidies
.vale.iniahead of running the deslop validation harness so the production config doesn't muddy measurements. Pure cleanup — no behaviour change in CI'svale-lintjob, plus one incidental bug fix.[*.md]and[*.mdx]sections into a single[*.{md,mdx}]glob so any future override only needs to be edited once.BlockIgnoresdirectives into a single comma-separated line. In the old config these lived inside the[*.mdx]section, so.mdfiles weren't ignoring code fences or frontmatter at all. Moving them up to the section glob fixes that incidentally.Packages = write-goodin favour of the vendored copy under.github/styles/write-good/.errata-ai/vale-actionstill callsvale syncinside its container, but the vendored copy keeps local and CI output deterministic without depending on the Vale hub being reachable..vale.iniconfigures paths — Vale takes paths from the CLI invocation.Verification
vale ls-configparses the new file cleanly;BlockIgnores,TokenIgnores,RuleToLevel, andSBaseStylesall resolve as expected for*.{md,mdx}.vale --no-exit platform-cloud/docs/quickstart.mdstill surfaces the expectedSeqera.Featureserrors (e.g.config→configuration) andwrite-good.E-Prime/Passive/TooWordysuggestions.Test plan
/editorial-reviewon a PR with doc changes and confirm thevale-lintjob in docs-review.yml still posts the same inline review output..mdfiles that weren't there before (the BlockIgnores move means code fences and frontmatter in.mdfiles are now ignored — net reduction in noise, not new errors).🤖 Generated with Claude Code