You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2.3 KiB

Raw Blame History

🚀 SCP for GitHub Actions

GitHub Action for copying files and artifacts via SSH.

Usage

copy files and artifacts via SSH as blow.

- name: copy file via ssh password
  uses: appleboy/scp-action@master
  env:
    HOST: ${{ secrets.HOST }}
    USERNAME: ${{ secrets.USERNAME }}
    PASSWORD: ${{ secrets.PASSWORD }}
    PORT: ${{ secrets.PORT }}
  with:
    source: "tests/a.txt,tests/b.txt"
    target: "test

Environment variables

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

Example

Copy file via ssh password

- name: copy file via ssh password
  uses: appleboy/scp-action@master
  with:
    host: example.com
    username: foo
    password: bar
    port: 22
    source: "tests/a.txt,tests/b.txt"
    target: "test"

Copy file via ssh key

- name: copy file via ssh key
  uses: appleboy/scp-action@master
  env:
    HOST: ${{ secrets.HOST }}
    USERNAME: ${{ secrets.USERNAME }}
    PORT: ${{ secrets.PORT }}
    KEY: ${{ secrets.KEY }}
  with:
    source: "tests/a.txt,tests/b.txt"
    target: "test"

Example configuration for ignore list:

- name: copy file via ssh key
  uses: appleboy/scp-action@master
  env:
    HOST: ${{ secrets.HOST }}
    USERNAME: ${{ secrets.USERNAME }}
    PORT: ${{ secrets.PORT }}
    KEY: ${{ secrets.KEY }}
  with:
    source: "tests/*.txt,!tests/a.txt"
    target: "test"

Example configuration for multiple server

- name: copy file via ssh password
  uses: appleboy/scp-action@master
  with:
-   host: "example.com"
+   host: "foo.com,bar.com"
    username: foo
    password: bar
    port: 22
    source: "tests/a.txt,tests/b.txt"
    target: "test"

Input variables

see the action.yml file for more detail imformation.

host - scp remote host
port - scp remote port
username - scp username
password - scp password
timeout - timeout for ssh to remote host
command_timeout - timeout for scp command
key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
key_path - path of ssh private key
target - target path on the server
source - scp file list
rm - remove target folder before upload data