Summary
.github/workflows/check-spelling.yaml is hand-rolled and running on a stale toolchain. Morrison-Lab/gha ships a maintained equivalent, spellcheck.yml@v2, which this repo could call with a small stub instead.
Filed while migrating the other workflows to gha (#100, #101, #102, #103, #104) --- this one had no tracking issue.
The staleness is the concrete problem
container:
image: rocker/tidyverse:4.1.2 # R 4.1.2, released 2021-11
steps:
- uses: actions/checkout@v3 # superseded; v3 runs on a deprecated Node
- uses: insightsengineering/r-spellcheck-action@v3.0.2
Nothing here is pinned by SHA, and the container pins an R release four years old. The rest of this repo's workflows are on actions/checkout@v4.
Why gha's version fits
The repo already has everything spellcheck.yml expects: a DESCRIPTION, tests/spelling.R, and spelling in Suggests:. gha's workflow spellchecks DESCRIPTION's Title/Description, man/*.Rd, vignette sources, and root README/NEWS/CHANGES/index Markdown with {spelling}, accepting the package's own inst/WORDLIST. It is read-only, so it needs no permissions: block and no secrets.
What to check before assuming it is a drop-in
This is the part that needs a real diff rather than a swap, because the two tools spellcheck different file sets:
insightsengineering/r-spellcheck-action and {spelling} do not necessarily cover the same paths. This is a Quarto website --- its prose lives in 14 .qmd files (index.qmd, team.qmd, publications.qmd, people/**, opportunities/**), not in man/ or vignettes/. Confirm what the current action actually scans today before replacing it, or the migration could silently stop checking the files that matter most here.
inst/WORDLIST --- check whether one exists and is being honoured today.
- If gha's
spellcheck.yml turns out not to reach .qmd prose, the right answer may be to adopt it for the package surface and separately request .qmd coverage upstream in Morrison-Lab/gha, rather than forcing it.
What to do
- Determine the current action's actual file coverage on this repo (read a recent successful run's log).
- Diff that against what gha's
spellcheck.yml@v2 covers, per gh api "repos/Morrison-Lab/gha/contents/.github/workflows/spellcheck.yml?ref=v2".
- If coverage is preserved or improved, replace with the
examples/spellcheck.yml stub. If it is not, say so on this issue and leave the workflow hand-rolled with that reason recorded.
Scope
Tracking issue only, not implementing yet. Independent of the other gha migrations --- no shared files, no ordering constraint.
Summary
.github/workflows/check-spelling.yamlis hand-rolled and running on a stale toolchain.Morrison-Lab/ghaships a maintained equivalent,spellcheck.yml@v2, which this repo could call with a small stub instead.Filed while migrating the other workflows to gha (#100, #101, #102, #103, #104) --- this one had no tracking issue.
The staleness is the concrete problem
Nothing here is pinned by SHA, and the container pins an R release four years old. The rest of this repo's workflows are on
actions/checkout@v4.Why gha's version fits
The repo already has everything
spellcheck.ymlexpects: aDESCRIPTION,tests/spelling.R, andspellinginSuggests:. gha's workflow spellchecksDESCRIPTION'sTitle/Description,man/*.Rd, vignette sources, and rootREADME/NEWS/CHANGES/indexMarkdown with{spelling}, accepting the package's owninst/WORDLIST. It is read-only, so it needs nopermissions:block and no secrets.What to check before assuming it is a drop-in
This is the part that needs a real diff rather than a swap, because the two tools spellcheck different file sets:
insightsengineering/r-spellcheck-actionand{spelling}do not necessarily cover the same paths. This is a Quarto website --- its prose lives in 14.qmdfiles (index.qmd,team.qmd,publications.qmd,people/**,opportunities/**), not inman/orvignettes/. Confirm what the current action actually scans today before replacing it, or the migration could silently stop checking the files that matter most here.inst/WORDLIST--- check whether one exists and is being honoured today.spellcheck.ymlturns out not to reach.qmdprose, the right answer may be to adopt it for the package surface and separately request.qmdcoverage upstream inMorrison-Lab/gha, rather than forcing it.What to do
spellcheck.yml@v2covers, pergh api "repos/Morrison-Lab/gha/contents/.github/workflows/spellcheck.yml?ref=v2".examples/spellcheck.ymlstub. If it is not, say so on this issue and leave the workflow hand-rolled with that reason recorded.Scope
Tracking issue only, not implementing yet. Independent of the other gha migrations --- no shared files, no ordering constraint.