298977887/scp-action
1
0
Fork 0
mirror of https://github.com/appleboy/scp-action.git synced 2025-04-19 02:23:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Compare commits

base: 298977887:master
Branches Tags
298977887:master
298977887:dependabot/github_actions/tj-actions/changed-files-46
298977887:docs
298977887:patch
298977887:v0.1.7
298977887:v0.1.6
298977887:v0.1.5
298977887:v0.1.4
298977887:v0.1.3
298977887:v0.1.2
298977887:v0.1.1
298977887:v0.1.0
298977887:v0.0.11
298977887:v0.0.10
298977887:v0.0.9
298977887:v0.0.8
298977887:v0.0.7
298977887:v0.0.6
298977887:v0.0.5
298977887:v0.0.4
298977887:v0.0.3
298977887:v0.0.2
298977887:v0.0.1
..
compare: 298977887:v0.1.4
Branches Tags
298977887:dependabot/github_actions/tj-actions/changed-files-46
298977887:master
298977887:docs
298977887:patch
298977887:v0.1.7
298977887:v0.1.6
298977887:v0.1.5
298977887:v0.1.4
298977887:v0.1.3
298977887:v0.1.2
298977887:v0.1.1
298977887:v0.1.0
298977887:v0.0.11
298977887:v0.0.10
298977887:v0.0.9
298977887:v0.0.8
298977887:v0.0.7
298977887:v0.0.6
298977887:v0.0.5
298977887:v0.0.4
298977887:v0.0.3
298977887:v0.0.2
298977887:v0.0.1

No commits in common. "master" and "v0.1.4" have entirely different histories.
master ... v0.1.4

6 changed files with 261 additions and 379 deletions
Show Stats Expand all files Collapse all files

235
.github/workflows/ci.yml vendored
View File

@ -1,150 +1,139 @@
name: scp files name: scp files
on: [push] on: [push]
jobs: jobs:
testing: testing:
name: test scp action name: test scp action
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: checkout - name: checkout
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: copy file via ssh password - name: copy file via ssh password
uses: ./ uses: ./
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
password: ${{ secrets.PASSWORD }} password: ${{ secrets.PASSWORD }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: "test" target: "test"
- name: copy file via ssh key - name: copy file via ssh key
uses: ./ uses: ./
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }} key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: "test" target: "test"
- name: remove the specified number of leading path elements - name: remove the specified number of leading path elements
uses: ./ uses: ./
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }} key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: "foobar" target: "foobar"
strip_components: 1 strip_components: 1
- name: ssh key with passphrase - name: ssh key with passphrase
uses: ./ uses: ./
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
key: ${{ secrets.SSH2 }} key: ${{ secrets.SSH2 }}
passphrase: ${{ secrets.PASSPHRASE }} passphrase: ${{ secrets.PASSPHRASE }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: "test" target: "test"
- name: use insecure cipher - name: use insecure cipher
uses: ./ uses: ./
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
key: ${{ secrets.SSH2 }} key: ${{ secrets.SSH2 }}
passphrase: ${{ secrets.PASSPHRASE }} passphrase: ${{ secrets.PASSPHRASE }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: "test" target: "test"
use_insecure_cipher: true use_insecure_cipher: true
- name: correct key but wrong password
uses: appleboy/scp-action@7af00892de6f8397c5c3393cfb3b32ae7f91b94b
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
password: abcdefg
port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt"
target: "test"
- name: correct password but wrong key
uses: appleboy/scp-action@7af00892de6f8397c5c3393cfb3b32ae7f91b94b
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: abcdefg
password: ${{ secrets.PASSWORD }}
port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt"
target: "test"
deploy: deploy:
name: test deploy artifact name: deploy artifact
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: checkout - name: checkout
uses: actions/checkout@v4 uses: actions/checkout@v3
- run: echo hello > world.txt - run: echo hello > world.txt
- uses: actions/upload-artifact@v4 - uses: actions/upload-artifact@v3
with: with:
name: my-artifact name: my-artifact
path: world.txt path: world.txt
- uses: actions/download-artifact@v4 - uses: actions/download-artifact@v2
with: with:
name: my-artifact name: my-artifact
path: distfiles path: distfiles
- name: copy file to server - name: copy file to server
uses: ./ uses: ./
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }} key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: distfiles/* source: distfiles/*
target: test target: test
changes: changes:
name: test changed-files name: test changed-files
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: checkout - name: checkout
uses: actions/checkout@v4 uses: actions/checkout@v3
- name: Get changed files - name: Get changed files
id: changed-files id: changed-files
uses: tj-actions/changed-files@v45 uses: tj-actions/changed-files@v35
with: with:
since_last_remote_commit: true since_last_remote_commit: true
separator: "," separator: ","
- name: copy file to server - name: copy file to server
uses: ./ uses: ./
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }} key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: ${{ steps.changed-files.outputs.all_changed_files }} source: ${{ steps.changed-files.outputs.all_changed_files }}
target: test target: test
target:
name: test target folder
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v4
- name: copy file to server
uses: ./
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
source: tests/a.txt,tests/b.txt
target: foobar foobar 1234
multipleHost:
name: test Multiple Host
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v4
- name: copy file to server
uses: ./
with:
host: ${{ secrets.HOST }}:${{ secrets.PORT }},${{ secrets.HOST }}:${{ secrets.PORT }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: 1024
source: tests/a.txt,tests/b.txt
target: foobar

33
.github/workflows/goreleaser.yml vendored
View File

@ -1,33 +0,0 @@
name: Goreleaser
on:
push:
tags:
- "*"
permissions:
contents: write
jobs:
goreleaser:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup go
uses: actions/setup-go@v5
with:
go-version: "^1"
- name: Run GoReleaser
uses: goreleaser/goreleaser-action@v6
with:
# either 'goreleaser' (default) or 'goreleaser-pro'
distribution: goreleaser
version: latest
args: release --clean
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

28
.goreleaser.yaml
View File

@ -1,28 +0,0 @@
builds:
- # If true, skip the build.
# Useful for library projects.
# Default is false
skip: true
changelog:
use: github
groups:
- title: Features
regexp: "^.*feat[(\\w)]*:+.*$"
order: 0
- title: "Bug fixes"
regexp: "^.*fix[(\\w)]*:+.*$"
order: 1
- title: "Enhancements"
regexp: "^.*chore[(\\w)]*:+.*$"
order: 2
- title: "Refactor"
regexp: "^.*refactor[(\\w)]*:+.*$"
order: 3
- title: "Build process updates"
regexp: ^.*?(build|ci)(\(.+\))??!?:.+$
order: 4
- title: "Documentation updates"
regexp: ^.*?docs?(\(.+\))??!?:.+$
order: 4
- title: Others

8
Dockerfile
View File

@ -1,5 +1,5 @@
FROM ghcr.io/appleboy/drone-scp:1.6.14 FROM ghcr.io/appleboy/drone-scp:1.6.7
COPY entrypoint.sh /bin/entrypoint.sh COPY entrypoint.sh /entrypoint.sh
RUN chmod +x /entrypoint.sh
ENTRYPOINT ["/bin/entrypoint.sh"] ENTRYPOINT ["/entrypoint.sh"]

246
README.md
View File

@ -4,7 +4,7 @@
[![Actions Status](https://github.com/appleboy/scp-action/workflows/scp%20files/badge.svg)](https://github.com/appleboy/scp-action/actions) [![Actions Status](https://github.com/appleboy/scp-action/workflows/scp%20files/badge.svg)](https://github.com/appleboy/scp-action/actions)
**Important**: Only supports **Linux** [docker](https://www.docker.com/) containers. **Important**: Only support **Linux** [docker](https://www.docker.com/) container.
## Usage ## Usage
@ -14,70 +14,65 @@ Copy files and artifacts via SSH:
name: scp files name: scp files
on: [push] on: [push]
jobs: jobs:
build: build:
name: Build name: Build
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@master
- name: copy file via ssh password - name: copy file via ssh password
uses: appleboy/scp-action@v0.1.7 uses: appleboy/scp-action@master
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
password: ${{ secrets.PASSWORD }} password: ${{ secrets.PASSWORD }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: your_server_target_folder_path target: "test"
``` ```
## Input variables ## Input variables
See the [action.yml](./action.yml) file for more detail information. See the [action.yml](./action.yml) file for more detail information.
| Variable | Description | Default Value | * host - scp remote host
| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------- | * port - scp remote port, default is `22`
| host | SCP remote host | - | * username - scp username
| port | SCP remote port | `22` | * password - scp password
| username | SCP username | - | * passphrase - the passphrase is usually to encrypt the private key
| password | SCP password | - | * fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
| passphrase | The passphrase is usually used to encrypt the private key | - | * timeout - timeout for ssh to remote host, default is `30s`
| protocol | The IP protocol to use. Valid values are `tcp`, `tcp4`, or `tcp6`. | `tcp` | * command_timeout - timeout for scp command, default is `10m`
| fingerprint | Fingerprint SHA256 of the host public key. Default is to skip verification | - | * key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
| timeout | Timeout for SSH to remote host | `30s` | * key_path - path of ssh private key
| command_timeout | Timeout for SCP command | `10m` | * target - target path on the server, must be a directory (**required**)
| key | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa | - | * source - scp file list (**required**)
| key_path | Path of SSH private key | - | * rm - remove target folder before upload data, default is `false`
| target | Target path on the server, must be a directory (**required**) | - | * strip_components - remove the specified number of leading path elements.
| source | SCP file list (**required**) | - | * overwrite - use `--overwrite` flag with tar, overwrite existing files when extracting
| rm | Remove target folder before uploading data | `false` | * tar_tmp_path - temporary path for tar file on the dest host
| strip_components | Remove the specified number of leading path elements | - | * tar_exec - path to tar executable on the dest host. default is `tar`
| overwrite | Use `--overwrite` flag with tar, overwrite existing files when extracting | - | * tar_dereference - use `--dereference` flag with tar, follow symlinks; archive and dump the files they point to
| tar_tmp_path | Temporary path for tar file on the destination host | - | * use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
| tar_exec | Path to tar executable on the destination host | `tar` |
| tar_dereference | Use `--dereference` flag with tar, follow symlinks; archive and dump the files they point to | - |
| use_insecure_cipher | Include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15)) | - |
SSH Proxy Setting: SSH Proxy Setting:
| Variable | Description | Default Value | * proxy_host - proxy host
| ------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------- | * proxy_port - proxy port, default is `22`
| proxy_host | Proxy host | - | * proxy_username - proxy username
| proxy_port | Proxy port | `22` | * proxy_password - proxy password
| proxy_username | Proxy username | - | * proxy_passphrase - the passphrase is usually to encrypt the private key
| proxy_password | Proxy password | - | * proxy_timeout - timeout for ssh to proxy host, default is `30s`
| proxy_protocol | The IP protocol to use. Valid values are `tcp`, `tcp4`, or `tcp6`. | `tcp` | * proxy_key - content of ssh proxy private key.
| proxy_passphrase | The passphrase is usually used to encrypt the private key | - | * proxy_key_path - path of ssh proxy private key
| proxy_timeout | Timeout for SSH to proxy host | `30s` | * proxy_fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
| proxy_key | Content of SSH proxy private key | - | * proxy_use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
| proxy_key_path | Path of SSH proxy private key | - |
| proxy_fingerprint | Fingerprint SHA256 of the host public key. Default is to skip verification | - |
| proxy_use_insecure_cipher | Include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15)) | - |
## Setting up a SSH Key ## Setting up a SSH Key
Make sure to follow the steps below when creating and using SSH keys. Make sure to follow the below steps while creating SSH Keys and using them.
The best practice is to create the SSH keys on the local machine, not the remote machine. The best practice is create the SSH Keys on local machine not remote machine.
Log in with the username specified in GitHub Secrets and generate an RSA key pair: Login with username specified in Github Secrets. Generate a RSA Key-Pair:
```bash ```bash
# rsa # rsa
@ -111,9 +106,9 @@ See the detail information about [SSH login without password](http://www.linuxpr
**A note** from one of our readers: Depending on your version of SSH you might also have to do the following changes: **A note** from one of our readers: Depending on your version of SSH you might also have to do the following changes:
- Put the public key in `.ssh/authorized_keys2` * Put the public key in `.ssh/authorized_keys2`
- Change the permissions of `.ssh` to 700 * Change the permissions of `.ssh` to 700
- Change the permissions of `.ssh/authorized_keys2` to 640 * Change the permissions of `.ssh/authorized_keys2` to 640
### If you are using OpenSSH ### If you are using OpenSSH
@ -142,62 +137,48 @@ Copy file via a SSH password:
```yaml ```yaml
- name: copy file via ssh password - name: copy file via ssh password
uses: appleboy/scp-action@v0.1.7 uses: appleboy/scp-action@master
with: with:
host: example.com host: example.com
username: foo username: foo
password: bar password: bar
port: 22 port: 22
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: your_server_target_folder_path target: "test"
```
Using the environment variables
```yaml
- name: copy file via ssh password
uses: appleboy/scp-action@v0.1.7
with:
host: ${{ env.HOST }}
username: ${{ env.USERNAME }}
password: ${{ secrets.PASSWORD }}
port: ${{ env.PORT }}
source: "tests/a.txt,tests/b.txt"
target: ${{ env.TARGET_PATH }}
``` ```
Copy file via a SSH key: Copy file via a SSH key:
```yaml ```yaml
- name: copy file via ssh key - name: copy file via ssh key
uses: appleboy/scp-action@v0.1.7 uses: appleboy/scp-action@master
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
key: ${{ secrets.KEY }} key: ${{ secrets.KEY }}
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: your_server_target_folder_path target: "test"
``` ```
Example configuration for ignore list: Example configuration for ignore list:
```yaml ```yaml
- name: copy file via ssh key - name: copy file via ssh key
uses: appleboy/scp-action@v0.1.7 uses: appleboy/scp-action@master
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
key: ${{ secrets.KEY }} key: ${{ secrets.KEY }}
source: "tests/*.txt,!tests/a.txt" source: "tests/*.txt,!tests/a.txt"
target: your_server_target_folder_path target: "test"
``` ```
Example configuration for multiple servers: Example configuration for multiple servers:
```diff ```diff
uses: appleboy/scp-action@v0.1.7 uses: appleboy/scp-action@master
with: with:
- host: "example.com" - host: "example.com"
+ host: "foo.com,bar.com" + host: "foo.com,bar.com"
@ -205,13 +186,13 @@ Example configuration for multiple servers:
password: bar password: bar
port: 22 port: 22
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: your_server_target_folder_path target: "test"
``` ```
Example configuration for exclude custom files: Example configuration for exclude custom files:
```yaml ```yaml
uses: appleboy/scp-action@v0.1.7 uses: appleboy/scp-action@master
with: with:
host: "example.com" host: "example.com"
username: foo username: foo
@ -219,57 +200,85 @@ Example configuration for exclude custom files:
port: 22 port: 22
- source: "tests/*.txt" - source: "tests/*.txt"
+ source: "tests/*.txt,!tests/a.txt,!tests/b.txt" + source: "tests/*.txt,!tests/a.txt,!tests/b.txt"
target: your_server_target_folder_path target: "test"
``` ```
Upload artifact files to remote server: Upload artifact files to remote server:
```yaml ```yaml
deploy: deploy:
name: deploy artifact name: deploy artifact
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: checkout - name: checkout
uses: actions/checkout@v4 uses: actions/checkout@v3
- run: echo hello > world.txt - run: echo hello > world.txt
- uses: actions/upload-artifact@v4 - uses: actions/upload-artifact@v3
with: with:
name: my-artifact name: my-artifact
path: world.txt path: world.txt
- uses: actions/download-artifact@v4 - uses: actions/download-artifact@v2
with: with:
name: my-artifact name: my-artifact
path: distfiles path: distfiles
- name: copy file to server - name: copy file to server
uses: appleboy/scp-action@v0.1.7 uses: appleboy/scp-action@master
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }} key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: distfiles/* source: distfiles/*
target: your_server_target_folder_path target: test
``` ```
Remove the specified number of leading path elements: Remove the specified number of leading path elements:
```yaml ```yaml
- name: remove the specified number of leading path elements - name: remove the specified number of leading path elements
uses: appleboy/scp-action@v0.1.7 uses: appleboy/scp-action@master
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }} key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: your_server_target_folder_path target: "foobar"
strip_components: 1 strip_components: 1
``` ```
Only copy files that are newer than the corresponding destination files:
```yaml
changes:
name: test changed-files
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v3
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v35
with:
since_last_remote_commit: true
separator: ","
- name: copy file to server
uses: appleboy/scp-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
source: ${{ steps.changed-files.outputs.all_changed_files }}
target: test
```
Old target structure: Old target structure:
```sh ```sh
@ -287,39 +296,11 @@ foobar
└── b.txt └── b.txt
``` ```
Only copy files that are newer than the corresponding destination files:
```yaml
changes:
name: test changed-files
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v4
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v35
with:
since_last_remote_commit: true
separator: ","
- name: copy file to server
uses: appleboy/scp-action@v0.1.7
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
source: ${{ steps.changed-files.outputs.all_changed_files }}
target: your_server_target_folder_path
```
Protecting a Private Key. The purpose of the passphrase is usually to encrypt the private key. This makes the key file by itself useless to an attacker. It is not uncommon for files to leak from backups or decommissioned hardware, and hackers commonly exfiltrate files from compromised systems. Protecting a Private Key. The purpose of the passphrase is usually to encrypt the private key. This makes the key file by itself useless to an attacker. It is not uncommon for files to leak from backups or decommissioned hardware, and hackers commonly exfiltrate files from compromised systems.
```diff ```diff
- name: ssh key with passphrase - name: ssh key with passphrase
uses: appleboy/scp-action@v0.1.7 uses: appleboy/scp-action@master
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -327,36 +308,5 @@ Protecting a Private Key. The purpose of the passphrase is usually to encrypt th
+ passphrase: ${{ secrets.PASSPHRASE }} + passphrase: ${{ secrets.PASSPHRASE }}
port: ${{ secrets.PORT }} port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt" source: "tests/a.txt,tests/b.txt"
target: your_server_target_folder_path target: "test"
```
When copying files from a Linux runner to a Windows server, you should:
1. Download git for Windows
2. Change the default OpenSSH shell to git bach with the following powershell command.
3. Set `tar_dereference` and `rm` variable to `true` in the YAML file
4. Avoid putting the `port` value through a variable
5. Convert the target path to a Unix path: `/c/path/to/target/`
Change the default OpenSSH shell to git bach with the following powershell command.
```powershell
New-ItemProperty -Path "HKLM:\SOFTWARE\OpenSSH" -Name DefaultShell -Value "$env:Programfiles\Git\bin\bash.exe" -PropertyType String -Force
```
Convert the target path to a Unix path: `/c/path/to/target/`
```diff
- name: Copy to Windows
uses: appleboy/scp-action@v0.1.7
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.SSH_PRIVATE_KEY }}
port: 22
source: 'your_source_path'
- target: 'C:\path\to\target'
+ target: '/c/path/to/target/'
+ tar_dereference: true
+ rm: true
``` ```

90
action.yml
View File

@ -1,80 +1,84 @@
name: "SCP Command to Transfer Files" name: 'SCP Command to Transfer Files'
description: "How to Use SCP Command to Transfer Files/Folders in Linux" description: 'How to Use SCP Command to Transfer Files/Folders in Linux'
author: "Bo-Yi Wu" author: 'Bo-Yi Wu'
inputs: inputs:
host: host:
description: "scp remote host" description: 'scp remote host'
port: port:
description: "scp remote port" description: 'scp remote port'
default: "22" default: 22
username: username:
description: "scp username" description: 'scp username'
password: password:
description: "scp password" description: 'scp password'
protocol:
description: "The IP protocol to use. Valid values are 'tcp'. 'tcp4' or 'tcp6'. Default to tcp."
default: "tcp"
timeout: timeout:
description: "timeout for ssh to remote host" description: 'timeout for ssh to remote host'
default: "30s" default: "30s"
command_timeout: command_timeout:
description: "timeout for scp command" description: 'timeout for scp command'
default: "10m" default: "10m"
key: key:
description: "content of ssh private key. ex raw content of ~/.ssh/id_rsa" description: 'content of ssh private key. ex raw content of ~/.ssh/id_rsa'
key_path: key_path:
description: "path of ssh private key" description: 'path of ssh private key'
passphrase: passphrase:
description: "ssh key passphrase" description: 'ssh key passphrase'
fingerprint: fingerprint:
description: "fingerprint SHA256 of the host public key, default is to skip verification" description: 'fingerprint SHA256 of the host public key, default is to skip verification'
use_insecure_cipher: use_insecure_cipher:
description: "include more ciphers with use_insecure_cipher" description: 'include more ciphers with use_insecure_cipher'
default: false
target: target:
description: "target path on the server, must be a directory path." description: 'target path on the server, must be a directory path.'
source: source:
description: "scp file list" description: 'scp file list'
rm: rm:
description: "remove target folder before upload data" description: 'remove target folder before upload data'
default: false
debug: debug:
description: "enable debug message" description: 'enable debug message'
default: false
strip_components: strip_components:
description: "remove the specified number of leading path elements" description: 'remove the specified number of leading path elements'
default: 0
overwrite: overwrite:
description: "use --overwrite flag with tar" description: 'use --overwrite flag with tar'
default: false
tar_dereference: tar_dereference:
description: "use --dereference flag with tar" description: 'use --dereference flag with tar'
default: false
tar_tmp_path: tar_tmp_path:
description: "temporary path for tar file on the dest host" description: 'temporary path for tar file on the dest host'
tar_exec: tar_exec:
description: "temporary path for tar file on the dest host" description: 'temporary path for tar file on the dest host'
default: "tar" default: 'tar'
proxy_host: proxy_host:
description: "ssh proxy remote host" description: 'ssh proxy remote host'
proxy_port: proxy_port:
description: "ssh proxy remote port" description: 'ssh proxy remote port'
default: "22" default: 22
proxy_username: proxy_username:
description: "ssh proxy username" description: 'ssh proxy username'
proxy_password: proxy_password:
description: "ssh proxy password" description: 'ssh proxy password'
proxy_passphrase: proxy_passphrase:
description: "ssh proxy key passphrase" description: 'ssh proxy key passphrase'
proxy_timeout: proxy_timeout:
description: "timeout for ssh to proxy host" description: 'timeout for ssh to proxy host'
default: "30s" default: "30s"
proxy_key: proxy_key:
description: "content of ssh proxy private key. ex raw content of ~/.ssh/id_rsa" description: 'content of ssh proxy private key. ex raw content of ~/.ssh/id_rsa'
proxy_key_path: proxy_key_path:
description: "path of ssh proxy private key" description: 'path of ssh proxy private key'
proxy_fingerprint: proxy_fingerprint:
description: "fingerprint SHA256 of the host public key, default is to skip verification" description: 'fingerprint SHA256 of the host public key, default is to skip verification'
proxy_use_insecure_cipher: proxy_use_insecure_cipher:
description: "include more ciphers with use_insecure_cipher" description: 'include more ciphers with use_insecure_cipher'
default: false
runs: runs:
using: "docker" using: 'docker'
image: "Dockerfile" image: 'Dockerfile'
branding: branding:
icon: "copy" icon: 'copy'
color: "gray-dark" color: 'gray-dark'