Step: Setup SSH

Adds to known hosts, installs private key, and tests the connection. Chaining step_install_ssh_keys(), step_add_to_known_hosts() and step_test_ssh(). use_tic() encodes a private key as an environment variable for use with this function.

Usage

step_setup_ssh(
  private_key_name = "TIC_DEPLOY_KEY",
  host = "github.com",
  url = paste0("git@", host),
  verbose = ""
)

Arguments

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.

host

[string]
The host name to add to the known_hosts file, default: github.com.

url

[string]
URL to establish SSH connection with, by default git@github.com

verbose

[string]
Verbosity, by default "". Use -v or "-vvv" for more verbosity.

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_test_ssh(), step_write_text_file()

Examples

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

get_stage("script") %>%
  add_step(step_setup_ssh(host = "gitlab.com"))
#> Superclass TicStep has cloneable=FALSE, but subclass SetupSSH has cloneable=TRUE. A subclass cannot be cloneable when its superclass is not cloneable, so cloning will be disabled for SetupSSH.
#> Superclass TicStep has cloneable=FALSE, but subclass InstallSSHKeys has cloneable=TRUE. A subclass cannot be cloneable when its superclass is not cloneable, so cloning will be disabled for InstallSSHKeys.
#> Superclass TicStep has cloneable=FALSE, but subclass AddToKnownHosts has cloneable=TRUE. A subclass cannot be cloneable when its superclass is not cloneable, so cloning will be disabled for AddToKnownHosts.
#> Superclass TicStep has cloneable=FALSE, but subclass TestSSH has cloneable=TRUE. A subclass cannot be cloneable when its superclass is not cloneable, so cloning will be disabled for TestSSH.

dsl_get()
#> ── tic configuration summary ───────────────────────────────────────────────────
#> ── Stage: script ───────────────────────────────────────────────────────────────
#> ▶ step_setup_ssh(host="gitlab.com")