-
Notifications
You must be signed in to change notification settings - Fork 126
Description
Problem
The Spell Check CI job fails on the release-please branch because CHANGELOG.md contains truncated words from squash-merged commit titles.
GitHub's squash merge truncates long PR titles at approximately 72 characters, producing artifacts like Spac (truncated from Space). Release-please copies these truncated titles verbatim into CHANGELOG.md. CSpell then flags the truncation artifacts as unknown words, causing CI failures.
Example from the current release-please branch:
CHANGELOG.md:24:66 - Unknown word (Spac)
This will recur whenever a squash-merged PR title exceeds GitHub's character limit.
Proposed Fix
Add CHANGELOG.md to the ignorePaths array in .cspell.json. Since this file is auto-generated by release-please (and marked "Do not edit manually"), spell-checking it provides no editorial value. Whole-file exclusion is the correct long-term fix for machine-generated content.
References
- Failing run: https://github.com/microsoft/hve-core/actions/runs/22325504301
- Source commit:
ac939aaonrelease-please--branches--main