feat: add 'CI' envvar for ropensci-review-tools/roreviewapi#63 (#50)

Dockerfile

@@ -2,10 +2,11 @@ FROM ghcr.io/ropensci-review-tools/pkgcheck:latest
 LABEL maintainer="Jacob Wujciak-Jens <[email protected]>"
 
 ENV NOT_CRAN "true"
+ENV CI "ropensci"
 
 COPY R/check.R /check.R
 COPY R/install.R /install.R
 
 RUN ["Rscript", "/install.R"]
 
-ENTRYPOINT [ "Rscript", "/check.R" ]
+ENTRYPOINT [ "Rscript", "/check.R" ]

README.md

@@ -52,6 +52,15 @@ jobs:
 
 There are also several parameters which can be used to modify the workflow, as described in the following section.
 
+### Environment variables
+
+This action runs with one environment variable of `CI = "ropensci"`. This
+enables
+[`testthat::skip_on_ci()`](https://testthat.r-lib.org/reference/skip.html),
+which skips tests if a variable named "CI" is set, regardless of value.
+Alternately, tests can be fine-tuned to skip within `pkgcheck` by setting
+`testthat::skip_if(Sys.getenv("CI") == "ropensci")`.
+
 ### Workflow parameters
 
 The [`yaml` workflow