Writes a private SSH key encoded in an environment variable to a file in ~/.ssh. Only run in non-interactive settings and if the environment variable exists and is non-empty. use_ghactions_deploy() and use_tic() functions encode a private key as an environment variable for use with this function.

step_install_ssh_keys(private_key_name = "TIC_DEPLOY_KEY")

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.

See also

Examples

#> Creating a clean tic stage configuration
#> See `?tic::dsl_get` for details
get_stage("before_deploy") %>% add_step(step_install_ssh_keys()) dsl_get()
#>
#> ── tic configuration ───────────────────────────────────────────────────────────
#> ── before_deploy ────────────────────────────────────────────────────── stage ── #> ▶ step_install_ssh_keys()