Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically add .github directory to .Rbuildignore #594

Open
hezibu opened this issue Apr 11, 2024 · 2 comments
Open

Automatically add .github directory to .Rbuildignore #594

hezibu opened this issue Apr 11, 2024 · 2 comments

Comments

@hezibu
Copy link

hezibu commented Apr 11, 2024

First of all, many thanks for the package - new version works well and I love the use of github actions.

I've encountered the following NOTE using rhub::rhub_check():

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.

CRAN-pack does not know about
  .github

Adding .github to .Rbuildignore eliminates this NOTE.
I was wondering if rhub::rhub_setup() should automatically add .github to .Rbuildignore or throw a message in the console to do so prior to using rhub::rhub_check() in case it is not added yet.

Thanks

@gaborcsardi
Copy link
Collaborator

Thanks for the feedback, I guess rhub_check() or rhub_doctor() could give you a hint.

OTOH you'll probably get the same note if you run R CMD check locally, so maybe people will see it early?

@hezibu
Copy link
Author

hezibu commented Apr 11, 2024

I ran R CMD check immediately before and didn't think twice and did rhub_setup() -> rhub_doctor() -> rhub_check()

Either way, this issue will serve as a reference when people will encounter this note locally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants