Skip to content

Commit 3460239

Browse files
committed
Add stub maintenance doc
1 parent 6e735c7 commit 3460239

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ script.R
2424
^revdep$
2525
^talk$
2626
\.cache$
27+
^MAINTENANCE\.md$

MAINTENANCE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Current state
2+
3+
## Known outstanding issues
4+
5+
### False positive URL checks for git repositories in the vignettes
6+
7+
If you run `urlchecker::url_check()` on the repo you will see the following false positives.
8+
9+
```
10+
! Warning: vignettes/motivations.Rmd:363:11 Moved
11+
git clone https://github.com/r-lib/cpp11.git
12+
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13+
https://github.com/r-lib/cpp11
14+
! Warning: vignettes/motivations.Rmd:354:11 Moved
15+
git clone https://github.com/RcppCore/Rcpp.git
16+
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17+
https://github.com/RcppCore/Rcpp
18+
>
19+
```
20+
21+
These only happen with the urlchecker package, they can be safely ignored and the real CRAN checks will not show them.
22+
23+
24+
### Ensure you use `Sys.setenv("CPP11_EVAL" = "true"); devtools::submit_cran()` when submitting.
25+
26+
If you forget to set `CPP_EVAL = "true"` then the vignette chunks will not run properly and the vignettes will not be rendered properly.
27+
28+
## Future directions

0 commit comments

Comments
 (0)