chore(release): 2.2.5 [skip ci]

## [2.2.5](https://github.com/easingthemes/ssh-deploy/compare/v2.2.4...v2.2.5) (2021-05-27)

### Bug Fixes

* semantic-release/npm update config ([40096bf](40096bf224))

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+tab_width = 4
+trim_trailing_whitespace = true

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true
+  },
+  extends: [
+    'airbnb-base'
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly'
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  rules: {
+    "comma-dangle": [
+      "error",
+      "never"
+    ],
+    "no-console": "off",
+    "object-curly-newline": "off"
+  }
+};

.github/workflows/build.yml

@@ -0,0 +1,31 @@
+name: Build
+
+on:
+  push:
+    branches: [ '**' ]
+  pull_request:
+    branches: [ $default-branch ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node-version: [14.x]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Build Library
+        run: npm run build
+      - name: Run Tests
+        run: npm test --if-present

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,47 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '20 12 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+
+    - run: |
+        npm ci
+        npm run build --if-present
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/manual-release.yml

@@ -0,0 +1,43 @@
+name: Manual Release
+on:
+  workflow_dispatch:
+    inputs:
+      dryrun:
+        description: 'DryRUn'
+        required: true
+        default: 'false'
+jobs:
+  release:
+    name: Test, Build and Release
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        node-version: [ 14.x ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix['node-version'] }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Build Library
+        run: npm run build --if-present
+      - name: Run Tests
+        run: npm test --if-present
+      - name: Release
+        uses: cycjimmy/semantic-release-action@v2
+        with:
+          dry_run: ${{ github.event.inputs.dryrun == 'true' }}
+          extra_plugins: |
+            @semantic-release/changelog@3.0.0
+            @semantic-release/git
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GIT_AUTHOR_NAME: github-actions
+          GIT_AUTHOR_EMAIL: github-actions@github.com
+          GIT_COMMITTER_NAME: github-actions
+          GIT_COMMITTER_EMAIL: github-actions@github.com
+          CI: true

.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Test, Build and Release
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        node-version: [ 14.x ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix['node-version'] }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Build Library
+        run: npm run build --if-present
+      - name: Run Tests
+        run: npm test --if-present
+      - name: Release
+        uses: cycjimmy/semantic-release-action@v2
+        with:
+          dry_run: false
+          extra_plugins: |
+            @semantic-release/changelog@3.0.0
+            @semantic-release/git
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GIT_AUTHOR_NAME: github-actions
+          GIT_AUTHOR_EMAIL: github-actions@github.com
+          GIT_COMMITTER_NAME: github-actions
+          GIT_COMMITTER_EMAIL: github-actions@github.com
+          CI: true

.gitignore

@@ -17,3 +17,5 @@ node_modules/
 .env
 .env.test
 
+# IDE
+.idea

.releaserc

@@ -0,0 +1,22 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "docs/CHANGELOG.md"
+      }
+    ],
+    ["@semantic-release/npm", {
+      "npmPublish": false
+    }],
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["docs/CHANGELOG.md"]
+      }
+    ]
+  ]
+}

README.md

@@ -12,39 +12,55 @@ This action would usually follow a build/test action which leaves deployable cod
 
 Pass configuration with `env` vars
 
-1. `SSH_PRIVATE_KEY` [required]
+##### 1. `SSH_PRIVATE_KEY` [required]
 
-This should be the private key part of an ssh key pair. The public key part should be added to the authorized_keys file on the server that receives the deployment.
+Private key part of an SSH key pair.
+The public key part should be added to the `authorized_keys` file on the server that receives the deployment.
 
-2. `REMOTE_HOST` [required]
+More info for SSH keys: https://www.ssh.com/ssh/public-key-authentication
+
+The keys should be generated using the PEM format. You can use this command
+
+```
+ssh-keygen -m PEM -t rsa -b 4096
+```
+
+##### 2. `REMOTE_HOST` [required]
 
 eg: mydomain.com
 
-3. `REMOTE_USER` [required]
+##### 3. `REMOTE_USER` [required]
 
 eg: myusername
 
-3. `REMOTE_PORT` (optional, default '22')
+##### 4. `REMOTE_PORT` (optional, default '22')
 
 eg: '59184'
 
-2. `ARGS` (optional, default '-rltgoDzvO')
+##### 5. `ARGS` (optional, default '-rltgoDzvO')
 
 For any initial/required rsync flags, eg: `-avzr --delete`
 
-3. `SOURCE` (optional, default '')
+##### 6. `SOURCE` (optional, default '')
 
 The source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`
 
-4. `TARGET` (optional, default '/home/REMOTE_USER/')
+##### 7. `TARGET` (optional, default '/home/REMOTE_USER/')
 
 The target directory
 
+##### 8. `EXCLUDE` (optional, default '')
+
+path to exclude separated by `,`, ie: `/dist/, /node_modules/`
+
 # Usage
 
+Use the latest version from Marketplace,eg: ssh-deploy@v2
+or use the latest version from a branch, eg: ssh-deploy@main
+
 ```
   - name: Deploy to Staging server
-    uses: easingthemes/ssh-deploy@v2.0.7
+    uses: easingthemes/ssh-deploy@main
     env:
       SSH_PRIVATE_KEY: ${{ secrets.SERVER_SSH_KEY }}
       ARGS: "-rltgoDzvO"
@@ -52,6 +68,7 @@ The target directory
       REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
       REMOTE_USER: ${{ secrets.REMOTE_USER }}
       TARGET: ${{ secrets.REMOTE_TARGET }}
+      EXCLUDE: "/dist/, /node_modules/"
 ```
 
 # Example usage in workflow
@@ -77,7 +94,7 @@ jobs:
     - name: Run build task
       run: npm run build --if-present
     - name: Deploy to Server
-      uses: easingthemes/ssh-deploy@v2.0.7
+      uses: easingthemes/ssh-deploy@main
       env:
           SSH_PRIVATE_KEY: ${{ secrets.SERVER_SSH_KEY }}
           ARGS: "-rltgoDzvO --delete"
@@ -85,10 +102,9 @@ jobs:
           REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
           REMOTE_USER: ${{ secrets.REMOTE_USER }}
           TARGET: ${{ secrets.REMOTE_TARGET }}
+          EXCLUDE: "/dist/, /node_modules/"
 ```
 
 ## Disclaimer
 
-If you're using GitHub Actions, you'll probably already know that it's still in limited public beta, and GitHub advise against using Actions in production.
+Check your keys. Check your deployment paths. And use at your own risk.
-
-So, check your keys. Check your deployment paths. And use at your own risk.

action.yml

@@ -13,13 +13,24 @@ inputs:
     required: true
   REMOTE_PORT:
     description: "Remote port"
+    required: false
     default: "22"
   SOURCE:
     description: "Source directory"
+    required: false
     default: ""
   TARGET:
     description: "Target directory"
+    required: false
     default: "/home/REMOTE_USER/"
+  ARGS:
+    description: "Arguments to pass to rsync"
+    required: false
+    default: "-rltgoDzvO"
+  EXCLUDE: 
+    description: "An array of folder to exclude"
+    required: false
+    default: ""
 outputs:
   status:
     description: "Status"

dist/index.js

@@ -1,66 +1,25 @@
 #!/usr/bin/env node
-module.exports =
+/******/ (() => { // webpackBootstrap
-/******/ (function(modules, runtime) { // webpackBootstrap
+/******/ 	var __webpack_modules__ = ({
-/******/ 	"use strict";
-/******/ 	// The module cache
-/******/ 	var installedModules = {};
-/******/
-/******/ 	// The require function
-/******/ 	function __webpack_require__(moduleId) {
-/******/
-/******/ 		// Check if module is in cache
-/******/ 		if(installedModules[moduleId]) {
-/******/ 			return installedModules[moduleId].exports;
-/******/ 		}
-/******/ 		// Create a new module (and put it into the cache)
-/******/ 		var module = installedModules[moduleId] = {
-/******/ 			i: moduleId,
-/******/ 			l: false,
-/******/ 			exports: {}
-/******/ 		};
-/******/
-/******/ 		// Execute the module function
-/******/ 		modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
-/******/
-/******/ 		// Flag the module as loaded
-/******/ 		module.l = true;
-/******/
-/******/ 		// Return the exports of the module
-/******/ 		return module.exports;
-/******/ 	}
-/******/
-/******/
-/******/ 	__webpack_require__.ab = __dirname + "/";
-/******/
-/******/ 	// the startup function
-/******/ 	function startup() {
-/******/ 		// Load entry module and return exports
-/******/ 		return __webpack_require__(676);
-/******/ 	};
-/******/
-/******/ 	// run startup
-/******/ 	return startup();
-/******/ })
-/************************************************************************/
-/******/ ({
 
-/***/ 129:
+/***/ 569:
-/***/ (function(module) {
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+
+module.exports = __nccwpck_require__(325);
 
-module.exports = require("child_process");
 
 /***/ }),
 
-/***/ 243:
+/***/ 325:
-/***/ (function(module, __unusedexports, __webpack_require__) {
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
 "use strict";
 
 
-var exec = __webpack_require__(129).exec;
+var exec = __nccwpck_require__(129).exec;
-var execSync = __webpack_require__(129).execSync;
+var execSync = __nccwpck_require__(129).execSync;
-var fs = __webpack_require__(747);
+var fs = __nccwpck_require__(747);
-var path = __webpack_require__(622);
+var path = __nccwpck_require__(622);
 var access = fs.access;
 var accessSync = fs.accessSync;
 var constants = fs.constants || fs;
@@ -119,7 +78,8 @@ var commandExistsUnix = function(commandName, cleanedCommandName, callback) {
 }
 
 var commandExistsWindows = function(commandName, cleanedCommandName, callback) {
-  if (/[\x00-\x1f<>:"\|\?\*]/.test(commandName)) {
+  // Regex from Julio from: https://stackoverflow.com/questions/51494579/regex-windows-path-validator
+  if (!(/^(?!(?:.*\s|.*\.|\W+)$)(?:[a-zA-Z]:)?(?:(?:[^<>:"\|\?\*\n])+(?:\/\/|\/|\\\\|\\)?)+$/m.test(commandName))) {
     callback(null, false);
     return;
   }
@@ -150,7 +110,8 @@ var commandExistsUnixSync = function(commandName, cleanedCommandName) {
 }
 
 var commandExistsWindowsSync = function(commandName, cleanedCommandName, callback) {
-  if (/[\x00-\x1f<>:"\|\?\*]/.test(commandName)) {
+  // Regex from Julio from: https://stackoverflow.com/questions/51494579/regex-windows-path-validator
+  if (!(/^(?!(?:.*\s|.*\.|\W+)$)(?:[a-zA-Z]:)?(?:(?:[^<>:"\|\?\*\n])+(?:\/\/|\/|\\\\|\\)?)+$/m.test(commandName))) {
     return false;
   }
   try {
@@ -214,14 +175,66 @@ module.exports.sync = function(commandName) {
 
 /***/ }),
 
-/***/ 250:
+/***/ 748:
-/***/ (function(module, __unusedexports, __webpack_require__) {
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+
+const { exec, execSync } = __nccwpck_require__(129); 
+
+const commandline={
+    run:runCommand,
+    runSync:runSync,
+    //will be deprecated soon as run is now the same.
+    get:runCommand,
+    
+};
+
+function runCommand(command,callback){
+    
+    return exec(
+        command,
+        (
+            function(){
+                return function(err,data,stderr){
+                    if(!callback)
+                        return;
+
+                    callback(err, data, stderr);
+                }
+            }
+        )(callback)
+    );
+}
+
+function runSync(command){
+    try {
+        return { 
+            data:   execSync(command).toString(), 
+            err:    null, 
+            stderr: null 
+        }
+    } 
+    catch (error) {
+        return { 
+            data:   null, 
+            err:    error.stderr.toString(), 
+            stderr: error.stderr.toString() 
+        }
+    }
+}
+
+module.exports=commandline;
+
+
+/***/ }),
+
+/***/ 898:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
 "use strict";
 
 
-var spawn = __webpack_require__(129).spawn
+var spawn = __nccwpck_require__(129).spawn
-var util = __webpack_require__(669)
+var util = __nccwpck_require__(669)
 
 var escapeSpaces = function(path) {
   if (typeof path === 'string') {
@@ -418,231 +431,316 @@ module.exports = function(options, callback) {
 
 /***/ }),
 
-/***/ 428:
+/***/ 505:
-/***/ (function(module, __unusedexports, __webpack_require__) {
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
-var exec = __webpack_require__(129).exec;
+const { existsSync, mkdirSync, writeFileSync } = __nccwpck_require__(747);
 
-var commandline={
+const {
-    get:getString,
+  GITHUB_WORKSPACE
-    run:runCommand
+} = process.env;
+
+const validateDir = (dir) => {
+  if (!existsSync(dir)) {
+    console.log(`[SSH] Creating ${dir} dir in `, GITHUB_WORKSPACE);
+    mkdirSync(dir);
+    console.log('✅ [SSH] dir created.');
+  } else {
+    console.log(`[SSH] ${dir} dir exist`);
+  }
 };
 
-function runCommand(command){
+const validateFile = (filePath) => {
-    //return refrence to the child process
+  if (!existsSync(filePath)) {
-    return exec(
+    console.log(`[SSH] Creating ${filePath} file in `, GITHUB_WORKSPACE);
-        command
+    try {
-    );
+      writeFileSync(filePath, '', {
-}
+        encoding: 'utf8',
-
+        mode: 0o600
-function getString(command,callback){
+      });
-    //return refrence to the child process
+      console.log('✅ [SSH] file created.');
-    return exec(
+    } catch (e) {
-        command,
+      console.error('⚠️ [SSH] writeFileSync error', filePath, e.message);
-        (
+      process.abort();
-            function(){
-                return function(err,data,stderr){
-                    if(!callback)
-                        return;
-
-                    callback(err, data, stderr);
-                }
-            }
-        )(callback)
-    );
-}
-
-module.exports=commandline;
-
-
-/***/ }),
-
-/***/ 622:
-/***/ (function(module) {
-
-module.exports = require("path");
-
-/***/ }),
-
-/***/ 669:
-/***/ (function(module) {
-
-module.exports = require("util");
-
-/***/ }),
-
-/***/ 676:
-/***/ (function(__unusedmodule, __unusedexports, __webpack_require__) {
-
-const fs = __webpack_require__(747);
-const path = __webpack_require__(622);
-const commandExists = __webpack_require__(677);
-const nodeCmd = __webpack_require__(428);
-const nodeRsync = __webpack_require__(250);
-
-const { REMOTE_HOST, REMOTE_USER, REMOTE_PORT, SSH_PRIVATE_KEY, DEPLOY_KEY_NAME, SOURCE, TARGET, ARGS, GITHUB_WORKSPACE, HOME } = process.env;
-console.log('GITHUB_WORKSPACE', GITHUB_WORKSPACE);
-
-const sshDeploy = (() => {
-    const rsync = ({ privateKey, port, src, dest, args }) => {
-        console.log(`Starting Rsync Action: ${src} to ${dest}`);
-
-        try {
-            // RSYNC COMMAND
-            nodeRsync({ src, dest, args, privateKey, ssh: true, port, sshCmdArgs: ['-o StrictHostKeyChecking=no'], recursive: true }, (error, stdout, stderr, cmd) => {
-                if (error) {
-                    console.error('⚠️ Rsync error', error.message);
-                    process.abort();
-                } else {
-                    console.log("✅ Rsync finished.", stdout);
-                }
-            });
-        } catch (err) {
-            console.error(`⚠️ An error happened:(.`, err.message, err.stack);
-            process.abort();
-        }
-    };
-
-    const init = ({
-                      src,
-                      dest,
-                      args,
-                      host = 'localhost',
-                      username,
-                      privateKeyContent,
-                      port
-                  }) => {
-        validateRsync(() => {
-            const privateKey = addSshKey(privateKeyContent, DEPLOY_KEY_NAME ||'deploy_key');
-
-            const remoteDest = username + '@' + host + ':' + dest;
-
-            rsync({ privateKey, port, src, dest: remoteDest, args });
-        });
-    };
-
-    const validateDir = (dir) => {
-        if (!fs.existsSync(dir)){
-            console.log(`Creating ${dir} dir in `, GITHUB_WORKSPACE);
-            fs.mkdirSync(dir);
-        } else {
-            console.log(`${dir} dir exist`);
-        }
-    };
-
-    const validateFile = (filePath) => {
-        if (!fs.existsSync(filePath)){
-            console.log(`Creating ${filePath} file in `, GITHUB_WORKSPACE);
-            try {
-                fs.writeFileSync(filePath, '', {
-                    encoding: 'utf8',
-                    mode: 0o600
-                });
-            } catch (e) {
-                console.error('⚠️ writeFileSync error', filePath, e.message);
-                process.abort();
-            }
-        } else {
-            console.log(`${filePath} file exist`);
-        }
-    };
-
-    const addSshKey = (key, name) => {
-        const sshDir = path.join(HOME || __dirname, '.ssh');
-        const filePath = path.join(sshDir, name);
-
-        validateDir(sshDir);
-        validateFile(sshDir + '/known_hosts');
-
-        try {
-            fs.writeFileSync(filePath, key, {
-                encoding: 'utf8',
-                mode: 0o600
-            });
-        } catch (e) {
-            console.error('⚠️ writeFileSync error', filePath, e.message);
-            process.abort();
-        }
-
-        console.log('✅ Ssh key added to `.ssh` dir ', filePath);
-
-        return filePath;
-    };
-
-    const validateRsync = (callback = () => {}) => {
-        const rsyncCli = commandExists.sync('rsync');
-
-        if (!rsyncCli) {
-            nodeCmd.get(
-                'sudo apt-get --no-install-recommends install rsync',
-                function(err, data, stderr){
-                    if (err) {
-                        console.log('⚠️ Rsync installation failed ', err.message);
-                        process.abort();
-                    } else {
-                        console.log('✅ Rsync installed. \n', data, stderr);
-                        callback();
-                    }
-                }
-            );
-        } else {
-            callback();
-        }
-    };
-
-    return {
-        init
     }
-})();
+  } else {
+    console.log(`[SSH] ${filePath} file exist`);
+  }
+};
+
+module.exports = {
+  validateDir,
+  validateFile
+};
+
+
+/***/ }),
+
+/***/ 229:
+/***/ ((module) => {
+
+const inputNames = ['REMOTE_HOST', 'REMOTE_USER', 'REMOTE_PORT', 'SSH_PRIVATE_KEY', 'DEPLOY_KEY_NAME', 'SOURCE', 'TARGET', 'ARGS', 'EXCLUDE'];
+
+const inputs = {
+  GITHUB_WORKSPACE: process.env.GITHUB_WORKSPACE
+};
+// Get inputs from ENV or WITH workflow settings
+inputNames.forEach((input) => {
+  inputs[input] = process.env[input] || process.env[`INPUT_${input}`];
+});
+
+module.exports = inputs;
+
+
+/***/ }),
+
+/***/ 447:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+
+const { sync: commandExists } = __nccwpck_require__(569);
+const { get: nodeCmd } = __nccwpck_require__(748);
+
+const validateRsync = (callback = () => {}) => {
+  const rsyncCli = commandExists('rsync');
+
+  if (!rsyncCli) {
+    nodeCmd(
+      'sudo apt-get --no-install-recommends install rsync',
+      (err, data, stderr) => {
+        if (err) {
+          console.log('⚠️ [CLI] Rsync installation failed. Aborting ... ', err.message);
+          process.abort();
+        } else {
+          console.log('✅ [CLI] Rsync installed. \n', data, stderr);
+          callback();
+        }
+      }
+    );
+  } else {
+    callback();
+  }
+};
 
 const validateInputs = (inputs) => {
-    const validInputs = inputs.filter(input => {
+  const inputKeys = Object.keys(inputs);
-        if (!input) {
+  const validInputs = inputKeys.filter((inputKey) => {
-            console.error(`⚠️ ${input} is mandatory`);
+    const inputValue = inputs[inputKey];
-        }
 
-        return input;
+    if (!inputValue) {
-    });
+      console.error(`⚠️ [INPUTS] ${inputKey} is mandatory`);
-
-    if (validInputs.length !== inputs.length) {
-        process.abort();
     }
+
+    return inputValue;
+  });
+
+  if (validInputs.length !== inputKeys.length) {
+    console.error('⚠️ [INPUTS] Inputs not valid, aborting ...');
+    process.abort();
+  }
 };
 
-const run = () => {
+module.exports = {
-    validateInputs([SSH_PRIVATE_KEY, REMOTE_HOST, REMOTE_USER]);
+  validateRsync,
-
+  validateInputs
-    sshDeploy.init({
-        src: GITHUB_WORKSPACE + '/' + SOURCE || '',
-        dest: TARGET || '/home/' + REMOTE_USER + '/',
-        args: [ARGS] || false,
-        host: REMOTE_HOST,
-        port: REMOTE_PORT || '22',
-        username: REMOTE_USER,
-        privateKeyContent: SSH_PRIVATE_KEY,
-    });
 };
 
-run();
-
-
-
 
 /***/ }),
 
-/***/ 677:
+/***/ 822:
-/***/ (function(module, __unusedexports, __webpack_require__) {
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
 
-module.exports = __webpack_require__(243);
+const { writeFileSync } = __nccwpck_require__(747);
+const { join } = __nccwpck_require__(622);
 
+const {
+  validateDir,
+  validateFile
+} = __nccwpck_require__(505);
+
+const {
+  HOME
+} = process.env;
+
+const addSshKey = (key, name) => {
+  const sshDir = join(HOME || __dirname, '.ssh');
+  const filePath = join(sshDir, name);
+
+  validateDir(sshDir);
+  validateFile(`${sshDir}/known_hosts`);
+
+  try {
+    writeFileSync(filePath, key, {
+      encoding: 'utf8',
+      mode: 0o600
+    });
+  } catch (e) {
+    console.error('⚠️ writeFileSync error', filePath, e.message);
+    process.abort();
+  }
+
+  console.log('✅ Ssh key added to `.ssh` dir ', filePath);
+
+  return filePath;
+};
+
+module.exports = {
+  addSshKey
+}
+
+
+/***/ }),
+
+/***/ 129:
+/***/ ((module) => {
+
+"use strict";
+module.exports = require("child_process");;
 
 /***/ }),
 
 /***/ 747:
-/***/ (function(module) {
+/***/ ((module) => {
 
-module.exports = require("fs");
+"use strict";
+module.exports = require("fs");;
+
+/***/ }),
+
+/***/ 622:
+/***/ ((module) => {
+
+"use strict";
+module.exports = require("path");;
+
+/***/ }),
+
+/***/ 669:
+/***/ ((module) => {
+
+"use strict";
+module.exports = require("util");;
 
 /***/ })
 
-/******/ });
+/******/ 	});
+/************************************************************************/
+/******/ 	// The module cache
+/******/ 	var __webpack_module_cache__ = {};
+/******/ 	
+/******/ 	// The require function
+/******/ 	function __nccwpck_require__(moduleId) {
+/******/ 		// Check if module is in cache
+/******/ 		var cachedModule = __webpack_module_cache__[moduleId];
+/******/ 		if (cachedModule !== undefined) {
+/******/ 			return cachedModule.exports;
+/******/ 		}
+/******/ 		// Create a new module (and put it into the cache)
+/******/ 		var module = __webpack_module_cache__[moduleId] = {
+/******/ 			// no module.id needed
+/******/ 			// no module.loaded needed
+/******/ 			exports: {}
+/******/ 		};
+/******/ 	
+/******/ 		// Execute the module function
+/******/ 		var threw = true;
+/******/ 		try {
+/******/ 			__webpack_modules__[moduleId](module, module.exports, __nccwpck_require__);
+/******/ 			threw = false;
+/******/ 		} finally {
+/******/ 			if(threw) delete __webpack_module_cache__[moduleId];
+/******/ 		}
+/******/ 	
+/******/ 		// Return the exports of the module
+/******/ 		return module.exports;
+/******/ 	}
+/******/ 	
+/************************************************************************/
+/******/ 	/* webpack/runtime/compat */
+/******/ 	
+/******/ 	if (typeof __nccwpck_require__ !== 'undefined') __nccwpck_require__.ab = __dirname + "/";/************************************************************************/
+var __webpack_exports__ = {};
+// This entry need to be wrapped in an IIFE because it need to be isolated against other modules in the chunk.
+(() => {
+const nodeRsync = __nccwpck_require__(898);
+
+const { validateRsync, validateInputs } = __nccwpck_require__(447);
+const { addSshKey } = __nccwpck_require__(822);
+
+const {
+  REMOTE_HOST, REMOTE_USER,
+  REMOTE_PORT, SSH_PRIVATE_KEY, DEPLOY_KEY_NAME,
+  SOURCE, TARGET, ARGS, EXCLUDE,
+  GITHUB_WORKSPACE
+} = __nccwpck_require__(229);
+
+const defaultOptions = {
+  ssh: true,
+  sshCmdArgs: ['-o StrictHostKeyChecking=no'],
+  recursive: true
+};
+
+console.log('[general] GITHUB_WORKSPACE: ', GITHUB_WORKSPACE);
+
+const sshDeploy = (() => {
+  const rsync = ({ privateKey, port, src, dest, args, exclude }) => {
+    console.log(`[Rsync] Starting Rsync Action: ${src} to ${dest}`);
+    if (exclude) console.log(`[Rsync] exluding folders ${exclude}`);
+
+    try {
+      // RSYNC COMMAND
+      nodeRsync({
+        src, dest, args, privateKey, port, excludeFirst: exclude, ...defaultOptions
+      }, (error, stdout, stderr, cmd) => {
+        if (error) {
+          console.error('⚠️ [Rsync] error: ', error.message);
+          console.log('⚠️ [Rsync] stderr: ', stderr);
+          console.log('⚠️ [Rsync] stdout: ', stdout);
+          console.log('⚠️ [Rsync] cmd: ', cmd);
+          process.abort();
+        } else {
+          console.log('✅ [Rsync] finished.', stdout);
+        }
+      });
+    } catch (err) {
+      console.error('⚠️ [Rsync] command error: ', err.message, err.stack);
+      process.abort();
+    }
+  };
+
+  const init = ({ src, dest, args, host = 'localhost', port, username, privateKeyContent, exclude = [] }) => {
+    validateRsync(() => {
+      const privateKey = addSshKey(privateKeyContent, DEPLOY_KEY_NAME || 'deploy_key');
+      const remoteDest = `${username}@${host}:${dest}`;
+
+      rsync({ privateKey, port, src, dest: remoteDest, args, exclude });
+    });
+  };
+
+  return {
+    init
+  };
+})();
+
+const run = () => {
+  validateInputs({ SSH_PRIVATE_KEY, REMOTE_HOST, REMOTE_USER });
+
+  sshDeploy.init({
+    src: `${GITHUB_WORKSPACE}/${SOURCE || ''}`,
+    dest: TARGET || `/home/${REMOTE_USER}/`,
+    args: ARGS ? [ARGS] : ['-rltgoDzvO'],
+    host: REMOTE_HOST,
+    port: REMOTE_PORT || '22',
+    username: REMOTE_USER,
+    privateKeyContent: SSH_PRIVATE_KEY,
+    exclude: (EXCLUDE || '').split(',').map((item) => item.trim()) // split by comma and trim whitespace
+  });
+};
+
+run();
+
+})();
+
+module.exports = __webpack_exports__;
+/******/ })()
+;

docs/CHANGELOG.md

@@ -0,0 +1,50 @@
+## [2.2.5](https://github.com/easingthemes/ssh-deploy/compare/v2.2.4...v2.2.5) (2021-05-27)
+
+
+### Bug Fixes
+
+* semantic-release/npm update config ([40096bf](https://github.com/easingthemes/ssh-deploy/commit/40096bf22459d1dd82172d2bd20c0c149e70b1e1))
+
+## [2.2.4](https://github.com/easingthemes/ssh-deploy/compare/v2.2.3...v2.2.4) (2021-05-27)
+
+
+### Bug Fixes
+
+* add branch instead of a version in a readme ([8218c8e](https://github.com/easingthemes/ssh-deploy/commit/8218c8ed9514d772933e1ab4d1c725a7c05e149f))
+
+## [2.2.3](https://github.com/easingthemes/ssh-deploy/compare/v2.2.2...v2.2.3) (2021-05-27)
+
+
+### Bug Fixes
+
+* codeql yaml syntax update ([87ad671](https://github.com/easingthemes/ssh-deploy/commit/87ad6713b53d454bd7ad6c4576cea7b2e3e2f4f3))
+
+## [2.2.2](https://github.com/easingthemes/ssh-deploy/compare/v2.2.1...v2.2.2) (2021-05-27)
+
+
+### Bug Fixes
+
+* codeql build ([5e456a4](https://github.com/easingthemes/ssh-deploy/commit/5e456a475a15096d08ccd2aff2734b3f1250b308))
+
+## [2.2.1](https://github.com/easingthemes/ssh-deploy/compare/v2.2.0...v2.2.1) (2021-05-27)
+
+
+### Bug Fixes
+
+* add package json auto updates ([ce56d75](https://github.com/easingthemes/ssh-deploy/commit/ce56d75fc1b62a99d72ffba70dcb24fcc3b6b3df))
+
+# [2.2.0](https://github.com/easingthemes/ssh-deploy/compare/v2.1.7...v2.2.0) (2021-05-27)
+
+
+### Bug Fixes
+
+* only=prod package json ([95f4dc8](https://github.com/easingthemes/ssh-deploy/commit/95f4dc8069045c1f5f726e00cb519b46e4f14267))
+* replace i with ci ([50d1f57](https://github.com/easingthemes/ssh-deploy/commit/50d1f576f95c0d7e8ce99fb1b2ab68b2594973e5))
+* update ncc ([20a0cae](https://github.com/easingthemes/ssh-deploy/commit/20a0cae1ae81bcc430507363e800342976307a81))
+* update plugins ([b2adc00](https://github.com/easingthemes/ssh-deploy/commit/b2adc00c92f129aef41ae46441411c2bebc0dbe4))
+* update plugins ([a50a999](https://github.com/easingthemes/ssh-deploy/commit/a50a999528b503846cc7fdf26210f710bd95565a))
+
+
+### Features
+
+* add semantic-release-action ([ac3c9b5](https://github.com/easingthemes/ssh-deploy/commit/ac3c9b51d5cb52f4add40e2fc2dcc5e970153afc))

package.json

@@ -1,18 +1,23 @@
 {
   "name": "ssh-deploy",
-  "version": "2.1.0",
+  "version": "2.1.9",
-  "description": "This GitHub Action deploys specific directory from `GITHUB_WORKSPACE` to a folder on a server via rsync over ssh.",
+  "description": "Fast NodeJS action to deploy specific directory from `GITHUB_WORKSPACE` to a server via rsync over ssh.",
   "main": "src/index.js",
   "dependencies": {
-    "command-exists": "1.2.8",
+    "command-exists": "1.2.9",
-    "node-cmd": "3.0.0",
+    "node-cmd": "4.0.0",
     "rsyncwrapper": "3.0.1"
   },
   "devDependencies": {
-    "@zeit/ncc": "^0.20.5"
+    "@vercel/ncc": "^0.28.6",
+    "eslint": "^7.27.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.23.3"
   },
   "scripts": {
-    "build": "ncc build ./src/index.js -o dist"
+    "build": "npm run lint && ncc build ./src/index.js -o dist",
+    "lint": "eslint ./src/index.js",
+    "lint:fix": "eslint ./src/index.js --fix"
   },
   "repository": {
     "type": "git",
@@ -24,7 +29,7 @@
     "rsync"
   ],
   "author": "Dragan Filipovic",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/easingthemes/ssh-deploy/issues"
   },

src/helpers.js

@@ -0,0 +1,38 @@
+const { existsSync, mkdirSync, writeFileSync } = require('fs');
+
+const {
+  GITHUB_WORKSPACE
+} = process.env;
+
+const validateDir = (dir) => {
+  if (!existsSync(dir)) {
+    console.log(`[SSH] Creating ${dir} dir in `, GITHUB_WORKSPACE);
+    mkdirSync(dir);
+    console.log('✅ [SSH] dir created.');
+  } else {
+    console.log(`[SSH] ${dir} dir exist`);
+  }
+};
+
+const validateFile = (filePath) => {
+  if (!existsSync(filePath)) {
+    console.log(`[SSH] Creating ${filePath} file in `, GITHUB_WORKSPACE);
+    try {
+      writeFileSync(filePath, '', {
+        encoding: 'utf8',
+        mode: 0o600
+      });
+      console.log('✅ [SSH] file created.');
+    } catch (e) {
+      console.error('⚠️ [SSH] writeFileSync error', filePath, e.message);
+      process.abort();
+    }
+  } else {
+    console.log(`[SSH] ${filePath} file exist`);
+  }
+};
+
+module.exports = {
+  validateDir,
+  validateFile
+};

src/index.js

@@ -1,153 +1,77 @@
 #!/usr/bin/env node
-const fs = require('fs');
-const path = require('path');
-const commandExists = require('command-exists');
-const nodeCmd = require('node-cmd');
 const nodeRsync = require('rsyncwrapper');
 
-const { REMOTE_HOST, REMOTE_USER, REMOTE_PORT, SSH_PRIVATE_KEY, DEPLOY_KEY_NAME, SOURCE, TARGET, ARGS, GITHUB_WORKSPACE, HOME } = process.env;
+const { validateRsync, validateInputs } = require('./rsyncCli');
-console.log('GITHUB_WORKSPACE', GITHUB_WORKSPACE);
+const { addSshKey } = require('./sshKey');
 
-const sshDeploy = (() => {
+const {
-    const rsync = ({ privateKey, port, src, dest, args }) => {
+  REMOTE_HOST, REMOTE_USER,
-        console.log(`Starting Rsync Action: ${src} to ${dest}`);
+  REMOTE_PORT, SSH_PRIVATE_KEY, DEPLOY_KEY_NAME,
+  SOURCE, TARGET, ARGS, EXCLUDE,
+  GITHUB_WORKSPACE
+} = require('./inputs');
 
-        try {
+const defaultOptions = {
-            // RSYNC COMMAND
+  ssh: true,
-            nodeRsync({ src, dest, args, privateKey, ssh: true, port, sshCmdArgs: ['-o StrictHostKeyChecking=no'], recursive: true }, (error, stdout, stderr, cmd) => {
+  sshCmdArgs: ['-o StrictHostKeyChecking=no'],
-                if (error) {
+  recursive: true
-                    console.error('⚠️ Rsync error', error.message);
-                    process.abort();
-                } else {
-                    console.log("✅ Rsync finished.", stdout);
-                }
-            });
-        } catch (err) {
-            console.error(`⚠️ An error happened:(.`, err.message, err.stack);
-            process.abort();
-        }
-    };
-
-    const init = ({
-                      src,
-                      dest,
-                      args,
-                      host = 'localhost',
-                      username,
-                      privateKeyContent,
-                      port
-                  }) => {
-        validateRsync(() => {
-            const privateKey = addSshKey(privateKeyContent, DEPLOY_KEY_NAME ||'deploy_key');
-
-            const remoteDest = username + '@' + host + ':' + dest;
-
-            rsync({ privateKey, port, src, dest: remoteDest, args });
-        });
-    };
-
-    const validateDir = (dir) => {
-        if (!fs.existsSync(dir)){
-            console.log(`Creating ${dir} dir in `, GITHUB_WORKSPACE);
-            fs.mkdirSync(dir);
-        } else {
-            console.log(`${dir} dir exist`);
-        }
-    };
-
-    const validateFile = (filePath) => {
-        if (!fs.existsSync(filePath)){
-            console.log(`Creating ${filePath} file in `, GITHUB_WORKSPACE);
-            try {
-                fs.writeFileSync(filePath, '', {
-                    encoding: 'utf8',
-                    mode: 0o600
-                });
-            } catch (e) {
-                console.error('⚠️ writeFileSync error', filePath, e.message);
-                process.abort();
-            }
-        } else {
-            console.log(`${filePath} file exist`);
-        }
-    };
-
-    const addSshKey = (key, name) => {
-        const sshDir = path.join(HOME || __dirname, '.ssh');
-        const filePath = path.join(sshDir, name);
-
-        validateDir(sshDir);
-        validateFile(sshDir + '/known_hosts');
-
-        try {
-            fs.writeFileSync(filePath, key, {
-                encoding: 'utf8',
-                mode: 0o600
-            });
-        } catch (e) {
-            console.error('⚠️ writeFileSync error', filePath, e.message);
-            process.abort();
-        }
-
-        console.log('✅ Ssh key added to `.ssh` dir ', filePath);
-
-        return filePath;
-    };
-
-    const validateRsync = (callback = () => {}) => {
-        const rsyncCli = commandExists.sync('rsync');
-
-        if (!rsyncCli) {
-            nodeCmd.get(
-                'sudo apt-get --no-install-recommends install rsync',
-                function(err, data, stderr){
-                    if (err) {
-                        console.log('⚠️ Rsync installation failed ', err.message);
-                        process.abort();
-                    } else {
-                        console.log('✅ Rsync installed. \n', data, stderr);
-                        callback();
-                    }
-                }
-            );
-        } else {
-            callback();
-        }
-    };
-
-    return {
-        init
-    }
-})();
-
-const validateInputs = (inputs) => {
-    const validInputs = inputs.filter(input => {
-        if (!input) {
-            console.error(`⚠️ ${input} is mandatory`);
-        }
-
-        return input;
-    });
-
-    if (validInputs.length !== inputs.length) {
-        process.abort();
-    }
 };
 
-const run = () => {
+console.log('[general] GITHUB_WORKSPACE: ', GITHUB_WORKSPACE);
-    validateInputs([SSH_PRIVATE_KEY, REMOTE_HOST, REMOTE_USER]);
 
-    sshDeploy.init({
+const sshDeploy = (() => {
-        src: GITHUB_WORKSPACE + '/' + SOURCE || '',
+  const rsync = ({ privateKey, port, src, dest, args, exclude }) => {
-        dest: TARGET || '/home/' + REMOTE_USER + '/',
+    console.log(`[Rsync] Starting Rsync Action: ${src} to ${dest}`);
-        args: [ARGS] || ['-rltgoDzvO'],
+    if (exclude) console.log(`[Rsync] exluding folders ${exclude}`);
-        host: REMOTE_HOST,
+
-        port: REMOTE_PORT || '22',
+    try {
-        username: REMOTE_USER,
+      // RSYNC COMMAND
-        privateKeyContent: SSH_PRIVATE_KEY,
+      nodeRsync({
+        src, dest, args, privateKey, port, excludeFirst: exclude, ...defaultOptions
+      }, (error, stdout, stderr, cmd) => {
+        if (error) {
+          console.error('⚠️ [Rsync] error: ', error.message);
+          console.log('⚠️ [Rsync] stderr: ', stderr);
+          console.log('⚠️ [Rsync] stdout: ', stdout);
+          console.log('⚠️ [Rsync] cmd: ', cmd);
+          process.abort();
+        } else {
+          console.log('✅ [Rsync] finished.', stdout);
+        }
+      });
+    } catch (err) {
+      console.error('⚠️ [Rsync] command error: ', err.message, err.stack);
+      process.abort();
+    }
+  };
+
+  const init = ({ src, dest, args, host = 'localhost', port, username, privateKeyContent, exclude = [] }) => {
+    validateRsync(() => {
+      const privateKey = addSshKey(privateKeyContent, DEPLOY_KEY_NAME || 'deploy_key');
+      const remoteDest = `${username}@${host}:${dest}`;
+
+      rsync({ privateKey, port, src, dest: remoteDest, args, exclude });
     });
+  };
+
+  return {
+    init
+  };
+})();
+
+const run = () => {
+  validateInputs({ SSH_PRIVATE_KEY, REMOTE_HOST, REMOTE_USER });
+
+  sshDeploy.init({
+    src: `${GITHUB_WORKSPACE}/${SOURCE || ''}`,
+    dest: TARGET || `/home/${REMOTE_USER}/`,
+    args: ARGS ? [ARGS] : ['-rltgoDzvO'],
+    host: REMOTE_HOST,
+    port: REMOTE_PORT || '22',
+    username: REMOTE_USER,
+    privateKeyContent: SSH_PRIVATE_KEY,
+    exclude: (EXCLUDE || '').split(',').map((item) => item.trim()) // split by comma and trim whitespace
+  });
 };
 
 run();
-
-

src/inputs.js

@@ -0,0 +1,11 @@
+const inputNames = ['REMOTE_HOST', 'REMOTE_USER', 'REMOTE_PORT', 'SSH_PRIVATE_KEY', 'DEPLOY_KEY_NAME', 'SOURCE', 'TARGET', 'ARGS', 'EXCLUDE'];
+
+const inputs = {
+  GITHUB_WORKSPACE: process.env.GITHUB_WORKSPACE
+};
+// Get inputs from ENV or WITH workflow settings
+inputNames.forEach((input) => {
+  inputs[input] = process.env[input] || process.env[`INPUT_${input}`];
+});
+
+module.exports = inputs;

src/rsyncCli.js

@@ -0,0 +1,46 @@
+const { sync: commandExists } = require('command-exists');
+const { get: nodeCmd } = require('node-cmd');
+
+const validateRsync = (callback = () => {}) => {
+  const rsyncCli = commandExists('rsync');
+
+  if (!rsyncCli) {
+    nodeCmd(
+      'sudo apt-get --no-install-recommends install rsync',
+      (err, data, stderr) => {
+        if (err) {
+          console.log('⚠️ [CLI] Rsync installation failed. Aborting ... ', err.message);
+          process.abort();
+        } else {
+          console.log('✅ [CLI] Rsync installed. \n', data, stderr);
+          callback();
+        }
+      }
+    );
+  } else {
+    callback();
+  }
+};
+
+const validateInputs = (inputs) => {
+  const inputKeys = Object.keys(inputs);
+  const validInputs = inputKeys.filter((inputKey) => {
+    const inputValue = inputs[inputKey];
+
+    if (!inputValue) {
+      console.error(`⚠️ [INPUTS] ${inputKey} is mandatory`);
+    }
+
+    return inputValue;
+  });
+
+  if (validInputs.length !== inputKeys.length) {
+    console.error('⚠️ [INPUTS] Inputs not valid, aborting ...');
+    process.abort();
+  }
+};
+
+module.exports = {
+  validateRsync,
+  validateInputs
+};

src/sshKey.js

@@ -0,0 +1,37 @@
+const { writeFileSync } = require('fs');
+const { join } = require('path');
+
+const {
+  validateDir,
+  validateFile
+} = require('./helpers');
+
+const {
+  HOME
+} = process.env;
+
+const addSshKey = (key, name) => {
+  const sshDir = join(HOME || __dirname, '.ssh');
+  const filePath = join(sshDir, name);
+
+  validateDir(sshDir);
+  validateFile(`${sshDir}/known_hosts`);
+
+  try {
+    writeFileSync(filePath, key, {
+      encoding: 'utf8',
+      mode: 0o600
+    });
+  } catch (e) {
+    console.error('⚠️ writeFileSync error', filePath, e.message);
+    process.abort();
+  }
+
+  console.log('✅ Ssh key added to `.ssh` dir ', filePath);
+
+  return filePath;
+};
+
+module.exports = {
+  addSshKey
+}