dev_use_gha: Development Utilities: Github Actions

In tjpalanca/tjutils: Utilities for TJ Palanca

Description

Convenience functions for adding github actions workflows to the R package for Continuous Integration and Deployment.

• dev_use_gha_dockerfile() Adds a Dockerfile that is designed to conform to our standard Dockerfile template. This has common Linux dependencies, all the package dependencies specified in the package DESCRIPTION file, and current package installation.

• dev_use_gha_makefile() Adds a feature-rich Makefile that contains common commands for building, publishing and releasing the package. This is used by workflow files in Github Actions.

• dev_use_gha_workflows() Adds automerge, testing, and deployment for packages. Testing runs building of Docker image, testthat() test suite, lintr linting, and spelling spell checks.

Usage

dev_use_gha_dirs()

dev_use_gha_dockerfile(type, overwrite = FALSE, envir = parent.frame())

dev_use_gha_makefile(type, overwrite = FALSE, envir = parent.frame())

dev_use_gha_workflows(type, overwrite = FALSE, envir = parent.frame())

Arguments

type	type of setup (package, golem)
overwrite	overwrite the files if they exist

Functions

• dev_use_gha_dirs: Setup directories

• dev_use_gha_dockerfile: Setup Dockerfile

• dev_use_gha_makefile: Standard Makefile template

• dev_use_gha_workflows: Add github actions workflows for automerging, testing, and deployment that confirm to github actions standards

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