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.

step_test_ssh(
  url = "[email protected]",
  verbose = "",
  private_key_name = "TIC_DEPLOY_KEY"
)

Arguments

url

[string]
URL to establish SSH connection with, by default [email protected]

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

Examples

dsl_init()
#>  Creating a clean tic stage configuration
#>  See `?tic::dsl_get` for details

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

dsl_get()
#> 
#> ── tic configuration ───────────────────────────────────────────────────────────
#> ── script ───────────────────────────────────────────────────────────── stage ──
#> ▶ step_test_ssh(verbose = "-vvv")