Add pkgdown reference coverage check to CI#337
Conversation
|
The current failure is with the topic |
…mmfit topic Co-authored-by: venpopov <12783882+venpopov@users.noreply.github.com>
venpopov
left a comment
There was a problem hiding this comment.
there was no need to modify the github action, tests already run automatically. Other than that, I tested it locally and it works nicely
venpopov
left a comment
There was a problem hiding this comment.
cmd check fails:
Error: Error: R CMD check found WARNINGs
Duration: 2m 57.8s
Execution halted
❯ checking for unstated dependencies in ‘tests’ ... WARNING
'::' or ':::' import not declared from: ‘yaml’
…y warning Co-authored-by: venpopov <12783882+venpopov@users.noreply.github.com>
Fixed in 05dbe7f — added |
New public topics added to the package silently break the pkgdown website build because
_pkgdown.ymlcoverage is only validated during site deployment, not on PRs.Changes
tests/testthat/test-pkgdown.R— new test that parses all non-\keyword{internal}.Rdtopics and verifies each is covered by_pkgdown.yml'sreferencesection, including expansion ofhas_keyword("xxx")selectors. Skips gracefully when_pkgdown.ymlis absent (i.e., inside the R CMD CHECK tarball, where it's excluded via.Rbuildignore). The test runs automatically as part of the existing R CMD CHECK workflow since tests are run from the source checkout._pkgdown.yml— addspp_check.bmmfitto the "Fitting models" section; this was the only non-internal topic missing from the reference index.DESCRIPTION— addsyamltoSuggeststo resolve the R CMD CHECK warning about an undeclared::import used in the new test..github/workflows/R-CMD-check.yaml— addsyamlto theextra-packageslist so it is installed during CI runs.Tests
Release notes
Internal: pkgdown reference completeness is now validated on every PR via the existing R-CMD-check workflow.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.