-
Notifications
You must be signed in to change notification settings - Fork 125
Description
Component
Scripts
Bug Description
The cspell configuration in .cspell.json is missing:
-
GHSAword - GitHub Security Advisory IDs (format:GHSA-xxxx-xxxx-xxxx) appear in CHANGELOG.md when documenting security fixes but are flagged as unknown words. -
logs/**in ignorePaths - Thelogs/folder contains generated output files (likesha-staleness-results.json) that should not be spell-checked, consistent with other generated/output paths already excluded. -
autobuildword - This is a GitHub CodeQL action name (github/codeql-action/autobuild) that appears in log output.
Expected Behavior
npm run spell-check should pass with 0 issues when CHANGELOG.md contains valid GitHub Security Advisory IDs and when generated log files are present in the logs/ folder.
Steps to Reproduce
- Run
npm run spell-check - Observe 2 issues found:
CHANGELOG.md:67:24- Unknown word (GHSA)logs/sha-staleness-results.json:16:37- Unknown word (autobuild)
Additional Context
This causes spell-check failures in CI pipelines, specifically blocking release-please PR #212 for v1.2.0 release.
Proposed Fix: Update .cspell.json to add logs/** to ignorePaths and add GHSA and autobuild to words array.