use_covrpage: Add covrpage to Travis CI for a git directory

In metrumresearchgroup/covrpage: Create a Readme Summary Page for GitHub testthat and covr Outputs

Add covrpage to Travis CI for a git directory

Description

Adds bash file to execute after Travis test is successfully completed.

Usage

use_covrpage(
  file = ".travis/covrpage.sh",
  travis_type = c("bash", "pkgdown", "tic"),
  travis_blocks = c("after_success", "after_failure", "deploy_ghpages"),
  gh_user = gsub("@(.*?)$", "", system("git config user.email", intern = TRUE)),
  push_branch = "test",
  repo = system("git config travis.slug", intern = TRUE),
  deploy_branch = system("git rev-parse --abbrev-ref HEAD", intern = TRUE)
)

Arguments

file	character, file path to save bash script to, Default: '.travis/covrpage.sh'
travis_type	character, build .travis.yml template for bash script, pkgdown deployment or using the 'tic' package from ropenscilabs on GitHub Default: c('bash','pkgdown','tic')
travis_blocks	character, vector that defines what .travis.yml blocks tocreate, Default: c('after_success','after_failure','deploy_ghpages')
gh_user	character, Github user name, Default: gsub("@(.*?)$", "", system("git config user.email", intern = TRUE))
push_branch	character, branch Travis will create to push updated covrpage readme file, Default: 'test'
repo	character, name of git repo that package is hosted on, Default: system("git config travis.slug", intern = TRUE)
deploy_branch	character, name of branch that current package build is located, Default: system("git rev-parse –abbrev-ref HEAD", intern = TRUE) (usually 'master')

See Also

Other setup: make_badge(), tencrypt(), use_covrpage_vignette()

Examples

use_covrpage(travis_type = 'bash',file=file.path(tempdir(),'myfile.sh'))

#does not write to disk
use_covrpage(travis_type = 'bash',file=NULL)

use_covrpage(travis_type = 'pkgdown')
use_covrpage(travis_type = 'pkgdown',travis_block = 'after_success')
use_covrpage(travis_type = 'pkgdown',travis_block = 'after_failure')
use_covrpage(travis_type = 'pkgdown',travis_block = c('after_success','after_failure'))

metrumresearchgroup/covrpage documentation built on Feb. 25, 2023, 2:22 p.m.