dev_cicd: Continuous Integration (CI) / Continuous Deployment (CD)...

In tjpalanca/tjutils: Utilities for TJ Palanca

Description

Tools for developing the testing and deployment workflows for subsequent packages.

Usage

dev_cicd_in_github_actions()

dev_cicd_in_covr()

dev_cicd_schema(short_pkg_name = tolower(dev_pkg_name(envir = parent.frame())))

dev_cicd_test_package(..., stop_on_failure = TRUE)

dev_cicd_test_coverage(
  ...,
  min_test_coverage = 80,
  assert = dev_cicd_in_github_actions(),
  envir = parent.frame()
)

dev_cicd_test_linting(
  ...,
  max_lint_results = 0L,
  assert = dev_cicd_in_github_actions()
)

dev_cicd_test_spelling(
  ...,
  max_spelling_errors = 0L,
  assert = dev_cicd_in_github_actions()
)

dev_cicd_shinytest(app_name)

Arguments

short_pkg_name	a shortened package name in case schema generated is sometimes too long
stop_on_failure	see devtools::test
min_test_coverage	minimum test coverage in percentage points
assert	whether to error on max typos
max_lint_results	max number of linting results without raising error
max_spelling_errors	maximum typos tolerated
parent_env	parent environment for package namespacing

Functions

• dev_cicd_in_github_actions: Determines whether the workflow is running in GitHub Actions

• dev_cicd_in_covr: Determines whether the workflow is running in covr

• dev_cicd_schema: Name of the test schema according to github actions

• dev_cicd_test_package: Run the unit tests described in this package

• dev_cicd_test_coverage: Measure and report the test coverage of this package

• dev_cicd_test_linting: Use linting tools to statically check the code for errors and style irregularities.

• dev_cicd_test_spelling: Spell checks the documentation.

• dev_cicd_shinytest: Runs shiny functional tests

tjpalanca/tjutils documentation built on Jan. 20, 2021, 2:01 p.m.