Variant that exits (with a non-zero error code) if the check fails

[jimhester]

This is useful for use in CI systems which fail the build when a command returns a non-zero exit status.

Could be a option in the print.rcmdcheck method or just an option in rcmdcheck::rcmdcheck() directly maybe.

[gaborcsardi]

IDK, it feel awkward if a function call can exit from your session. Maybe this could be handled by the script that calls it? E.g.

R -e 'rc <- rcmdcheck::rcmdcheck(); q(status = length(failures(rc)))'

(The failures function does not exist currently.)

[gaborcsardi]

Or we can have another function that is a small wrapper?

[jimhester]

Yeah another function would work. It doesn't have to call q(), it can just return an error with stop() and that sets the exit status appropriately if it is the last command.

$ R -q -e 'stop()'
> stop()
Error:
Execution halted
$ echo $?
1

[gaborcsardi]

Yeah, stop is better.

[gaborcsardi]

Do you want to fail on NOTEs as well? Probably not, right?

[gaborcsardi]

Btw. why would you run rcmdcheck on the CI, instead of just R CMD check?

[ClaytonJY]

Jim started this partially from a discussion we had on Ropensci; I want to use rmdcheck in CI because I think it (or devtools::check currently) gives superior output, and because I want my CI output to match what I get locally with RStudio + devtools. No more "why do I get these complaints locally, but not on CI?".

[jimhester]

I think having an option whether to stop for errors, warnings or notes makes the most sense.

[gaborcsardi]

But you don't actually want to stop when a NOTE/WARNING/ERROR happens, right? Only after the check is complete?

[jimhester]

Yeah

[gaborcsardi]

OK, added an error_on argument, please check it out.