Skip to content

Restore the codespell config and keep it out of the R package build - #828

Open
chenyangsu wants to merge 1 commit into
OHDSI:mainfrom
chenyangsu:ci/restore-codespell-config
Open

chenyangsu wants to merge 1 commit into
OHDSI:mainfrom
chenyangsu:ci/restore-codespell-config

Conversation

@chenyangsu

Copy link
Copy Markdown

The "Check for spelling errors" job has failed on main, and so on every PR, since .codespellrc was removed for the CRAN submission in aa047a3. Without the config, codespell reports hundreds of false positives from docs/site_libs, the archived PDFs, and terms such as EHR, infarction and pilon. @DG47 suggested this fix in #822.

Change

  • Restore .codespellrc exactly as it was before aa047a3, with one edit: ignore-regex now matches any base64 image (data:image/[a-z]+;base64) instead of only PNG. Newer codespell dictionaries flag letters inside the JPEG embedded in extras/archive/OMOP_CDM_PDF.html.
  • Add ^\.codespellrc$ to .Rbuildignore, so R CMD check no longer reports a hidden file. That was the reason for removing it.
  • Fix "suport" in NEWS.md, the one real typo left.

Check

  • codespell --count . (2.4.3, the version the action installs) reports 0.
  • R CMD build produces CommonDataModel_1.1.0.tar.gz with no hidden files.

The Codespell workflow has failed on main since the config was removed
for the CRAN submission (aa047a3): without it, codespell flags hundreds of
false positives in docs/site_libs, the archived PDFs and terms such as EHR.

- Restore .codespellrc from before aa047a3. Widen its ignore-regex from
  PNG to any base64 image, since newer codespell dictionaries flag letters
  inside the JPEG embedded in extras/archive/OMOP_CDM_PDF.html.
- Add ^\.codespellrc$ to .Rbuildignore so R CMD check does not report it
  as a hidden file, which is why it was removed.
- Fix "suport" in NEWS.md, the one real typo left.

codespell 2.4.3 now reports 0 problems, and R CMD build produces a tarball
with no hidden files.

This branch has not been deployed

No deployments
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.

1 participant