DSL

tic-package

tic: Tasks Integrating Continuously: CI-Agnostic Workflow Definitions

get_stage() add_step() add_code_step()

tic's domain-specific language

dsl_get() dsl_load() dsl_init()

Stages and steps

YAML templates

update_yml()

Update tic YAML Templates

use_circle_yml() use_ghactions_yml()

Use CI YAML templates

use_update_tic()

Update tic Templates

Macros

macro

Macros

do_blogdown()

Build a blogdown site

do_bookdown()

Build a bookdown book

do_drat()

Build and deploy drat repository

do_package_checks()

Add default checks for packages

do_pkgdown()

Build pkgdown documentation

do_readme_rmd()

Render a R Markdown README and deploy to Github

list_macros()

List available macros

Steps

step_add_to_drat()

Step: Add built package to a drat

step_add_to_known_hosts()

Step: Add to known hosts

step_build_blogdown()

Step: Build a Blogdown Site

step_build_bookdown()

Step: Build a bookdown book

step_build_pkgdown()

Step: Build pkgdown documentation

step_do_push_deploy()

Step: Perform push deploy

step_hello_world()

Step: Hello, world!

step_install_deps() step_install_cran() step_install_github()

Step: Install packages

step_install_ssh_keys()

Step: Install an SSH key

step_push_deploy()

Step: Setup and perform push deploy

step_rcmdcheck()

Step: Check a package

step_run_code()

Step: Run arbitrary R code

step_session_info()

Step: Print the current Session Info

step_setup_push_deploy()

Step: Setup push deploy

step_setup_ssh()

Step: Setup SSH

step_test_ssh()

Step: Test SSH connection

step_write_text_file()

Step: Write a text file

TicStep

The base class for all steps

Stages

before_install() install() after_install() before_script() script() after_success() after_failure() before_deploy() deploy() after_deploy() after_script()

Predefined stages

CI Metadata

ci_get_branch() ci_is_tag() ci_get_slug() ci_get_build_number() ci_get_build_url() ci_get_commit() ci_get_env() ci_is_env() ci_has_env() ci_can_push() ci_is_interactive() ci_cat_with_color() ci_on_circle() ci_on_ghactions() ci()

The current CI environment

Executing locally

run_all_stages()

Emulate a CI run locally

prepare_all_stages()

Prepare all stages

run_stage()

Run a stage

Setup

use_tic()

Initialize CI testing using tic

use_tic_r()

Add a tic.R file to the repo

use_tic_badge()

Add a CI Status Badge to README files

Deployment

use_ghactions_deploy()

Setup deployment for GitHub Actions

gha_add_secret()

Add a GitHub Actions secret to a repository

Serialization

base64serialize() base64unserialize()

Helpers for converting R objects to strings and back

CRAN repository functions

repo_default() repo_cloud() repo_cran() repo_bioc()

Shortcuts for accessing CRAN-like repositories

Deprecated

add_package_checks()

Deprecated functions