Skip to content

Commit 8cdc630

Browse files
committed
[setup-renv]: improve README
1 parent 35c9f4c commit 8cdc630

1 file changed

Lines changed: 3 additions & 15 deletions

File tree

setup-renv/README.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,22 @@ Forwarded to
1616
[`renv::activate()`](https://rstudio.github.io/renv/reference/activate.html). It
1717
must be an R expression. Note that you often need to quote it, see details
1818
below.
19-
20-
Basic:
21-
22-
```yaml
23-
steps:
24-
- uses: actions/checkout@v3
25-
- uses: r-lib/actions/setup-r@v2
26-
- uses: r-lib/actions/setup-renv@v2
27-
with:
28-
profile: "'shiny'"
29-
```
30-
3119
- `cache-version` - default `1`. If you need to invalidate the existing cache pass any other number and a new cache will be used.
3220

33-
Basic:
21+
Example:
3422

3523
```yaml
3624
steps:
3725
- uses: actions/checkout@v3
3826
- uses: r-lib/actions/setup-r@v2
3927
- uses: r-lib/actions/setup-renv@v2
4028
with:
41-
cache-version: 2
29+
profile: '"shiny"'
4230
```
4331
4432
## Quoting R expressions
4533
46-
Several input arguments must be specified as an R expression.
34+
The `profile` input parameter must be specified as an R expression.
4735
This increases flexibility, but it also causes some inconvenience, since
4836
these expressions often need to be quoted in the YAML file.
4937
A handy tip is that if your R expression does not contain a single quote,

0 commit comments

Comments
 (0)