2019-09-18 19:39:54 +08:00
|
|
|
# Install SSH key
|
|
|
|
|
|
2019-09-18 19:47:08 +08:00
|
|
|
This action installs SSH key into `~/.ssh`.
|
2019-09-18 19:39:54 +08:00
|
|
|
|
|
|
|
|
Useful for `rsync` over SSH in deployment script.
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Add your SSH key to your product secrets by clicking `Settings` - `Secrets` - `Add a new secret` beforehand.
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
steps:
|
|
|
|
|
- name: Install SSH key
|
|
|
|
|
uses: shimataro/ssh-key-action@v1
|
|
|
|
|
with:
|
|
|
|
|
private-key: ${{ secret.SSH_KEY }}
|
|
|
|
|
public-key: ${{ secret.SSH_KEY_PUBLIC }}
|
|
|
|
|
name: 'id_rsa' # optional
|
|
|
|
|
- name: Install packages
|
|
|
|
|
run: apt install openssh-client rsync
|
|
|
|
|
- name: rsync over ssh
|
|
|
|
|
run: rsync -e "ssh -o StrictHostKeyChecking=no" ./foo/ user@remote:bar/
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
See [Workflow syntax for GitHub Actions](https://help.github.com/en/articles/workflow-syntax-for-github-actions) for details.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
The scripts and documentation in this project are released under the [MIT License](LICENSE)
|
