Add .gitlab-ci.yml file in your current project from template

use_gitlab_ci(
  image = "rocker/verse:latest",
  path = ".gitlab-ci.yml",
  overwrite = TRUE,
  add_to_Rbuildignore = TRUE,
  type = "check-coverage-pkgdown",
  upgrade = TRUE
)

Arguments

image: Docker image to use in GitLab ci. If NULL, not specified!
path: destination path for writing GitLab CI yml file
overwrite: whether to overwrite existing GitLab CI yml file
add_to_Rbuildignore: add CI yml file and cache path used inside the CI workflow to .Rbuildignore?
type: type of the CI template to use
upgrade: whether to upgrade the R packages to the latest version during the CI. Default to TRUE.

Value

Used for side effects. Creates a .gitlab-ci.yml file in your directory.

Details

Types available are:

"check-coverage-pkgdown": Check package along with Code coverage with 'covr' and 'pkgdown' site on GitLab Pages
"check-coverage-pkgdown-renv": Check package built in a fixed 'renv' state along with Code coverage with 'covr' and 'pkgdown' site on GitLab Pages.
"bookdown": Build 'bookdown' HTML and PDF site on GitLab Pages
"bookdown-production": Build 'bookdown' HTML and PDF site on GitLab Pages. Where there will be a version of the book for each branch deployed. See https://github.com/statnmap/GitLab-Pages-Deploy for setup details.

Examples

# Create in another directory
use_gitlab_ci(
  image = "rocker/verse:latest",
  path = tempfile(fileext = ".yml")
)
#> GitLab CI file created at /tmp/Rtmpd5aMkf/file166974f21252.yml
if (FALSE) {
# Create in your current project with template for packages checking
use_gitlab_ci(image = "rocker/verse:latest", type = "check-coverage-pkgdown")
}