[DOCS-15413] Suppress prodname frontmatter noise in Vale CI annotations - #39285
Draft
hestonhoffman wants to merge 2 commits into
Draft
[DOCS-15413] Suppress prodname frontmatter noise in Vale CI annotations#39285hestonhoffman wants to merge 2 commits into
hestonhoffman wants to merge 2 commits into
Conversation
Related to DOCS-15413.
Vale's Datadog.Prodname rule correctly flags product names in YAML frontmatter, but Hugo shortcodes don't render inside raw YAML string values, so wrapping them there isn't actionable. This drops those specific findings from the GitHub annotation output without touching .vale.ini, so the rule still runs everywhere else (including for other tools that consume Vale directly, e.g. the VSCode extension).
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.
What does this PR do? What is the motivation?
Adding some Vale workarounds to support adding and checking for the Product name shortcode.
BlockIgnoresentry for theprodnameshortcode span to.vale.ini. This prevents terms that are already encapsulated with the shortcode from flagging as false positives; Vale doesn't support this kind of exclusion.vale_annotations.pyso CI-generated PR annotations dropDatadog.Prodnamefindings that fall inside YAML frontmatter.This is a code-only split out of a larger effort to wrap existing product names in the
prodnameshortcode; the content changes will follow in separate batched PRs.See:
Merge readiness