Skip to content

Spell check fails on auto-generated CHANGELOG.md due to truncated commit titles #754

@WilliamBerryiii

Description

@WilliamBerryiii

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions