sending to cran

[sckott]

What are things that need to be done or fixed, etc. before going to cran knowing what we know about the pain that is cran:

Tests

• Ignore all tests on cran except a very few trivial tests
  • Alternatively we could change tests so that we use mocks. I don't think we should spend time on this approach b/c it's much better for the health of the package to have more realistic tests against localstack/minio - tools that keep up with mirroring AWS services, whereas mocks will get out of date and we'd end up with tests that don't reflect current AWS reality

Examples

Currently using a mix of @examplesIf interactive() and @examples \dontrun{ for examples ...

• Make sure examples are NOT run during normal check; right now using examplesIf or dontrun, but we could try an approach like googledrive uses where it uses @examplesIf drive_has_token() - whereas we'd use a fxn like aws_has_creds().
  • I think we should use combination of two things, so: @examplesIf interactive() && aws_has_token() where aws_has_token checks if there is an access key, secret key, and region set. This means examples would only be checked locally in an interactive R session and with those secrets set.
• Where possible. allow examples to run - possible being safe to run, no chance of hitting AWS itself. Probably just util fxns
  • "For the initial CRAN submission of your package, all functions must have at least one example and the example code can’t all be wrapped inside \dontrun{}"

Ideally though (insert SNL gif here) we'd actually allow examples to run more easily, BUT we'd need a way to have some kind of mock AWS account that could be freely hammered with requests, and I don't think that exists

Unfortunately there's no good way of even knowing what credentials the user has, see #71

Vignettes/README

• Use pre-rendered vignettes. Already in place.

Other

There's sure to be other things that will come up later - this section covers all of those 😄