Documentation check - Githubissues

r-lib / actions

GitHub Actions for the R community

Creative Commons Zero v1.0 Universal

968 stars 216 forks source link

Open hadley opened 3 years ago

hadley commented 3 years ago

hadley commented 3 years ago

Look at what Shiny does.

gaborcsardi commented 2 years ago

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

hadley commented 2 years ago

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.

gaborcsardi commented 2 years ago

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.

hadley commented 2 years ago

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.

gaborcsardi commented 2 years ago

This is blocked by new features in rcmdcheck.

AlexAxthelm commented 5 months ago

Our team has a pretty simple workflow that we call that has been handling our needs for this https://github.com/RMI-PACTA/actions/blob/main/.github/workflows/R-check-docs.yml