fix: Add spell check and lint validation for individual feature files #15473
Conversation
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
Author
om7057
force-pushed
the
issue-15149-fix-1
branch
2 times, most recently
from
262d779 to
96a2191
Compare
Runs markdown-spellcheck on individual .features/pending/*.md files during features-validate, catching spelling errors early before release. Spell check is non-blocking (warning only) since feature files contain author names and GitHub usernames that trigger false positives. Fixes argoproj#15149 Signed-off-by: om7057 <[email protected]>
om7057
force-pushed
the
issue-15149-fix-1
branch
from
96a2191 to
ec8af7b
Compare
Signed-off-by: om7057 <[email protected]>
Signed-off-by: om7057 <[email protected]>
Joibel
reviewed
Feb 5, 2026
| features-validate: hack/featuregen/featuregen $(TOOL_MARKDOWNLINT) $(TOOL_MDSPELL) | ||
| # Validate all pending feature documentation files | ||
| $< validate | ||
| # Spell check individual feature files before they are combined (warning only, does not fail build) |
Member
There was a problem hiding this comment.
Why do we want this to not fail the build?
Author
There was a problem hiding this comment.
Okay @Joibel. It's set to warning-only since there are existing spelling issues in pending files (e.g., author names not in the dictionary). Happy to make it fail the build if it's preferred, please let me know.
Signed-off-by: om7057 <[email protected]>
Signed-off-by: om7057 <[email protected]>
Author
|
@Joibel Could you please review the changes? |
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.
Runs markdown-spellcheck and markdownlint on individual .features/pending/*.md files during features-validate, catching errors early before release.
Fixes #15149
Motivation
When generating the new features document for release, it can fail markdown lint and spelling checks. Currently, these checks only run on the combined output (
docs/new-features.md) during release time. If individual feature files in.features/pending/*.mdhave lint or spelling errors, they're not caught until the release CI runs, causing unexpected failures.This PR addresses the first part of the issue: validating individual feature documents early so contributors can fix issues before release.
Modifications
Modified the
features-validatetarget inMakefileto:$(TOOL_MDSPELL)as a dependencymdspell) on individual.features/pending/*.mdfilesmarkdownlint) on individual feature files before they are combinedVerification
Tested locally by running: