Skip to content

Commit 34133f7

Browse files
committed
Update test advice a bit, remove note about urlchecker
1 parent ef62b86 commit 34133f7

File tree

1 file changed

+10
-20
lines changed

1 file changed

+10
-20
lines changed

MAINTENANCE.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,16 @@ The state of cpp11 is pretty stable, it seems to have the features we need for m
77
### Running the cpp11test tests
88

99
Most of the test suite is in a sub-package, cpp11test.
10-
Probably the best way to run these tests is to install the development version of cpp11 and then run `devtools::test()` to run the cpp11test test suite.
10+
The best way to run these tests is to install the development version of cpp11 after any change, and then run `devtools::test("./cpp11test")`.
11+
Precisely, this looks like:
12+
13+
```r
14+
# Install dev cpp11, clean the cpp11test dll manually since it thinks nothing
15+
# has changed, then recompile and run its tests.
16+
devtools::install()
17+
devtools::clean_dll("./cpp11test")
18+
devtools::test("./cpp11test")
19+
```
1120

1221
If tests failures occur the output from Catch isn't always easy to interpret.
1322
I have a branch of testthat https://github.com/jimhester/testthat/tree/catch-detailed-output that should make things easier to understand.
@@ -17,25 +26,6 @@ In addition getting a debugger to catch when errors happen can be fiddly when ru
1726

1827
The GitHub Actions workflow has some additional logic to handle running the cpp11 tests https://github.com/r-lib/cpp11/blob/fd8ef97d006db847f7f17166cf52e1e0383b2d35/.github/workflows/R-CMD-check.yaml#L95-L102, https://github.com/r-lib/cpp11/blob/fd8ef97d006db847f7f17166cf52e1e0383b2d35/.github/workflows/R-CMD-check.yaml#L117-L124.
1928

20-
### False positive URL checks for git repositories in the vignettes
21-
22-
If you run `urlchecker::url_check()` on the repo you will see the following false positives.
23-
24-
```
25-
! Warning: vignettes/motivations.Rmd:363:11 Moved
26-
git clone https://github.com/r-lib/cpp11.git
27-
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28-
https://github.com/r-lib/cpp11
29-
! Warning: vignettes/motivations.Rmd:354:11 Moved
30-
git clone https://github.com/RcppCore/Rcpp.git
31-
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32-
https://github.com/RcppCore/Rcpp
33-
>
34-
```
35-
36-
These only happen with the urlchecker package, they can be safely ignored and the real CRAN checks will not show them.
37-
38-
3929
## Ensure you use `Sys.setenv("CPP11_EVAL" = "true"); devtools::submit_cran()` when submitting.
4030

4131
If you forget to set `CPP_EVAL = "true"` then the vignette chunks will not run properly and the vignettes will not be rendered properly.

0 commit comments

Comments
 (0)