Skip to content

fix: Restrict CSpell to just markdown files at the configuration level#518

Closed
easymac wants to merge 2 commits intomainfrom
mc/cspell-scope
Closed

fix: Restrict CSpell to just markdown files at the configuration level#518
easymac wants to merge 2 commits intomainfrom
mc/cspell-scope

Conversation

@easymac
Copy link
Contributor

@easymac easymac commented Mar 21, 2026

Not sure if this will work as intended.

This fix moves the file scoping into .cspell.yaml itself, the project-level config, so that no matter which runner invokes CSpell or how it's configured, only markdown files get checked. The Shorebird CI pulls in a separate.cspell.yaml workflow that runs CSpell with no file filter, so it checked all files. This should allow us to only be spell checking markdown as intended and not be failing CI (DEV) because of misspellings in, for example, package.json.

@eseidel
Copy link
Contributor

eseidel commented Mar 21, 2026

Where was the file scoping before?

@easymac
Copy link
Contributor Author

easymac commented Mar 21, 2026

The GitHub Action .github/workflows/main.yaml was already passing includes: **/*.md, **/*.mdx, but the CI configuration pulls in a different configuration:

ci-worker-docs… workflowUrl: https://storage.googleapis.com/storage/v1/b/shorebird-workflows-dev/o/workflows%2F2007%2FCSpell.yaml?alt=media

Threw this at the wall to see if the project-level configuration would override it; seems to have failed. I'll have to look into CI more closely to see where/how configuration needs to be updated.

(CI would probably still fail on the codecov problem we fixed in prod anyway)

@eseidel
Copy link
Contributor

eseidel commented Mar 21, 2026

The reason why I ask is that Shorebird CI is designed to be zero-config. So if there are other config spots that we aren't reading for CSpell and should be, that is a problem. But main.yaml is not a CSpell config spot, rather a GitHub Actions config so it seems fine for us to ignore. Thanks!

@easymac easymac closed this Mar 21, 2026
@easymac easymac deleted the mc/cspell-scope branch March 21, 2026 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants