Skip to content

[Bug]: cspell configuration missing GHSA and logs/ exclusion #213

@WilliamBerryiii

Description

@WilliamBerryiii

Component

Scripts

Bug Description

The cspell configuration in .cspell.json is missing:

  1. GHSA word - GitHub Security Advisory IDs (format: GHSA-xxxx-xxxx-xxxx) appear in CHANGELOG.md when documenting security fixes but are flagged as unknown words.

  2. logs/** in ignorePaths - The logs/ folder contains generated output files (like sha-staleness-results.json) that should not be spell-checked, consistent with other generated/output paths already excluded.

  3. autobuild word - 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

  1. Run npm run spell-check
  2. 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.

Metadata

Metadata

Labels

bugSomething isn't workingneeds-triageRequires triage and prioritization

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions