Skip to content

install-ssh-key

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

install-ssh-key

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
action.yml
action.yml
 
 

README.md

install-ssh-key

Installs an SSH key or a deploy key, which is an SSH key that grants access to a single repository.

- name: Install SSH Key
  uses: shapehq/actions/install-ssh-key@v1
  with:
    op-reference: op://My Vault/My SSH Key/ssh-key

Set the op-password-reference input to install a password-protected SSH key.

- name: Install SSH Key
  uses: shapehq/actions/install-ssh-key@v1
  with:
    op-reference: op://My Vault/My SSH Key/ssh-key
    op-password-reference: op://My Vault/My SSH Key/password

You may optionally specify the name of the file to store the SSH key in. Only do this if you are storing multiple SSH keys to avoid overriding an SSH key.

- name: Install SSH Key
  uses: shapehq/actions/install-ssh-key@v1
  with:
    op-reference: op://My Vault/My SSH Key/ssh-key
    filename: my_ssh_key

Attempting to install multiple SSH keys with the same name will cause the SSH key to be overwritten.

When installing multiple SSH keys, you may need to specify which SSH key to use when accessing a repository. For example, you may clone a repository using a specific SSH key by setting the GIT_SSH_COMMAND environment variable as shown below:

GIT_SSH_COMMAND='ssh -i ~/.ssh/my_ssh_key’ git clone git@github.com:shapehq/example.git