Install SSH key

This action installs SSH key into ~/.ssh.

Useful for SCP, SFTP, and rsync over SSH in deployment script.

Usage

Add your SSH key to your product secrets by clicking Settings - Secrets - Add a new secret beforehand.

runs-on: ubuntu-latest
steps:
- name: Install SSH key
  uses: shimataro/ssh-key-action@v1
  with:
    private-key: ${{ secrets.SSH_KEY }}
    public-key: ${{ secrets.SSH_KEY_PUBLIC }}
    name: id_rsa # optional
    known-hosts: ${{ secrets.KNOWN_HOSTS }} # known_hosts; optional
    config: ${{ secrets.CONFIG }} # ssh_config; optional
- name: Install packages
  run: apt install openssh-client rsync
- name: rsync over ssh
  run: rsync ./foo/ user@remote:bar/

See Workflow syntax for GitHub Actions for details.

License

The scripts and documentation in this project are released under the MIT License

Changelog

See CHANGELOG.md.