r-hub / docs Goto Github PK

add topic based on https://www.mail-archive.com/[email protected]/msg03932.html

same as r-hub/blog#23

devtools::check_rhub() allows to pass arguments to pkgbuild::build() before uploading the package to R-hub builder.

Have a subsection about it.

Explain why the email needs to be validated (results will be sent to it). The email can be another one than the maintainer, link to corresponding subsection.

Via the package, it's once and for all. Link to the reference/README section on the pkgdown site.

Via the webform, it's once per browser session. Either token sent by email to be copy-pasted, or via GitHub. (test if it works when it's not public, I guess it does).

i wonder whether there could be some text shown when the mouse is on "Email not validated" to say it'll be validated after tarball upload?

https://stat.ethz.ch/pipermail/r-package-devel/2019q3/004421.html

https://stat.ethz.ch/pipermail/r-package-devel/2019q3/004370.html

@gaborcsardi do you think the remark above could be useful to add to https://docs.r-hub.io/#rhub-cran-platforms? 🤔

• binaries are sometimes not available yet

• link to remotes vignette reg non CRAN dependencies https://cran.rstudio.com/web/packages/remotes/vignettes/dependencies.html

An architecture diagram would really help people understand how this hangs together. I've drafted one in mermaid as a starting point based on my understanding from the docs.

Mermaid JSFiddle

When using the webform one will need to verify one's email address once per browser session whereas with the package it's once per email address and computer (well until you erase validated_emails.csv).

• CRAN submission prep with rhub

• Submission with the form.

  • Only show the website but mention the .tar.gz needs to have been created via R CMD build/devtools::build()
  • First the normal tab, describe the three buttons.
  • Then the advanced tab, go over options, show help links.
  • End by clicking on "R-hub from R" :-D
    Keep it simple and short, will be re-recorded once the page is styled anyway.

Ex-METACRAN services maybe as their own section, called something like R/CRAN data or metadata.

• cranatgh

• cranlogs

• rversions

• pkgsearch (with crandb)

• special focus on ✨ badges ✨ (a special section?)

• Explain how system dependencies are installed on the different platforms. On some platforms, if something is missing, you won't be able to do anything about it yourself but will need to open an issue.

• Explain how to check a package's SystemRequirements field is parsed. Recommend to locally use sysreqs to check that for one's package?

Part of this in the docs, maybe another part in a blog post.

As complement to R-hub (/R-hub Docker images), link in https://docs.r-hub.io/#rhub-cran-platforms?

https://github.com/wch/r-debug
https://github.com/rocker-org/r-devel-san-clang
https://github.com/rocker-org/r-devel-san