Spell check action for markdown documentation #8675
Merged
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
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
This is limited to `.md` files in the `docs/` directory by an entry in the `only.txt` file. If that file is empty/removed, all files not otherwise excluded would be checked. To check additional paths, you can add additional lines to match them. Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
|
The force push was to fix a grammatical botch in the commit message 😊 . This is a spell checker, not a grammar checker, and I'm in a hurry (my day ends momentarily). Sorry about that... |
|
@jekyllbot: merge +dev |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This is a 🙋 feature or enhancement.
Summary
Add the check-spelling action limited to
docs/directory.mdfiles.Context
Based on @DirtyF #8661 (comment)
Note: as currently configured, pushes get a comment, and PRs get another, this may feel like duplication, but it enables contributors to enable actions in their forks and get feedback before creating a PR.
I'm still looking into ways to address this duplication.
It's software, as with everything else, so there are bugs
prereleasebranch, but generally I prefer for public projects to use released versions).prerelease).There's one more feature that I'm working on which I'd like to finalize before my next release (hopefully in a week or so, I failed to notice where I was in the calendar, which is very ironic, as I've been literally counting the days).
Landing advice
For any fast moving repository, the initial merge tends to be a bit rocky. Between when #8661 was written and when it was merged, two additional typos were added just to the documentation directory.
The person merging this should enable actions in their fork and test the merged result (the easiest thing to do is make this branch the repository's default and create a PR from jekyll/jekyll
masterinto their repository (withspell-checkas the default) -- you can use check-spelling/jekyll as that repository if you like, as it's set up (but I won't be able to make changes to it, so you're probably better served using your own fork). If it gets a ✅ from check-spelling, then it's safe to merge. If it gets a ❌ , there will be a comment identifying the words that are unrecognized. They can be added toexpect.txtif they're intended, or fixed if they're errors.It's best to do that before merging. If you merge with a ❌ then anyone who uses that landing point for their branch point will get slightly confusing ❌ feedback on their branch. (Their PR could still report a ✅ if
masterfixed because of the configuration of the workflow, but the confusion is confusing.)Sadly, I won't be able to provide much help between now and Wednesday. Generally I'm fairly responsive (w/in 2 days).
If you have a communications channel that you use and want help w/ the landing, let me know (again, I can help from Wednesday). Have a good weekend/week.