mirror of
https://ghproxy.net/https://github.com/appleboy/scp-action.git
synced 2025-04-20 07:03:07 +00:00
Compare commits
No commits in common. "master" and "v0.0.1" have entirely different histories.
13
.github/FUNDING.yml
vendored
13
.github/FUNDING.yml
vendored
@ -1,13 +0,0 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
otechie: # Replace with a single Otechie username
|
||||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
|
||||
custom: ['https://www.paypal.me/appleboy46']
|
||||
10
.github/dependabot.yml
vendored
10
.github/dependabot.yml
vendored
@ -1,10 +0,0 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
- package-ecosystem: gomod
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
65
.github/main.workflow
vendored
Normal file
65
.github/main.workflow
vendored
Normal file
@ -0,0 +1,65 @@
|
||||
workflow "Copy File Via SSH" {
|
||||
on = "push"
|
||||
resolves = [
|
||||
"Copy file via ssh password",
|
||||
"Copy file via ssh key",
|
||||
"Add source in args",
|
||||
"Add secret in args",
|
||||
]
|
||||
}
|
||||
|
||||
action "Copy file via ssh password" {
|
||||
uses = "appleboy/scp-action@master"
|
||||
env = {
|
||||
SOURCE = "tests/a.txt,tests/b.txt"
|
||||
TARGET = "/home/actions/test"
|
||||
}
|
||||
secrets = [
|
||||
"HOST",
|
||||
"USERNAME",
|
||||
"PASSWORD",
|
||||
]
|
||||
}
|
||||
|
||||
action "Copy file via ssh key" {
|
||||
uses = "appleboy/scp-action@master"
|
||||
env = {
|
||||
SOURCE = "tests/a.txt,tests/b.txt"
|
||||
TARGET = "/home/actions/test"
|
||||
}
|
||||
secrets = [
|
||||
"HOST",
|
||||
"USERNAME",
|
||||
"KEY",
|
||||
]
|
||||
}
|
||||
|
||||
action "Add source in args" {
|
||||
uses = "appleboy/scp-action@master"
|
||||
env = {
|
||||
TARGET = "/home/actions/test1234"
|
||||
}
|
||||
secrets = [
|
||||
"HOST",
|
||||
"USERNAME",
|
||||
"KEY",
|
||||
]
|
||||
args = ["--source", "tests/a.txt", "--source", "tests/b.txt"]
|
||||
}
|
||||
|
||||
action "Add secret in args" {
|
||||
uses = "appleboy/scp-action@master"
|
||||
env = {
|
||||
TARGET = "/home/actions/test1234"
|
||||
}
|
||||
secrets = [
|
||||
"HOST",
|
||||
"TEST_USERNAME",
|
||||
"KEY",
|
||||
]
|
||||
args = [
|
||||
"--username", "$TEST_USERNAME",
|
||||
"--source", "tests/a.txt",
|
||||
"--source", "tests/b.txt",
|
||||
]
|
||||
}
|
||||
150
.github/workflows/ci.yml
vendored
150
.github/workflows/ci.yml
vendored
@ -1,150 +0,0 @@
|
||||
name: scp files
|
||||
on: [push]
|
||||
jobs:
|
||||
testing:
|
||||
name: test scp action
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: copy file via ssh password
|
||||
uses: ./
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
password: ${{ secrets.PASSWORD }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: "test"
|
||||
|
||||
- name: copy file via ssh key
|
||||
uses: ./
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
key: ${{ secrets.KEY }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: "test"
|
||||
|
||||
- name: remove the specified number of leading path elements
|
||||
uses: ./
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
key: ${{ secrets.KEY }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: "foobar"
|
||||
strip_components: 1
|
||||
|
||||
- name: ssh key with passphrase
|
||||
uses: ./
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
key: ${{ secrets.SSH2 }}
|
||||
passphrase: ${{ secrets.PASSPHRASE }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: "test"
|
||||
|
||||
- name: use insecure cipher
|
||||
uses: ./
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
key: ${{ secrets.SSH2 }}
|
||||
passphrase: ${{ secrets.PASSPHRASE }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: "test"
|
||||
use_insecure_cipher: true
|
||||
|
||||
deploy:
|
||||
name: test deploy artifact
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- run: echo hello > world.txt
|
||||
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: my-artifact
|
||||
path: world.txt
|
||||
|
||||
- uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: my-artifact
|
||||
path: distfiles
|
||||
|
||||
- name: copy file to server
|
||||
uses: ./
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
key: ${{ secrets.KEY }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: distfiles/*
|
||||
target: test
|
||||
|
||||
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@v45
|
||||
with:
|
||||
since_last_remote_commit: true
|
||||
separator: ","
|
||||
|
||||
- name: copy file to server
|
||||
uses: ./
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
key: ${{ secrets.KEY }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: ${{ steps.changed-files.outputs.all_changed_files }}
|
||||
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
33
.github/workflows/goreleaser.yml
vendored
@ -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 }}
|
||||
@ -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
|
||||
17
Dockerfile
17
Dockerfile
@ -1,5 +1,16 @@
|
||||
FROM ghcr.io/appleboy/drone-scp:1.6.14
|
||||
FROM appleboy/drone-scp:1.5.1-linux-amd64
|
||||
|
||||
COPY entrypoint.sh /bin/entrypoint.sh
|
||||
# Github labels
|
||||
LABEL "com.github.actions.name"="SCP Files"
|
||||
LABEL "com.github.actions.description"="Copy files and artifacts via SSH"
|
||||
LABEL "com.github.actions.icon"="copy"
|
||||
LABEL "com.github.actions.color"="gray-dark"
|
||||
|
||||
ENTRYPOINT ["/bin/entrypoint.sh"]
|
||||
LABEL "repository"="https://github.com/appleboy/scp-action"
|
||||
LABEL "homepage"="https://github.com/appleboy"
|
||||
LABEL "maintainer"="Bo-Yi Wu <appleboy.tw@gmail.com>"
|
||||
LABEL "version"="0.0.1"
|
||||
|
||||
ADD entrypoint.sh /entrypoint.sh
|
||||
RUN chmod +x /entrypoint.sh
|
||||
ENTRYPOINT ["/entrypoint.sh"]
|
||||
|
||||
411
README.md
411
README.md
@ -1,362 +1,97 @@
|
||||
# 🚀 SCP for GitHub Actions
|
||||
|
||||
[GitHub Action](https://github.com/features/actions) for copying files and artifacts via SSH.
|
||||
[GitHub Action](https://developer.github.com/actions/) for copying files and artifacts via SSH.
|
||||
|
||||
[](https://github.com/appleboy/scp-action/actions)
|
||||
|
||||
**Important**: Only supports **Linux** [docker](https://www.docker.com/) containers.
|
||||
<img src="./images/copy-multiple-file.png">
|
||||
|
||||
## Usage
|
||||
|
||||
Copy files and artifacts via SSH:
|
||||
copy files and artifacts via SSH as blow.
|
||||
|
||||
```yaml
|
||||
name: scp files
|
||||
on: [push]
|
||||
jobs:
|
||||
build:
|
||||
name: Build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: copy file via ssh password
|
||||
uses: appleboy/scp-action@v0.1.7
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
password: ${{ secrets.PASSWORD }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: your_server_target_folder_path
|
||||
```
|
||||
action "Copy multiple file" {
|
||||
uses = "appleboy/scp-action@master"
|
||||
env = {
|
||||
HOST = "example.com"
|
||||
USERNAME = "foo"
|
||||
PASSWORD = "bar"
|
||||
PORT = "22"
|
||||
SOURCE = "tests/a.txt,tests/b.txt"
|
||||
TARGET = "/home/foo/test"
|
||||
}
|
||||
secrets = [
|
||||
"PASSWORD",
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Input variables
|
||||
## Environment variables
|
||||
|
||||
See the [action.yml](./action.yml) file for more detail information.
|
||||
* HOST - ssh server host
|
||||
* PORT - ssh server port
|
||||
* USERNAME - ssh server username
|
||||
* PASSWORD - ssh server password
|
||||
* KEY - ssh server private key
|
||||
* TARGET - target folder
|
||||
* SOURCE - scp file list
|
||||
|
||||
| Variable | Description | Default Value |
|
||||
| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------- |
|
||||
| host | SCP remote host | - |
|
||||
| port | SCP remote port | `22` |
|
||||
| username | SCP username | - |
|
||||
| password | SCP password | - |
|
||||
| passphrase | The passphrase is usually used to encrypt the private key | - |
|
||||
| protocol | The IP protocol to use. Valid values are `tcp`, `tcp4`, or `tcp6`. | `tcp` |
|
||||
| fingerprint | Fingerprint SHA256 of the host public key. Default is to skip verification | - |
|
||||
| timeout | Timeout for SSH to remote host | `30s` |
|
||||
| command_timeout | Timeout for SCP command | `10m` |
|
||||
| key | Content of SSH private key. e.g., raw content of ~/.ssh/id_rsa | - |
|
||||
| key_path | Path of SSH private key | - |
|
||||
| target | Target path on the server, must be a directory (**required**) | - |
|
||||
| source | SCP file list (**required**) | - |
|
||||
| rm | Remove target folder before uploading data | `false` |
|
||||
| strip_components | Remove the specified number of leading path elements | - |
|
||||
| overwrite | Use `--overwrite` flag with tar, overwrite existing files when extracting | - |
|
||||
| tar_tmp_path | Temporary path for tar file on the destination host | - |
|
||||
| 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)) | - |
|
||||
### Example
|
||||
|
||||
SSH Proxy Setting:
|
||||
Copy file via ssh password
|
||||
|
||||
| Variable | Description | Default Value |
|
||||
| ------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------- |
|
||||
| proxy_host | Proxy host | - |
|
||||
| proxy_port | Proxy port | `22` |
|
||||
| proxy_username | Proxy username | - |
|
||||
| proxy_password | Proxy password | - |
|
||||
| proxy_protocol | The IP protocol to use. Valid values are `tcp`, `tcp4`, or `tcp6`. | `tcp` |
|
||||
| proxy_passphrase | The passphrase is usually used to encrypt the private key | - |
|
||||
| proxy_timeout | Timeout for SSH to proxy host | `30s` |
|
||||
| proxy_key | Content of SSH proxy private key | - |
|
||||
| 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
|
||||
|
||||
Make sure to follow the steps below when creating and using SSH keys.
|
||||
The best practice is to create the SSH keys on the local machine, not the remote machine.
|
||||
Log in with the username specified in GitHub Secrets and generate an RSA key pair:
|
||||
|
||||
```bash
|
||||
# rsa
|
||||
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
|
||||
|
||||
# ed25519
|
||||
ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
|
||||
```
|
||||
action "Copy multiple file" {
|
||||
uses = "appleboy/scp-action@master"
|
||||
env = {
|
||||
HOST = "example.com"
|
||||
USERNAME = "foo"
|
||||
PORT = "22"
|
||||
SOURCE = "tests/a.txt,tests/b.txt"
|
||||
TARGET = "/home/foo/test"
|
||||
}
|
||||
secrets = [
|
||||
"PASSWORD",
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Add newly generated key into Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/).
|
||||
Copy file via ssh key
|
||||
|
||||
```bash
|
||||
# rsa
|
||||
cat .ssh/id_rsa.pub | ssh b@B 'cat >> .ssh/authorized_keys'
|
||||
|
||||
# d25519
|
||||
cat .ssh/id_ed25519.pub | ssh b@B 'cat >> .ssh/authorized_keys'
|
||||
```
|
||||
|
||||
Copy Private Key content and paste in Github Secrets.
|
||||
|
||||
```bash
|
||||
# rsa
|
||||
clip < ~/.ssh/id_rsa
|
||||
|
||||
# ed25519
|
||||
clip < ~/.ssh/id_ed25519
|
||||
```
|
||||
|
||||
See the detail information about [SSH login without password](http://www.linuxproblem.org/art_9.html).
|
||||
|
||||
**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`
|
||||
- Change the permissions of `.ssh` to 700
|
||||
- Change the permissions of `.ssh/authorized_keys2` to 640
|
||||
|
||||
### If you are using OpenSSH
|
||||
|
||||
If you are currently using OpenSSH and are getting the following error:
|
||||
|
||||
```bash
|
||||
ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey]
|
||||
```
|
||||
|
||||
Make sure that your key algorithm of choice is supported.
|
||||
On Ubuntu 20.04 or later you must explicitly allow the use of the ssh-rsa algorithm. Add the following line to your OpenSSH daemon file (which is either `/etc/ssh/sshd_config` or a drop-in file under `/etc/ssh/sshd_config.d/`):
|
||||
|
||||
```bash
|
||||
CASignatureAlgorithms +ssh-rsa
|
||||
```
|
||||
|
||||
Alternatively, `ed25519` keys are accepted by default in OpenSSH. You could use this instead of rsa if needed:
|
||||
|
||||
```bash
|
||||
ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
Copy file via a SSH password:
|
||||
|
||||
```yaml
|
||||
- name: copy file via ssh password
|
||||
uses: appleboy/scp-action@v0.1.7
|
||||
with:
|
||||
host: example.com
|
||||
username: foo
|
||||
password: bar
|
||||
port: 22
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: your_server_target_folder_path
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```yaml
|
||||
- name: copy file via ssh key
|
||||
uses: appleboy/scp-action@v0.1.7
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
port: ${{ secrets.PORT }}
|
||||
key: ${{ secrets.KEY }}
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: your_server_target_folder_path
|
||||
action "Copy file via ssh key" {
|
||||
uses = "appleboy/scp-action@master"
|
||||
env = {
|
||||
HOST = "example.com"
|
||||
USERNAME = "foo"
|
||||
PORT = "22"
|
||||
SOURCE = "tests/c.txt,tests/d.txt"
|
||||
TARGET = "/home/actions/test"
|
||||
}
|
||||
secrets = [
|
||||
"KEY",
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Example configuration for ignore list:
|
||||
|
||||
```yaml
|
||||
- name: copy file via ssh key
|
||||
uses: appleboy/scp-action@v0.1.7
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
port: ${{ secrets.PORT }}
|
||||
key: ${{ secrets.KEY }}
|
||||
source: "tests/*.txt,!tests/a.txt"
|
||||
target: your_server_target_folder_path
|
||||
```
|
||||
action "reqular expression list" {
|
||||
uses = "appleboy/scp-action@master"
|
||||
env = {
|
||||
HOST = "example.com"
|
||||
USERNAME = "foo"
|
||||
PORT = "22"
|
||||
SOURCE = "tests/*.txt,!tests/a.txt"
|
||||
TARGET = "/home/actions/test"
|
||||
}
|
||||
secrets = [
|
||||
"KEY",
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Example configuration for multiple servers:
|
||||
## Secrets
|
||||
|
||||
```diff
|
||||
uses: appleboy/scp-action@v0.1.7
|
||||
with:
|
||||
- host: "example.com"
|
||||
+ host: "foo.com,bar.com"
|
||||
username: foo
|
||||
password: bar
|
||||
port: 22
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: your_server_target_folder_path
|
||||
```
|
||||
|
||||
Example configuration for exclude custom files:
|
||||
|
||||
```yaml
|
||||
uses: appleboy/scp-action@v0.1.7
|
||||
with:
|
||||
host: "example.com"
|
||||
username: foo
|
||||
password: bar
|
||||
port: 22
|
||||
- source: "tests/*.txt"
|
||||
+ source: "tests/*.txt,!tests/a.txt,!tests/b.txt"
|
||||
target: your_server_target_folder_path
|
||||
```
|
||||
|
||||
Upload artifact files to remote server:
|
||||
|
||||
```yaml
|
||||
deploy:
|
||||
name: deploy artifact
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- run: echo hello > world.txt
|
||||
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: my-artifact
|
||||
path: world.txt
|
||||
|
||||
- uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: my-artifact
|
||||
path: distfiles
|
||||
|
||||
- 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: distfiles/*
|
||||
target: your_server_target_folder_path
|
||||
```
|
||||
|
||||
Remove the specified number of leading path elements:
|
||||
|
||||
```yaml
|
||||
- name: remove the specified number of leading path elements
|
||||
uses: appleboy/scp-action@v0.1.7
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
key: ${{ secrets.KEY }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: your_server_target_folder_path
|
||||
strip_components: 1
|
||||
```
|
||||
|
||||
Old target structure:
|
||||
|
||||
```sh
|
||||
foobar
|
||||
└── tests
|
||||
├── a.txt
|
||||
└── b.txt
|
||||
```
|
||||
|
||||
New target structure:
|
||||
|
||||
```sh
|
||||
foobar
|
||||
├── a.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.
|
||||
|
||||
```diff
|
||||
- name: ssh key with passphrase
|
||||
uses: appleboy/scp-action@v0.1.7
|
||||
with:
|
||||
host: ${{ secrets.HOST }}
|
||||
username: ${{ secrets.USERNAME }}
|
||||
key: ${{ secrets.SSH2 }}
|
||||
+ passphrase: ${{ secrets.PASSPHRASE }}
|
||||
port: ${{ secrets.PORT }}
|
||||
source: "tests/a.txt,tests/b.txt"
|
||||
target: your_server_target_folder_path
|
||||
```
|
||||
|
||||
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
|
||||
```
|
||||
* `PASSWORD` - ssh server password
|
||||
* `KEY` - ssh server private key
|
||||
|
||||
80
action.yml
80
action.yml
@ -1,80 +0,0 @@
|
||||
name: "SCP Command to Transfer Files"
|
||||
description: "How to Use SCP Command to Transfer Files/Folders in Linux"
|
||||
author: "Bo-Yi Wu"
|
||||
inputs:
|
||||
host:
|
||||
description: "scp remote host"
|
||||
port:
|
||||
description: "scp remote port"
|
||||
default: "22"
|
||||
username:
|
||||
description: "scp username"
|
||||
password:
|
||||
description: "scp password"
|
||||
protocol:
|
||||
description: "The IP protocol to use. Valid values are 'tcp'. 'tcp4' or 'tcp6'. Default to tcp."
|
||||
default: "tcp"
|
||||
timeout:
|
||||
description: "timeout for ssh to remote host"
|
||||
default: "30s"
|
||||
command_timeout:
|
||||
description: "timeout for scp command"
|
||||
default: "10m"
|
||||
key:
|
||||
description: "content of ssh private key. ex raw content of ~/.ssh/id_rsa"
|
||||
key_path:
|
||||
description: "path of ssh private key"
|
||||
passphrase:
|
||||
description: "ssh key passphrase"
|
||||
fingerprint:
|
||||
description: "fingerprint SHA256 of the host public key, default is to skip verification"
|
||||
use_insecure_cipher:
|
||||
description: "include more ciphers with use_insecure_cipher"
|
||||
target:
|
||||
description: "target path on the server, must be a directory path."
|
||||
source:
|
||||
description: "scp file list"
|
||||
rm:
|
||||
description: "remove target folder before upload data"
|
||||
debug:
|
||||
description: "enable debug message"
|
||||
strip_components:
|
||||
description: "remove the specified number of leading path elements"
|
||||
overwrite:
|
||||
description: "use --overwrite flag with tar"
|
||||
tar_dereference:
|
||||
description: "use --dereference flag with tar"
|
||||
tar_tmp_path:
|
||||
description: "temporary path for tar file on the dest host"
|
||||
tar_exec:
|
||||
description: "temporary path for tar file on the dest host"
|
||||
default: "tar"
|
||||
proxy_host:
|
||||
description: "ssh proxy remote host"
|
||||
proxy_port:
|
||||
description: "ssh proxy remote port"
|
||||
default: "22"
|
||||
proxy_username:
|
||||
description: "ssh proxy username"
|
||||
proxy_password:
|
||||
description: "ssh proxy password"
|
||||
proxy_passphrase:
|
||||
description: "ssh proxy key passphrase"
|
||||
proxy_timeout:
|
||||
description: "timeout for ssh to proxy host"
|
||||
default: "30s"
|
||||
proxy_key:
|
||||
description: "content of ssh proxy private key. ex raw content of ~/.ssh/id_rsa"
|
||||
proxy_key_path:
|
||||
description: "path of ssh proxy private key"
|
||||
proxy_fingerprint:
|
||||
description: "fingerprint SHA256 of the host public key, default is to skip verification"
|
||||
proxy_use_insecure_cipher:
|
||||
description: "include more ciphers with use_insecure_cipher"
|
||||
runs:
|
||||
using: "docker"
|
||||
image: "Dockerfile"
|
||||
|
||||
branding:
|
||||
icon: "copy"
|
||||
color: "gray-dark"
|
||||
@ -2,6 +2,6 @@
|
||||
|
||||
set -eu
|
||||
|
||||
[ -n "$INPUT_STRIP_COMPONENTS" ] && export INPUT_STRIP_COMPONENTS=$((INPUT_STRIP_COMPONENTS + 0))
|
||||
export GITHUB="true"
|
||||
|
||||
sh -c "/bin/drone-scp $*"
|
||||
|
||||
@ -1,2 +1 @@
|
||||
foo
|
||||
foobar
|
||||
|
||||
@ -1,2 +1 @@
|
||||
bar
|
||||
foobar
|
||||
|
||||
@ -1,3 +1 @@
|
||||
c
|
||||
foobar
|
||||
test1234
|
||||
|
||||
@ -1,3 +1 @@
|
||||
d
|
||||
foobar
|
||||
foobar
|
||||
|
||||
Loading…
Reference in New Issue
Block a user