Merge pull request #94 from shimataro/develop

version 1.6.2

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.6.2] - 2020-01-25
+
+### Others
+
+* some updates
+
 ## [1.6.1] - 2020-01-19
 
 ### Fixed
@@ -59,7 +65,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 * First release.
 
-[Unreleased]: https://github.com/shimataro/ssh-key-action/compare/v1.6.1...HEAD
+[Unreleased]: https://github.com/shimataro/ssh-key-action/compare/v1.6.2...HEAD
+[1.6.2]: https://github.com/shimataro/ssh-key-action/compare/v1.6.1...v1.6.2
 [1.6.1]: https://github.com/shimataro/ssh-key-action/compare/v1.6.0...v1.6.1
 [1.6.0]: https://github.com/shimataro/ssh-key-action/compare/v1.5.0...v1.6.0
 [1.5.0]: https://github.com/shimataro/ssh-key-action/compare/v1.4.0...v1.5.0

README.md

@@ -19,6 +19,8 @@ Useful for SCP, SFTP, and `rsync` over SSH in deployment script.
 
 Add your SSH key to your product secrets by clicking `Settings` - `Secrets` - `Add a new secret` beforehand.
 
+**NOTE:** OPENSSH format (key begins with `-----BEGIN OPENSSH PRIVATE KEY-----`) may not work due to OpenSSH version on VM. Please use PEM format (begins with `-----BEGIN RSA PRIVATE KEY-----`) instead.
+
 ```yaml
 runs-on: ubuntu-latest
 steps:
@@ -29,8 +31,6 @@ steps:
     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/
 ```
@@ -42,7 +42,7 @@ See [Workflow syntax for GitHub Actions](https://help.github.com/en/articles/wor
 If you want to install multiple keys, call this action multiple times.
 It is useful for port forwarding.
 
-**NOTE:**  When this action is called multiple times, **the contents of `known-hosts` and `config` will be appended**. But `private-key` must be saved as different name, by using `name` option.
+**NOTE:**  When this action is called multiple times, **the contents of `known-hosts` and `config` will be appended**. `private-key` must be saved as different name, by using `name` option.
 
 ```yaml
 runs-on: ubuntu-latest
@@ -70,8 +70,6 @@ steps:
         User user-of-target
         IdentityFile ~/.ssh/id_rsa-target
         ProxyCommand ssh -W %h:%p bastion
-- name: Install packages
-  run: apt install openssh-client
 - name: SCP via port-forwarding
   run: scp ./foo/ target:bar/
 ```
@@ -84,15 +82,15 @@ The scripts and documentation in this project are released under the [MIT Licens
 
 See [CHANGELOG.md](CHANGELOG.md).
 
-[image-build]: https://github.com/shimataro/ssh-key-action/workflows/Build/badge.svg
+[image-build]: https://github.com/shimataro/ssh-key-action/workflows/Build/badge.svg?event=push&branch=v1
 [link-build]: https://github.com/shimataro/ssh-key-action
-[image-verify-windows]: https://github.com/shimataro/ssh-key-action/workflows/Windows/badge.svg
-[image-verify-macos]: https://github.com/shimataro/ssh-key-action/workflows/macOS/badge.svg
-[image-verify-ubuntu]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu/badge.svg
-[image-verify-ubuntu1604]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu%2016.04/badge.svg
+[image-verify-windows]: https://github.com/shimataro/ssh-key-action/workflows/Windows/badge.svg?event=push&branch=v1
 [link-verify-windows]: https://github.com/shimataro/ssh-key-action
+[image-verify-macos]: https://github.com/shimataro/ssh-key-action/workflows/macOS/badge.svg?event=push&branch=v1
 [link-verify-macos]: https://github.com/shimataro/ssh-key-action
+[image-verify-ubuntu]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu/badge.svg?event=push&branch=v1
 [link-verify-ubuntu]: https://github.com/shimataro/ssh-key-action
+[image-verify-ubuntu1604]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu%2016.04/badge.svg?event=push&branch=v1
 [link-verify-ubuntu1604]: https://github.com/shimataro/ssh-key-action
 [image-release]: https://img.shields.io/github/release/shimataro/ssh-key-action.svg
 [link-release]: https://github.com/shimataro/ssh-key-action/releases