ci: adds a ci file with a spellcheck job - #166
Conversation
Signed-off-by: Simon Essien <champbreed1@gmail.com>
f34b0f9 to
8a62083
Compare
|
@Champbreed Here is Claude's review: Scrutinized CI workflow configuration and identified security improvements I looked at PR #166 in oscal-compass/community. It's a small, single-commit CI addition — two new files, 28 lines total. What it does .github/workflows/ci.yml: adds a spellcheck job that runs on PRs targeting main, but only when **/*.md files change. It checks out the repo (full history via fetch-depth: 0) and runs rojopolis/spellcheck-github-actions. Good practices already in place Both third-party actions are pinned to a full commit SHA (with the version as a comment), not a mutable tag — this is the secure way to reference actions. Things I'd flag in review No visible spellcheck config file — rojopolis/spellcheck-github-actions typically needs a .spellcheck.yml (or similar) to define which paths/sources to scan, dictionary, and a wordlist for allowed technical terms. This PR only adds the workflow, not that config. Given this is the OSCAL Compass project, terms like "OSCAL," "trestle," "SSP," etc. will almost certainly trip a default dictionary and cause noisy false-positive failures unless a custom dictionary already exists elsewhere in the repo (worth asking the author to confirm, or checking). Overall: This is a clean, minimal, well-scoped CI addition with good security hygiene (pinned SHAs, least-privilege token, safe trigger). The main open question before merging is whether spellcheck config/dictionary exists so the job doesn't immediately fail on domain-specific vocabulary — I'd ask the author to confirm that or link a follow-up config PR. |
Adds a CI workflow to check for spelling mistakes in Markdown files on pull requests targeting main. This prevents grammar and spelling mistakes from being merged into the repository
Closes #17
cc: @vikas-agarwal76 @degenaro