CI: Add misspell spelling checker tool and CI verification #11
Merged
Conversation
Signed-off-by: dongjiang <dongjiang1989@126.com>
Signed-off-by: dongjiang <dongjiang1989@126.com>
Contributor
Author
|
Use: $ make help
Usage:
make <target>
help Display this help.
clean Remove all generated files and directories.
Generating
toc-update Update table of contents in markdown files.
spelling-update Fix spelling errors in markdown files.
Checking
toc-verify Verify table of contents are up to date.
spelling-verify Verify spelling in markdown files.
Dependencies
tidy Tidy Go module dependencies. |
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
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
misspelltool integration for detecting and fixing spelling errors in markdown filesspelling-update(fix) andspelling-verify(check) Make targets, following the same pattern as existingtoc-update/toc-verifyspelling-verifyCI job in GitHub Actions to enforce spelling checks on PRstoc-updatejob totoc-verifyin CI for naming consistencymake helpawk regex to support aliased target namesChanges
MakefileMISSPELL_BINARY,spelling-update,spelling-verifytargets; updated binary install rule; fixed help regexscripts/tools.gogithub.com/client9/misspell/cmd/misspellimportscripts/go.mod/go.sum.github/workflows/check.ymlspelling-verifyjob; renametoc-updatejob totoc-verifyWhich issue(s) this PR fixes:
Fixes #
Special notes for reviewers:
Add misspell spelling checker tool and CI verification