Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroen committed Apr 2, 2024
1 parent 695a6b1 commit 110896e
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,26 @@ CRAN Debian server. Therefore we do not need to worry about system requirements:
if the package can be built on CRAN, it can also build in the rcheckserver containers.


## How to use in local R
## How to run locally

This will check your package and reverse dependencies from CRAN in your local R:

```r
recheck::recheck("mypackage_1.0.tar.gz")
```

To run this on GitHub actions use:
Alternatively to run it in the Ubuntu container, you need to mount a local source package in the container and then pass the path as an argument. For example:

```sh
# Download some example file:
# curl -OL "https://ropensci.r-universe.dev/src/contrib/qpdf_1.3.3.tar.gz"
docker run -it -v "qpdf_1.3.3.tar.gz:/qpdf_1.3.3.tar.gz" ghcr.io/r-universe-org/recheck "/qpdf_1.3.3.tar.gz"
```

Or you can pass a URL to a public source package:

```sh
docker run -it ghcr.io/r-universe-org/recheck "https://ropensci.r-universe.dev/src/contrib/qpdf_1.3.3.tar.gz"
```

## How to run on GitHub Actions

0 comments on commit 110896e

Please sign in to comment.