Introduction | Circle CI | GitHub Actions | Updating the deployment status | {pkgdown} deployment | Deploying to docs/ (default branch) or gh-pages branch | Default branch deployment | Orphaning the gh-pages branch | Committing single files
Package: tic 0.14.1
Eli Miller
tic: Tasks Integrating Continuously: CI-Agnostic Workflow Definitions
Provides a way to describe common build and deployment workflows for R-based projects: packages, websites (e.g. blogdown, pkgdown), or data processing (e.g. research compendia). The recipe is described independent of the continuous integration tool used for processing the workflow (e.g. 'GitHub Actions' or 'Circle CI'). This package has been peer-reviewed by rOpenSci (v0.3.0.9004).
Authors:
tic_0.14.1.tar.gz
tic_0.14.1.zip(r-4.7)tic_0.14.1.zip(r-4.6)tic_0.14.1.zip(r-4.5)
tic_0.14.1.tgz(r-4.6-any)tic_0.14.1.tgz(r-4.5-any)
tic_0.14.1.tar.gz(r-4.7-any)tic_0.14.1.tar.gz(r-4.6-any)
tic_0.14.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
tic/json (API)
| # Install 'tic' in R: |
| install.packages('tic', repos = c('https://ropensci.r-universe.dev', 'https://cloud.r-project.org')) |
Reviews:rOpenSci Software Review #305
Bug tracker:https://github.com/ropensci/tic/issues
Pkgdown/docs site:https://docs.ropensci.org
appveyorcontinuous-integrationdeploymentgithubactionstravis-ci
Last updated from:14ca9a5ecf (on main). Checks:10 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 182 | ||
| pkgdown docs | OK | 193 | ||
| source / vignettes | OK | 252 | ||
| linux-release-x86_64 | OK | 192 | ||
| macos-release-arm64 | OK | 121 | ||
| macos-oldrel-arm64 | OK | 144 | ||
| windows-devel | OK | 100 | ||
| windows-release | OK | 105 | ||
| windows-oldrel | OK | 102 | ||
| wasm-release | OK | 141 |
Exports:%>%add_code_stepadd_package_checksadd_stepafter_deployafter_failureafter_installafter_scriptafter_successbase64serializebase64unserializebefore_deploybefore_installbefore_scriptcici_can_pushci_cat_with_colorci_get_branchci_get_build_numberci_get_build_urlci_get_commitci_get_envci_get_slugci_has_envci_is_envci_is_interactiveci_is_tagci_on_circleci_on_ghactionsdeploydo_blogdowndo_bookdowndo_dratdo_package_checksdo_pkgdowndo_readme_rmddsl_getdsl_initdsl_loadget_stagegha_add_secretinstalllist_macrosprepare_all_stagesrepo_biocrepo_cloudrepo_cranrepo_defaultrun_all_stagesrun_stagescriptstep_add_to_dratstep_add_to_known_hostsstep_build_blogdownstep_build_bookdownstep_build_pkgdownstep_do_push_deploystep_hello_worldstep_install_cranstep_install_depsstep_install_githubstep_install_ssh_keysstep_push_deploystep_rcmdcheckstep_run_codestep_session_infostep_setup_push_deploystep_setup_sshstep_test_sshstep_write_text_fileTicStepupdate_ymluse_circle_ymluse_ghactions_deployuse_ghactions_ymluse_ticuse_tic_badgeuse_tic_ruse_update_tic
Dependencies:askpasscachemclicliprcrayoncredentialscurldescfastmapfsgertgit2rgitcredsgluehttr2inijsonlitelifecyclemagrittrmemoiseopensslpakpurrrR6rappdirsremotesrlangrprojrootrstudioapisysusethisvctrswhiskerwithryamlzip
Deployment
Last update: 2023-12-15
Started: 2019-01-01
Implementation Details of CI Providers
GitHub Actions | macOS toolchain | rJava | ccache | Spatial libraries (gdal, proj, geos) | macOS | Linux | Known issues | Circle CI
Last update: 2023-05-22
Started: 2020-02-25
Updating
Deviating from the templates | custom and custom-deploy templates | The # [Custom header] tag | Examples | Automating the update process
Last update: 2022-08-28
Started: 2020-05-20
Advanced usage
Running steps conditionally | Conditional execution: Use cases | Installation of packages | GitHub packages | CRAN packages | CI Meta-Information | Debugging: Running {tic} locally | Checking for syntax errors | Emulating a CI run locally | Debugging: Entering the CI build directly | Circle CI | What's not covered yet?
Last update: 2022-08-28
Started: 2018-08-13
Developer info: Writing custom steps
The TicStep class | The prepare() method | The run() method | The check() method | A minimal example | Further information on the R6 class system
Last update: 2021-12-05
Started: 2018-06-27
The features of tic
Simplified Deployment | Support for various R projects | CI-Agnostic workflows | Enhanced R package checking | Caching of packages | Easier troubleshooting
Last update: 2021-03-22
Started: 2019-05-06
FAQ
Authentication | Q-Auth-1 | GitHub Actions | Q-GHA-1 | Other | Q-Other-1 | Q-Other-2 | Q-Other-3
Last update: 2021-01-21
Started: 2020-02-25
Getting started with CI for R
Prerequisites | Initialization/Setup | Quickstart | The role of the tic.R file | Macros | do_package_checks() | do_pkgdown() | do_readme_rmd() | Blogdown | {tic} projects from the community | Still got questions?
Last update: 2020-12-11
Started: 2018-08-13
tic & CI Client Packages - An Overview
Introduction | CI Client Packages
Last update: 2020-12-11
Started: 2019-11-30
Build lifecycle
Stages | Accessing a single stage | Details of stages | The "before_install" & "install" stages | The "script" stage | The "deploy" stage | Steps | Basic | Installation | R package specific | Deployment
Last update: 2020-12-07
Started: 2018-08-13
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| tic: Tasks Integrating Continuously: CI-Agnostic Workflow Definitions | tic-package tic |
| Helpers for converting R objects to strings and back | base64serialize base64unserialize |
| The current CI environment | ci ci_can_push ci_cat_with_color ci_get_branch ci_get_build_number ci_get_build_url ci_get_commit ci_get_env ci_get_slug ci_has_env ci_is_env ci_is_interactive ci_is_tag ci_on_circle ci_on_ghactions |
| Deprecated functions | add_package_checks Deprecated |
| Build a blogdown site | do_blogdown |
| Build a bookdown book | do_bookdown |
| Build and deploy drat repository | do_drat |
| Add default checks for packages | do_package_checks |
| Build pkgdown documentation | do_pkgdown |
| Render a R Markdown README and deploy to Github | do_readme_rmd |
| tic's domain-specific language | add_code_step add_step DSL dsl get_stage |
| Stages and steps | dsl_get dsl_init dsl_load |
| Add a GitHub Actions secret to a repository | gha_add_secret |
| Github API helpers | auth_github get_owner get_repo get_repo_slug get_user github_helpers |
| Github information | github_info github_repo uses_github |
| List available macros | list_macros |
| Macros | macro |
| Prepare all stages | prepare_all_stages |
| Shortcuts for accessing CRAN-like repositories | repo repo_bioc repo_cloud repo_cran repo_default |
| Emulate a CI run locally | run_all_stages |
| Run a stage | run_stage |
| SSH key helpers | check_admin_repo check_private_key_name encode_private_key get_public_key get_role_in_repo github_add_key ssh_key_helpers |
| Predefined stages | after_deploy after_failure after_install after_script after_success before_deploy before_install before_script deploy install script stages |
| Step: Add built package to a drat | step_add_to_drat |
| Step: Add to known hosts | step_add_to_known_hosts |
| Step: Build a Blogdown Site | step_build_blogdown |
| Step: Build a bookdown book | step_build_bookdown |
| Step: Build pkgdown documentation | step_build_pkgdown |
| Step: Perform push deploy | step_do_push_deploy |
| Step: Hello, world! | step_hello_world |
| Step: Install packages | step_install_cran step_install_deps step_install_github step_install_pkg |
| Step: Install an SSH key | step_install_ssh_keys |
| Step: Setup and perform push deploy | step_push_deploy |
| Step: Check a package | step_rcmdcheck |
| Step: Run arbitrary R code | step_run_code |
| Step: Print the current Session Info | step_session_info |
| Step: Setup push deploy | step_setup_push_deploy |
| Step: Setup SSH | step_setup_ssh |
| Step: Test SSH connection | step_test_ssh |
| Step: Write a text file | step_write_text_file |
| The base class for all steps | TicStep |
| Update tic YAML Templates | update_yml |
| Setup deployment for GitHub Actions | use_ghactions_deploy |
| Initialize CI testing using tic | use_tic |
| Add a CI Status Badge to README files | use_tic_badge |
| Add a tic.R file to the repo | use_tic_r |
| Update tic Templates | use_update_tic |
| Use CI YAML templates | use_circle_yml use_ghactions_yml yaml_templates |