tic (version 0.4.0)

step_setup_ssh: Step: Setup SSH

Description

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(). The travis::use_travis_deploy() and use_tic() functions encode a private key as an environment variable for use with this function.

Usage

step_setup_ssh(
  name = "TRAVIS_DEPLOY_KEY",
  host = "github.com",
  url = paste0("git@", host),
  verbose = "-v"
)

Arguments

name

[string] Name of the environment variable and the target file, default: "TRAVIS_DEPLOY_KEY".

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 [e-mail]

verbose

[string] Verbosity, by default "-v". Use "-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_setup_push_deploy(), step_test_ssh(), step_write_text_file()

Examples

# NOT RUN {
dsl_init()

get_stage("script") %>%
  add_step(step_setup_ssh(host = "gitlab.com"))

dsl_get()
# }