chore: improve SSH key handling and documentation
- 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 <appleboy.tw@gmail.com>
This commit is contained in:
		
							parent
							
								
									3cd1bcf771
								
							
						
					
					
						commit
						5f64c95280
					
				
							
								
								
									
										24
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										24
									
								
								README.md
									
									
									
									
									
								
							@ -60,7 +60,7 @@ jobs:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: executing remote ssh commands using password
 | 
			
		||||
      uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
      uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
      with:
 | 
			
		||||
        host: ${{ secrets.HOST }}
 | 
			
		||||
        username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -161,7 +161,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
- name: executing remote ssh commands using password
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
  with:
 | 
			
		||||
    host: ${{ secrets.HOST }}
 | 
			
		||||
    username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -174,7 +174,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
- name: executing remote ssh commands using ssh key
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
  with:
 | 
			
		||||
    host: ${{ secrets.HOST }}
 | 
			
		||||
    username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -187,7 +187,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
- name: multiple command
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
  with:
 | 
			
		||||
    host: ${{ secrets.HOST }}
 | 
			
		||||
    username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -204,7 +204,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: multiple host
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
-     host: "foo.com"
 | 
			
		||||
+     host: "foo.com,bar.com"
 | 
			
		||||
@ -220,7 +220,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: multiple host
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
-     host: "foo.com"
 | 
			
		||||
+     host: "foo.com:1234,bar.com:5678"
 | 
			
		||||
@ -235,7 +235,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: multiple host
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: "foo.com,bar.com"
 | 
			
		||||
+     sync: true
 | 
			
		||||
@ -251,7 +251,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: pass environment
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
+   env:
 | 
			
		||||
+     FOO: "BAR"
 | 
			
		||||
+     BAR: "FOO"
 | 
			
		||||
@ -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/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: ${{ secrets.HOST }}
 | 
			
		||||
      username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -329,7 +329,7 @@ Host FooServer
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: ssh proxy command
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: ${{ secrets.HOST }}
 | 
			
		||||
      username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -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/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: ${{ secrets.HOST }}
 | 
			
		||||
      username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -378,7 +378,7 @@ Now you can adjust you config:
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: ssh key passphrase
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: ${{ secrets.HOST }}
 | 
			
		||||
      username: ${{ secrets.USERNAME }}
 | 
			
		||||
 | 
			
		||||
@ -58,7 +58,7 @@ jobs:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
    - name: executing remote ssh commands using password
 | 
			
		||||
      uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
      uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
      with:
 | 
			
		||||
        host: ${{ secrets.HOST }}
 | 
			
		||||
        username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -157,7 +157,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
- name: executing remote ssh commands using password
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
  with:
 | 
			
		||||
    host: ${{ secrets.HOST }}
 | 
			
		||||
    username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -170,7 +170,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
- name: executing remote ssh commands using ssh key
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
  with:
 | 
			
		||||
    host: ${{ secrets.HOST }}
 | 
			
		||||
    username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -183,7 +183,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```yaml
 | 
			
		||||
- name: multiple command
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
  uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
  with:
 | 
			
		||||
    host: ${{ secrets.HOST }}
 | 
			
		||||
    username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -200,7 +200,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: multiple host
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
-     host: "foo.com"
 | 
			
		||||
+     host: "foo.com,bar.com"
 | 
			
		||||
@ -216,7 +216,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: multiple host
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
-     host: "foo.com"
 | 
			
		||||
+     host: "foo.com:1234,bar.com:5678"
 | 
			
		||||
@ -231,7 +231,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: multiple host
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: "foo.com,bar.com"
 | 
			
		||||
+     sync: true
 | 
			
		||||
@ -247,7 +247,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: pass environment
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
+   env:
 | 
			
		||||
+     FOO: "BAR"
 | 
			
		||||
+     BAR: "FOO"
 | 
			
		||||
@ -272,7 +272,7 @@ _在 `env` 對象中,您需要將每個環境變量作為字符串傳遞,傳
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: stop script if command error
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: ${{ secrets.HOST }}
 | 
			
		||||
      username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -325,7 +325,7 @@ Host FooServer
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: ssh proxy command
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: ${{ secrets.HOST }}
 | 
			
		||||
      username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -346,7 +346,7 @@ Host FooServer
 | 
			
		||||
 | 
			
		||||
```diff
 | 
			
		||||
  - name: ssh key passphrase
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: ${{ secrets.HOST }}
 | 
			
		||||
      username: ${{ secrets.USERNAME }}
 | 
			
		||||
@ -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/ssh-action@v0.1.8
 | 
			
		||||
    uses: appleboy/ssh-action@v0.1.9
 | 
			
		||||
    with:
 | 
			
		||||
      host: ${{ secrets.HOST }}
 | 
			
		||||
      username: ${{ secrets.USERNAME }}
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user