Merge pull request #533 from SimonStaehli/add_example_doc

r-lib · Apr 1, 2022 · 8a08bcc · 8a08bcc
2 parents 0f28cb5 + 453bbf1
commit 8a08bcc
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/check-r-package/README.md b/check-r-package/README.md
@@ -30,10 +30,27 @@ steps:
 - uses: r-lib/actions/setup-r@v2
 - uses: r-lib/actions/setup-r-dependencies@v2
   with:
-    extra-packages: rcmdcheck
+    extra-packages: any::rcmdcheck
+    needs: check
 - uses: r-lib/actions/check-r-package@v2
 ```
 
+With specified inputs:
+```yaml
+steps:
+- uses: actions/checkout@v2
+- uses: r-lib/actions/setup-r@v2
+- uses: r-lib/actions/setup-r-dependencies@v2
+  with:
+    extra-packages: any::rcmdcheck
+    needs: check
+- uses: r-lib/actions/check-r-package@v2
+    with:
+      args: 'c("--no-manual", "--as-cran")'
+      error-on: '"error"'
+      check-dir: '"check"'
+```
+
 # License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)