step_test_ssh: Step: Test SSH connection

In ropenscilabs/tic: Tasks Integrating Continuously: CI-Agnostic Workflow Definitions

Step: Test SSH connection

Description

Establishes an SSH connection. This step doesn't fail if the connection cannot be established, but prints verbose output by default. It is useful for troubleshooting deployment problems.

Usage

step_test_ssh(
  url = "[e-mail]",
  verbose = "",
  private_key_name = "TIC_DEPLOY_KEY"
)

Arguments

url	⁠[string]⁠ URL to establish SSH connection with, by default [e-mail]
verbose	⁠[string]⁠ Verbosity, by default "". Use -v or "-vvv" for more verbosity.
private_key_name	string Only needed when deploying from builds on GitHub Actions. If you have set a custom name for the private key during creation of the SSH key pair via tic::use_ghactions_deploy()] or use_tic(), pass this name here.

See Also

Other steps: step_add_to_drat(), step_add_to_known_hosts(), step_build_pkgdown(), step_do_push_deploy(), step_hello_world(), step_install_pkg, step_install_ssh_keys(), step_push_deploy(), step_run_code(), step_session_info(), step_setup_push_deploy(), step_setup_ssh(), step_write_text_file()

Examples

dsl_init()

get_stage("script") %>%
  add_step(step_test_ssh(verbose = "-vvv"))

dsl_get()

ropenscilabs/tic documentation built on Feb. 12, 2025, 2:47 a.m.