pizzarr icon indicating copy to clipboard operation
pizzarr copied to clipboard

Fail in CI if NAMESPACE or Roxygen docs are out of date

Open keller-mark opened this issue 2 years ago • 1 comments

User story

Even though these are a bit redundant to commit to the repo, I think they are needed for installation from github or from source to work properly.

Preferred solution

Fail in CI if NAMESPACE or Roxygen docs are out of date (e.g., if devtools::document() results in modified files).

Possible alternatives

Add a github actions workflow to automatically commit corrected files back to the main branch

keller-mark avatar Aug 25 '23 13:08 keller-mark

Interesting use case -- do you know of any packages that do this? Mine do not. I rebuild roxygen when I build / install and always check in synced up documentation and namespace.

dblodgett-usgs avatar May 20 '24 01:05 dblodgett-usgs