actions icon indicating copy to clipboard operation
actions copied to clipboard

Documentation check

Open hadley opened this issue 4 years ago • 7 comments

  • Run roxygen2::roxygenise() and check no files changed
  • Check that pkgdown::build_reference_index() is ok
  • Spellcheck?
  • URL check?

hadley avatar Mar 29 '21 18:03 hadley

Look at what Shiny does.

hadley avatar Mar 29 '21 18:03 hadley

Do you still want these as separate actions? Or as an example workflow that does all of them?

gaborcsardi avatar Dec 10 '21 10:12 gaborcsardi

Let's wait for @schloerke since this is something that Shiny already does.

We should also think about compiling translation files .mo as part of this step.

hadley avatar Dec 10 '21 13:12 hadley

Hadley, do you still want an action and/or workflow for these?

TBH it does not seem practical to introduce new jobs for these.

  • Maybe the roxygen2::roxygenise() check could be part of the check-r-package action?
  • pkgdown we already "check" in the pkgdown action, which now also runs for PRs
  • Spellcheck could be also part of the check-r-package action, optionally.
  • We could turn on URL checks in R CMD check, or run the URL checks as part of the check-r-package action.

gaborcsardi avatar Oct 19 '22 12:10 gaborcsardi

Yeah, I think the best way to handle these would be to introduce additional features/functions in rcmdcheck, and then set those options for actions.

hadley avatar Oct 19 '22 12:10 hadley

This is blocked by new features in rcmdcheck.

gaborcsardi avatar Oct 20 '22 08:10 gaborcsardi