Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check vignette build #2437

Open
infotroph opened this issue Sep 26, 2019 · 2 comments
Open

Check vignette build #2437

infotroph opened this issue Sep 26, 2019 · 2 comments
Assignees

Comments

@infotroph
Copy link
Member

infotroph commented Sep 26, 2019

Description

@dlebauer asked whether vignettes are built during the CI build, and we think the answer is "no, but it should be", possibly during the post-build documentation step instead of during testing. Need to investigate and fix if needed.

Context

Possible Implementation

@infotroph
Copy link
Member Author

infotroph commented Oct 4, 2019

  • No, the current build definitely does not build vignettes
  • Will need to at least add VignetteBuilder: knitr and Suggests: knitr to all package descriptions, and add ... vignette: > %\VignetteIndexEntry{ ... boilerplate to all vignette Rmd files.
  • Do we want to add the built vignettes or gitignore them? From my quick survey of R packages on GitHub, gitignore seems most common.
  • Not sure yet how much build time this will add, but likely substantial. May want to do this as a separate build stage, e.g. CI build keeps skipping vignettes at installation, then check separately with devtools::build_vignettes.
  • Separate issue from the CI build: do we want the vignettes by default during a bare-metal UNIX install? How about the Docker images?

@github-actions
Copy link

github-actions bot commented Oct 4, 2020

This issue is stale because it has been open 365 days with no activity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants