r-hub / rhub

R-hub API client
https://r-hub.github.io/rhub/
Other
353 stars 51 forks source link

NOTE from "R check" about hidden file ".github". #631

Closed rolfTurner closed 2 months ago

rolfTurner commented 2 months ago

I'm nearly there, thanks (hugely!) to wise counsel from Gábor Csárdi.

There's just one thing that bothers me slightly: when I run rhub::rhub_check(...) I get a NOTE from "R check" to the effect that it

Found the following hidden files and directories:
  .github
These were most likely included in error. See section 'Package
structure' in the 'Writing R Extensions' manual.

If I remove the .github directory, the procedure crashes at square zero with the problem described in the issue (630) that I previously raised: "Workflow does not have 'workflow_dispatch' trigger. Gábor explained to me that the file "rhub.yaml" is needed for rhub_check() to work, and that file lives in ".github".

So should I just ignore the aforementioned NOTE?

gaborcsardi commented 2 months ago

Add

^[.]github$

to your .Rbuildignore file.