easingthemes-ssh-deploy/action.yml

name: "ssh deploy"
description: "NodeJS action for FAST deployment with rsync/ssh and remote script execution before/after rsync"
author: "easingthemes"
inputs:
  SSH_PRIVATE_KEY:
    description: "Private key part of an SSH key pair"
    required: true
  REMOTE_HOST:
    description: "Remote host"
    required: true
  REMOTE_USER:
    description: "Remote user"
    required: true
  REMOTE_PORT:
    description: "Remote port"
    required: false
    default: "22"
  SOURCE:
    description: "Source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`"
    required: false
    default: ""
  TARGET:
    description: "Target directory"
    required: false
    default: "/home/REMOTE_USER/"
  ARGS:
    description: "Arguments to pass to rsync"
    required: false
    default: "-rltgoDzvO"
  SSH_CMD_ARGS:
    description: "An array of ssh arguments, they must be prefixed with -o and separated by a comma, for example: -o SomeArgument=no, -o SomeOtherArgument=5 "
    required: false
    default: "-o StrictHostKeyChecking=no"
  EXCLUDE:
    description: "paths to exclude separated by `,`, ie: `/dist/, /node_modules/`"
    required: false
    default: ""
  SCRIPT_BEFORE:
    description: "Script to run on host machine before rsync"
    required: false
    default: ""
  SCRIPT_AFTER:
    description: "Script to run on host machine after rsync"
    required: false
    default: ""
outputs:
  status:
    description: "Status"
runs:
  using: "node16"
  main: "dist/index.js"
branding:
  color: "green"
  icon: "truck"
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`name: "ssh deploy"`
Feature/ssh cmd (#94) * feat: Add SSH remote script support - before and after rsync * fix: remove __dirname * feat: add sshCmdArgs option * Add promise instead of callback * fix: improve logs * fix: Add simple command exists instead of a plugin * add non interactive install * feat: add onStderr and onStdout logs * Improve reject messages * feat: Add RSYNC_STDOUT env variable * emoji updates * fix: update workflow actions 2023-01-03 04:06:33 +08:00			`description: "NodeJS action for FAST deployment with rsync/ssh and remote script execution before/after rsync"`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`author: "easingthemes"`
[engine] use NodeJS instead of Docker 2019-10-03 05:52:52 +08:00			`inputs:`
Feature/ssh cmd (#94) * feat: Add SSH remote script support - before and after rsync * fix: remove __dirname * feat: add sshCmdArgs option * Add promise instead of callback * fix: improve logs * fix: Add simple command exists instead of a plugin * add non interactive install * feat: add onStderr and onStdout logs * Improve reject messages * feat: Add RSYNC_STDOUT env variable * emoji updates * fix: update workflow actions 2023-01-03 04:06:33 +08:00			`SSH_PRIVATE_KEY:`
			`description: "Private key part of an SSH key pair"`
[engine] use NodeJS instead of Docker 2019-10-03 05:52:52 +08:00			`required: true`
			`REMOTE_HOST:`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`description: "Remote host"`
[engine] use NodeJS instead of Docker 2019-10-03 05:52:52 +08:00			`required: true`
			`REMOTE_USER:`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`description: "Remote user"`
[engine] use NodeJS instead of Docker 2019-10-03 05:52:52 +08:00			`required: true`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`REMOTE_PORT:`
			`description: "Remote port"`
[action] add required params 2020-04-11 22:27:09 +08:00			`required: false`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`default: "22"`
[engine] use NodeJS instead of Docker 2019-10-03 05:52:52 +08:00			`SOURCE:`
Feature/ssh cmd (#94) * feat: Add SSH remote script support - before and after rsync * fix: remove __dirname * feat: add sshCmdArgs option * Add promise instead of callback * fix: improve logs * fix: Add simple command exists instead of a plugin * add non interactive install * feat: add onStderr and onStdout logs * Improve reject messages * feat: Add RSYNC_STDOUT env variable * emoji updates * fix: update workflow actions 2023-01-03 04:06:33 +08:00			description: "Source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`"
[action] add required params 2020-04-11 22:27:09 +08:00			`required: false`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`default: ""`
[engine] use NodeJS instead of Docker 2019-10-03 05:52:52 +08:00			`TARGET:`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`description: "Target directory"`
[action] add required params 2020-04-11 22:27:09 +08:00			`required: false`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`default: "/home/REMOTE_USER/"`
action.yml: Add mising declaration for the ARGS parameter 2020-07-01 04:03:20 +08:00			`ARGS:`
			`description: "Arguments to pass to rsync"`
			`required: false`
			`default: "-rltgoDzvO"`
Feature/ssh cmd (#94) * feat: Add SSH remote script support - before and after rsync * fix: remove __dirname * feat: add sshCmdArgs option * Add promise instead of callback * fix: improve logs * fix: Add simple command exists instead of a plugin * add non interactive install * feat: add onStderr and onStdout logs * Improve reject messages * feat: Add RSYNC_STDOUT env variable * emoji updates * fix: update workflow actions 2023-01-03 04:06:33 +08:00			`SSH_CMD_ARGS:`
			`description: "An array of ssh arguments, they must be prefixed with -o and separated by a comma, for example: -o SomeArgument=no, -o SomeOtherArgument=5 "`
			`required: false`
			`default: "-o StrictHostKeyChecking=no"`
BREAKING CHANGE: update to use nodeJS v16 Since it's used in Github environment it should not have any impact in usage. Just in case major version updated. Fixes #82 2022-10-28 09:44:28 +08:00			`EXCLUDE:`
Feature/ssh cmd (#94) * feat: Add SSH remote script support - before and after rsync * fix: remove __dirname * feat: add sshCmdArgs option * Add promise instead of callback * fix: improve logs * fix: Add simple command exists instead of a plugin * add non interactive install * feat: add onStderr and onStdout logs * Improve reject messages * feat: Add RSYNC_STDOUT env variable * emoji updates * fix: update workflow actions 2023-01-03 04:06:33 +08:00			description: "paths to exclude separated by `,`, ie: `/dist/, /node_modules/`"
			`required: false`
			`default: ""`
			`SCRIPT_BEFORE:`
			`description: "Script to run on host machine before rsync"`
			`required: false`
			`default: ""`
			`SCRIPT_AFTER:`
			`description: "Script to run on host machine after rsync"`
Update action.yml 2021-03-12 14:26:41 +08:00			`required: false`
			`default: ""`
[engine] use NodeJS instead of Docker 2019-10-03 05:52:52 +08:00			`outputs:`
			`status:`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`description: "Status"`
[engine] use NodeJS instead of Docker 2019-10-03 05:52:52 +08:00			`runs:`
BREAKING CHANGE: update to use nodeJS v16 Since it's used in Github environment it should not have any impact in usage. Just in case major version updated. Fixes #82 2022-10-28 09:44:28 +08:00			`using: "node16"`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`main: "dist/index.js"`
[engine] use NodeJS instead of Docker 2019-10-03 05:52:52 +08:00			`branding:`
add optional `REMOTE_PORT` env to configuration 2019-12-29 22:36:34 +08:00			`color: "green"`
			`icon: "truck"`