GitHub Action that copy files and artifacts via SSH.
Go to file
Bo-Yi Wu b476d5806f fix: action name 2019-05-11 22:28:54 +08:00
.github fix: Add secret in args 2019-05-11 22:27:02 +08:00
images docs: update readme 2019-05-11 17:04:21 +08:00
tests feat: Copy file via ssh key 2019-05-11 19:28:30 +08:00
Dockerfile fix: action name 2019-05-11 22:28:54 +08:00
LICENSE Initial commit 2019-05-11 14:27:38 +08:00
README.md docs: update readme 2019-05-11 19:49:38 +08:00
entrypoint.sh chore: update drone scp command 2019-05-11 20:30:07 +08:00

README.md

🚀 SCP for GitHub Actions

GitHub Action for copying files and artifacts via SSH.

Usage

copy files and artifacts via SSH as blow.

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",
  ]
}

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

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",
  ]
}

Copy file via ssh key

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:

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",
  ]
}

Secrets

  • PASSWORD - ssh server password
  • KEY - ssh server private key