Skip to content

Commit

Permalink
chore: improve SSH key handling and documentation
Browse files Browse the repository at this point in the history 
- Upgrade the ssh-action package from version `v0.1.8` to `v0.1.9`
- Update the ssh-keygen command to use `-t ed25519 -a 200 -C` flag with an email address
- Clarify how to pass environment variables as strings in the `env` object
- Add a command to check the fingerprint of an ed25519 key in the README
- Remove duplicate Host entry for `FooServer` in the Chinese version of the README

Signed-off-by: Bo-Yi.Wu <[email protected]>
  • Loading branch information
@appleboy
appleboy committed Apr 4, 2023
1 parent 3cd1bcf commit 5f64c95
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
24 changes: 12 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: executing remote ssh commands using password
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand Down Expand Up @@ -161,7 +161,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```yaml
- name: executing remote ssh commands using password
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -174,7 +174,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```yaml
- name: executing remote ssh commands using ssh key
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -187,7 +187,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```yaml
- name: multiple command
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -204,7 +204,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```diff
- name: multiple host
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
- host: "foo.com"
+ host: "foo.com,bar.com"
Expand All @@ -220,7 +220,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```diff
- name: multiple host
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
- host: "foo.com"
+ host: "foo.com:1234,bar.com:5678"
Expand All @@ -235,7 +235,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```diff
- name: multiple host
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: "foo.com,bar.com"
+ sync: true
Expand All @@ -251,7 +251,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```diff
- name: pass environment
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
+ env:
+ FOO: "BAR"
+ BAR: "FOO"
Expand All @@ -276,7 +276,7 @@ _Inside `env` object, you need to pass every environment variable as a string, p
```diff
- name: stop script if command error
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand Down Expand Up @@ -329,7 +329,7 @@ Host FooServer

```diff
- name: ssh proxy command
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -352,7 +352,7 @@ It is not uncommon for files to leak from backups or decommissioned hardware, an

```diff
- name: ssh key passphrase
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -378,7 +378,7 @@ Now you can adjust you config:

```diff
- name: ssh key passphrase
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand Down
24 changes: 12 additions & 12 deletions README.zh-tw.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: executing remote ssh commands using password
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand Down Expand Up @@ -157,7 +157,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```yaml
- name: executing remote ssh commands using password
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -170,7 +170,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```yaml
- name: executing remote ssh commands using ssh key
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -183,7 +183,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```yaml
- name: multiple command
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -200,7 +200,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```diff
- name: multiple host
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
- host: "foo.com"
+ host: "foo.com,bar.com"
Expand All @@ -216,7 +216,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```diff
- name: multiple host
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
- host: "foo.com"
+ host: "foo.com:1234,bar.com:5678"
Expand All @@ -231,7 +231,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```diff
- name: multiple host
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: "foo.com,bar.com"
+ sync: true
Expand All @@ -247,7 +247,7 @@ ssh-keygen -t ed25519 -a 200 -C "[email protected]"

```diff
- name: pass environment
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
+ env:
+ FOO: "BAR"
+ BAR: "FOO"
Expand All @@ -272,7 +272,7 @@ _在 `env` 對象中，您需要將每個環境變量作為字符串傳遞，傳
```diff
- name: stop script if command error
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand Down Expand Up @@ -325,7 +325,7 @@ Host FooServer

```diff
- name: ssh proxy command
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -346,7 +346,7 @@ Host FooServer

```diff
- name: ssh key passphrase
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand All @@ -372,7 +372,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' '

```diff
- name: ssh key passphrase
uses: appleboy/[email protected].8
uses: appleboy/[email protected].9
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
Expand Down

0 comments on commit 5f64c95

Please sign in to comment.