map_testthat_snapshot: Run map_testthat on a GitHub Repository

View source: R/map_testthat_snapshot.R

map_testthat_snapshotR Documentation

Run map_testthat on a GitHub Repository

Description

Runs a covrpage on a GitHub repository in a sterile environment

Usage

map_testthat_snapshot(
  repo,
  branch = NULL,
  PAT = Sys.getenv("GITHUB_PAT"),
  host = "api.github.com"
)

Arguments

repo

character, Public GitHub repository

branch

character, Name of the branch to checkout. Default: NULL

PAT

character, GitHub Personal Access Token, Default: Sys.getenv("GITHUB_PAT")

host

character, GitHub API host to use, Default: "api.github.com"

Details

Creates a markdown output that is sent to the internal viewer.

Setting branch to NULL means that clone will use the remote's default branch.

Value

tibble

See Also

covrpage clone install_github

Other utility: coverage_skip(), covr_summary(), map_testthat(), map_test(), package_name(), testthat_summary()

Examples

## Not run: 
if(interactive()){
 map_testthat_snapshot('tidyverse/purrr')
 }

## End(Not run)

yonicd/covrpage documentation built on Feb. 23, 2023, 6:58 p.m.