chore(release): 3.3.3 [skip ci]

## [3.3.3](https://github.com/easingthemes/ssh-deploy/compare/v3.3.2...v3.3.3) (2023-01-02)

### Bug Fixes

* log buffer from rsync stdout ([8e19e0d](8e19e0d6bc))

.eslintrc.js

@@ -12,14 +12,14 @@ module.exports = {
     SharedArrayBuffer: 'readonly'
   },
   parserOptions: {
-    ecmaVersion: 2018,
+    ecmaVersion: 2018
   },
   rules: {
-    "comma-dangle": [
+    'comma-dangle': [
-      "error",
+      'error',
-      "never"
+      'never'
     ],
-    "no-console": "off",
+    'no-console': 'off',
-    "object-curly-newline": "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: [16.x]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        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@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+
+    - run: |
+        npm ci
+        npm run build --if-present
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/e2e.yml

@@ -0,0 +1,93 @@
+name: e2e Test
+
+on:
+  push:
+    branches: [ 'main' ]
+  workflow_dispatch:
+    inputs:
+      ARGS:
+        description: 'ARGS'
+        required: true
+        default: '-rltgoDzvO --delete --chmod=ugo=rwX --progress'
+      EXCLUDE:
+        description: 'EXCLUDE'
+        required: true
+        default: '/dist/, /node_modules/'
+      SSH_CMD_ARGS:
+        description: 'SSH_CMD_ARGS'
+        required: true
+        default: '-o StrictHostKeyChecking=no, -o UserKnownHostsFile=/dev/null'
+
+
+env:
+  TEST_HOST_DOCKER: ./test
+  TEST_USER: test
+
+jobs:
+  e2e:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Clean up old test files
+        run: |
+          docker stop ssh-host-container || true && docker rm ssh-host-container || true
+
+      - name: Create ssh keys
+        run: |
+          echo $HOME
+          ls -la $HOME
+          ssh-keygen -m PEM -t rsa -b 4096 -f "$HOME/.ssh/id_rsa" -N ""
+          eval `ssh-agent -s`
+          ssh-add "$HOME/.ssh/id_rsa"
+          ssh-add -l
+          echo "SSH_PRIVATE_KEY<<EOF" >> $GITHUB_ENV
+          cat $HOME/.ssh/id_rsa >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: Build Host Server Image
+        working-directory: ${{ env.TEST_HOST_DOCKER }}
+        run: |
+          docker build \
+            -t ssh-host-image . \
+            --build-arg SSH_PUB_KEY="$(cat $HOME/.ssh/id_rsa.pub)" \
+            --build-arg ssh_user="${{ env.TEST_USER }}"
+          docker run -d -p 8822:22 --name=ssh-host-container ssh-host-image
+          docker exec ssh-host-container sh -c "hostname --ip-address" > ip.txt
+          echo "REMOTE_HOST<<EOF" >> $GITHUB_ENV
+          cat ip.txt >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+        shell: bash
+
+      - name: Create project file
+        run: |
+          mkdir test_project
+          cd test_project
+          touch index.html
+          touch image.svg
+          touch text.txt
+          truncate -s 500MB big_file.txt
+          date +"%Y-%m-%d %H:%M:%S,%3N" >> index.html
+          cat index.html
+
+      - name: e2e Test published ssh-deploy action
+        uses: easingthemes/ssh-deploy@main
+        env:
+          # ENV Vars created in previous steps:
+          # SSH_PRIVATE_KEY: $EXAMPLE_SSH_PRIVATE_KEY
+          # REMOTE_HOST: $EXAMPLE_REMOTE_HOST
+          REMOTE_USER: ${{ env.TEST_USER }}
+          ARGS: ${{ github.event.inputs.ARGS || '-rltgoDzvO --delete --chmod=ugo=rwX --progress' }}
+          SSH_CMD_ARGS: ${{ github.event.inputs.SSH_CMD_ARGS || '-o StrictHostKeyChecking=no, -o UserKnownHostsFile=/dev/null' }}
+          SOURCE: "test_project/"
+          TARGET: "/var/www/html/"
+          EXCLUDE: ${{ github.event.inputs.EXCLUDE || '/dist/, /node_modules/' }}
+          SCRIPT_BEFORE: |
+            whoami
+            ls -al
+          SCRIPT_AFTER: |
+            whoami
+            ls -al
+            echo $RSYNC_STDOUT

.github/workflows/manual-release.yml

@@ -0,0 +1,44 @@
+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: [ 16.x ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        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@v3
+        with:
+          dry_run: ${{ github.event.inputs.dryrun == 'true' }}
+          extra_plugins: |
+            @semantic-release/changelog
+            @semantic-release/git
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_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,44 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Test, Build and Release
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        node-version: [ 16.x ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        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@v3
+        with:
+          dry_run: false
+          extra_plugins: |
+            @semantic-release/changelog
+            @semantic-release/git
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_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/stale.yml

@@ -0,0 +1,26 @@
+# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/actions/stale
+name: Close stale issues
+
+on:
+  schedule:
+  - cron: '30 1 * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+
+    steps:
+    - uses: actions/stale@v7
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
+        days-before-stale: 30
+        days-before-close: 5
+        stale-issue-label: 'stale'

.gitignore

@@ -19,3 +19,4 @@ node_modules/
 
 # IDE
 .idea
+.vscode

.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", "package.json"]
+      }
+    ]
+  ]
+}

README.md

@@ -1,6 +1,8 @@
 # ssh deployments
 
-Deploy code with rsync over ssh, using NodeJS.
+Deploy code with rsync over ssh.
+
+Execute remote scripts before or after rsync
 
 NodeJS version is more than a minute `faster` than simple Docker version.
 
@@ -8,6 +10,8 @@ This GitHub Action deploys specific directory from `GITHUB_WORKSPACE` to a folde
 
 This action would usually follow a build/test action which leaves deployable code in `GITHUB_WORKSPACE`, eg `dist`;
 
+In addition to rsync, this action provides scripts execution on remote host before and/or after rsync.
+
 # Configuration
 
 Pass configuration with `env` vars
@@ -49,18 +53,48 @@ The source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`
 
 The target directory
 
+##### 8. `EXCLUDE` (optional, default '')
+
+path to exclude separated by `,`, ie: `/dist/, /node_modules/`
+
+##### 9. `SCRIPT_BEFORE` (optional, default '')
+
+Script to run on host machine before rsync. Single line or multiline commands.
+Execution is preformed by storing commands in `.sh` file and executing it via `.bash` over `ssh`
+
+##### 10. `SCRIPT_AFTER` (optional, default '')
+
+Script to run on host machine after rsync.
+Rsync output is stored in `$RSYNC_STDOUT` env variable.
+
+##### 11. `SSH_CMD_ARGS` (optional, default '-o StrictHostKeyChecking=no')
+
+A list of ssh arguments, they must be prefixed with -o and separated by a comma, for example: -o SomeArgument=no, -o SomeOtherArgument=5
+
+
 # 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 }}
+      SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
       ARGS: "-rltgoDzvO"
       SOURCE: "dist/"
       REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
       REMOTE_USER: ${{ secrets.REMOTE_USER }}
       TARGET: ${{ secrets.REMOTE_TARGET }}
+      EXCLUDE: "/dist/, /node_modules/"
+      SCRIPT_BEFORE: |
+        whoami
+        ls -al
+      SCRIPT_AFTER: |
+        whoami
+        ls -al
+        echo $RSYNC_STDOUT
 ```
 
 # Example usage in workflow
@@ -86,16 +120,35 @@ jobs:
     - name: Run build task
       run: npm run build --if-present
     - name: Deploy to Server
-      uses: easingthemes/ssh-deploy@v2.1.1
+      uses: easingthemes/ssh-deploy@main
       env:
-          SSH_PRIVATE_KEY: ${{ secrets.SERVER_SSH_KEY }}
+          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
           ARGS: "-rltgoDzvO --delete"
           SOURCE: "dist/"
           REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
           REMOTE_USER: ${{ secrets.REMOTE_USER }}
           TARGET: ${{ secrets.REMOTE_TARGET }}
+          EXCLUDE: "/dist/, /node_modules/"
 ```
 
+## Issues
+
+This is a GitHub Action wrapping `rsync` via `ssh`. Only issues with action functionality can be fixed here.
+
+Almost 95% of the issues are related to wrong SSH connection or `rsync` params and permissions.
+These issues are not related to the action itself.
+
+- Check manually your ssh connection from your client before opening a bug report.
+- Check `rsync` params for your use-case. Default params are not going to be enough wor everyone, it highly depends on your setup.
+- Check manually your rsync command from your client before opening a bug report.
+
+I've added e2e test for this action.
+Real example is executed on every PR merge to `main`.
+Check actions tab for example.
+
+More info for SSH keys: https://www.ssh.com/ssh/public-key-authentication
+
+
 ## Disclaimer
 
 Check your keys. Check your deployment paths. And use at your own risk.

action.yml

@@ -1,9 +1,9 @@
 name: "ssh deploy"
-description: "NodeJS action for FAST deployment with rsync/ssh"
+description: "NodeJS action for FAST deployment with rsync/ssh and remote script execution before/after rsync"
 author: "easingthemes"
 inputs:
-  SSH_PRIVATE_KEY: # Private Key
+  SSH_PRIVATE_KEY:
-    description: "Private Key"
+    description: "Private key part of an SSH key pair"
     required: true
   REMOTE_HOST:
     description: "Remote host"
@@ -16,7 +16,7 @@ inputs:
     required: false
     default: "22"
   SOURCE:
-    description: "Source directory"
+    description: "Source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`"
     required: false
     default: ""
   TARGET:
@@ -27,11 +27,27 @@ inputs:
     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: "node12"
+  using: "node16"
   main: "dist/index.js"
 branding:
   color: "green"

docs/CHANGELOG.md

@@ -0,0 +1,178 @@
+## [3.3.3](https://github.com/easingthemes/ssh-deploy/compare/v3.3.2...v3.3.3) (2023-01-02)
+
+
+### Bug Fixes
+
+* log buffer from rsync stdout ([8e19e0d](https://github.com/easingthemes/ssh-deploy/commit/8e19e0d6bc9b1c332925ce0268ad64b50728fae5))
+
+## [3.3.2](https://github.com/easingthemes/ssh-deploy/compare/v3.3.1...v3.3.2) (2023-01-02)
+
+
+### Bug Fixes
+
+* Add manual inputs for e2e test ([8f71595](https://github.com/easingthemes/ssh-deploy/commit/8f715957ab9283ab2934dd1e5be9d78f2eaf3fae))
+
+## [3.3.1](https://github.com/easingthemes/ssh-deploy/compare/v3.3.0...v3.3.1) (2023-01-02)
+
+
+### Bug Fixes
+
+* Log rsync command ([85f4a96](https://github.com/easingthemes/ssh-deploy/commit/85f4a967435d7d44edf2fea628c9f59db5e890ee))
+
+# [3.3.0](https://github.com/easingthemes/ssh-deploy/compare/v3.2.0...v3.3.0) (2023-01-02)
+
+
+### Features
+
+* Add SSH_CMD_ARGS support ([51a0063](https://github.com/easingthemes/ssh-deploy/commit/51a00631e2b91983fb610ca2157a673b9ae03c95))
+
+# [3.2.0](https://github.com/easingthemes/ssh-deploy/pull/94/files) (2023-01-02)
+
+
+### Features
+
+* Add SSH remote script support -  before and after rsync ([2cd8a82](https://github.com/easingthemes/ssh-deploy/pull/94/files))
+* feat: add sshCmdArgs option
+* feat: add onStderr and onStdout logs
+* feat: Add RSYNC_STDOUT env variable
+* feat: Update emojis
+
+### Bug Fixes
+
+* fix: remove _unsafe _dirname
+* fix: Add promise instead of callback
+* fix: improve logs
+* fix: Add simple command exists instead of a plugin
+* fix: add non interactive install
+* fix: Improve reject messages
+* fix: update workflow actions
+
+
+## [3.1.1](https://github.com/easingthemes/ssh-deploy/compare/v3.1.0...v3.1.1) (2023-01-02)
+
+
+### Bug Fixes
+
+* use main branch for e2e testes ([21451fe](https://github.com/easingthemes/ssh-deploy/commit/21451fec978a02b55672490a2c11c6c17995ff95))
+
+# [3.1.0](https://github.com/easingthemes/ssh-deploy/compare/v3.0.1...v3.1.0) (2022-12-31)
+
+
+### Features
+
+* add e2e tests ([40f855a](https://github.com/easingthemes/ssh-deploy/commit/40f855a08b4911c3f54b7a45306af355c6d87277))
+
+## [3.0.1](https://github.com/easingthemes/ssh-deploy/compare/v3.0.0...v3.0.1) (2022-10-28)
+
+
+### Bug Fixes
+
+* readme update ([80a7f53](https://github.com/easingthemes/ssh-deploy/commit/80a7f53ec918930fd23f0524fec0b1d4f52183bf)), closes [#67](https://github.com/easingthemes/ssh-deploy/issues/67)
+
+# [3.0.0](https://github.com/easingthemes/ssh-deploy/compare/v2.2.11...v3.0.0) (2022-10-28)
+
+
+### Bug Fixes
+
+* plugins versions ([2f40dde](https://github.com/easingthemes/ssh-deploy/commit/2f40dde84fde36f5b9b81ededd7090c5159d9885))
+
+
+* Merge pull request #83 from easingthemes/feature/#82-update-node-version ([76660a8](https://github.com/easingthemes/ssh-deploy/commit/76660a8456dbf26e6328674e25d083941ddd645e)), closes [#83](https://github.com/easingthemes/ssh-deploy/issues/83) [easingthemes/feature/#82](https://github.com/easingthemes/feature//issues/82)
+
+
+### BREAKING CHANGES
+
+* update to use nodeJS v16
+
+## [2.2.11](https://github.com/easingthemes/ssh-deploy/compare/v2.2.10...v2.2.11) (2021-05-28)
+
+
+### Bug Fixes
+
+* remove change npm to public ([3c36af7](https://github.com/easingthemes/ssh-deploy/commit/3c36af7577e5aee231cea5a01bb6cc83717d0e74))
+
+## [2.2.10](https://github.com/easingthemes/ssh-deploy/compare/v2.2.9...v2.2.10) (2021-05-27)
+
+
+### Bug Fixes
+
+* add assets to semantic-release git ([0867b12](https://github.com/easingthemes/ssh-deploy/commit/0867b12954dee2b8a2cccb7dfea3b8f3aa62d679))
+
+## [2.2.9](https://github.com/easingthemes/ssh-deploy/compare/v2.2.8...v2.2.9) (2021-05-27)
+
+
+### Bug Fixes
+
+* change npm to public ([191c82d](https://github.com/easingthemes/ssh-deploy/commit/191c82d9b441e26cf43f81041376dbf5ecdc1647))
+
+## [2.2.8](https://github.com/easingthemes/ssh-deploy/compare/v2.2.7...v2.2.8) (2021-05-27)
+
+
+### Bug Fixes
+
+* update npm package name ([9c4e411](https://github.com/easingthemes/ssh-deploy/commit/9c4e4119ad64792e5435e4dbe574c56a3e70839c))
+
+## [2.2.7](https://github.com/easingthemes/ssh-deploy/compare/v2.2.6...v2.2.7) (2021-05-27)
+
+
+### Bug Fixes
+
+* minify dist ([87551c3](https://github.com/easingthemes/ssh-deploy/commit/87551c38936fc91c0fbe3346ca43319d8098ac09))
+
+## [2.2.6](https://github.com/easingthemes/ssh-deploy/compare/v2.2.5...v2.2.6) (2021-05-27)
+
+
+### Bug Fixes
+
+* add NPM token ([2197bc6](https://github.com/easingthemes/ssh-deploy/commit/2197bc60ef7870d4bd494966b314eabec1615bd7))
+
+## [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,21 +1,16 @@
 {
-  "name": "ssh-deploy",
+  "name": "@draganfilipovic/ssh-deploy",
-  "version": "2.1.4-rc.1",
+  "version": "3.3.3",
-  "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",
+  "main": "dist/index.js",
-  "dependencies": {
+  "files": [
-    "command-exists": "1.2.8",
+    "/dist",
-    "node-cmd": "3.0.0",
+    "./action.yml",
-    "rsyncwrapper": "3.0.1"
+    "./README.md",
-  },
+    "LICENSE"
-  "devDependencies": {
+  ],
-    "@zeit/ncc": "^0.20.5",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.1.0",
-    "eslint-plugin-import": "^2.20.2"
-  },
   "scripts": {
-    "build": "npm run lint && ncc build ./src/index.js -o dist",
+    "build": "npm run lint && ncc build ./src/index.js -o dist -m",
     "lint": "eslint ./src/index.js",
     "lint:fix": "eslint ./src/index.js --fix"
   },
@@ -29,9 +24,18 @@
     "rsync"
   ],
   "author": "Dragan Filipovic",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/easingthemes/ssh-deploy/issues"
   },
-  "homepage": "https://github.com/easingthemes/ssh-deploy#readme"
+  "homepage": "https://github.com/easingthemes/ssh-deploy#readme",
+  "dependencies": {
+    "rsyncwrapper": "^3.0.1"
+  },
+  "devDependencies": {
+    "@vercel/ncc": "^0.36.0",
+    "eslint": "^8.30.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.26.0"
+  }
 }

src/helpers.js

@@ -1,38 +1,71 @@
 const { existsSync, mkdirSync, writeFileSync } = require('fs');
-
+const { join } = require('path');
-const {
-  GITHUB_WORKSPACE
-} = process.env;
 
 const validateDir = (dir) => {
-  if (!existsSync(dir)) {
+  if (!dir) {
-    console.log(`[SSH] Creating ${dir} dir in `, GITHUB_WORKSPACE);
+    console.warn('⚠️ [DIR] dir is not defined');
-    mkdirSync(dir);
+    return;
-    console.log('✅ [SSH] dir created.');
+  }
-  } else {
+  if (existsSync(dir)) {
-    console.log(`[SSH] ${dir} dir exist`);
+    console.log(`✅ [DIR] ${dir} dir exist`);
+    return;
+  }
+
+  console.log(`[DIR] Creating ${dir} dir in workspace root`);
+  mkdirSync(dir);
+  console.log('✅ [DIR] dir created.');
+};
+
+const handleError = (message, isRequired) => {
+  if (isRequired) {
+    throw new Error(message);
+  }
+  console.warn(message);
+};
+
+const writeToFile = ({ dir, filename, content, isRequired, mode = '0644' }) => {
+  validateDir(dir);
+  const filePath = join(dir, filename);
+
+  if (existsSync(filePath)) {
+    const message = `⚠️ [FILE] ${filePath} Required file exist.`;
+    handleError(message, isRequired);
+    return;
+  }
+
+  try {
+    console.log(`[FILE] writing ${filePath} file ...`, content.length);
+    writeFileSync(filePath, content, {
+      encoding: 'utf8',
+      mode
+    });
+  } catch (error) {
+    const message = `⚠️[FILE] Writing to file error. filePath: ${filePath}, message:  ${error.message}`;
+    handleError(message, isRequired);
   }
 };
 
-const validateFile = (filePath) => {
+const validateRequiredInputs = (inputs) => {
-  if (!existsSync(filePath)) {
+  const inputKeys = Object.keys(inputs);
-    console.log(`[SSH] Creating ${filePath} file in `, GITHUB_WORKSPACE);
+  const validInputs = inputKeys.filter((inputKey) => {
-    try {
+    const inputValue = inputs[inputKey];
-      writeFileSync(filePath, '', {
+
-        encoding: 'utf8',
+    if (!inputValue) {
-        mode: 0o600
+      console.error(`❌ [INPUTS] ${inputKey} is mandatory`);
-      });
-      console.log('✅ [SSH] file created.');
-    } catch (e) {
-      console.error('⚠️ [SSH] writeFileSync error', filePath, e.message);
-      process.abort();
     }
-  } else {
+
-    console.log(`[SSH] ${filePath} file exist`);
+    return inputValue;
+  });
+
+  if (validInputs.length !== inputKeys.length) {
+    throw new Error('⚠️ [INPUTS] Inputs not valid, aborting ...');
   }
 };
 
+const snakeToCamel = (str) => str.replace(/[^a-zA-Z0-9]+(.)/g, (m, chr) => chr.toUpperCase());
+
 module.exports = {
-  validateDir,
+  writeToFile,
-  validateFile
+  validateRequiredInputs,
+  snakeToCamel
 };

src/index.js

@@ -1,75 +1,47 @@
 #!/usr/bin/env node
-const nodeRsync = require('rsyncwrapper');
+const { sshDeploy } = require('./rsyncCli');
+const { remoteCmdBefore, remoteCmdAfter } = require('./remoteCmd');
+const { addSshKey, getPrivateKeyPath, updateKnownHosts } = require('./sshKey');
+const { validateRequiredInputs } = require('./helpers');
+const inputs = require('./inputs');
 
-const { validateRsync, validateInputs } = require('./rsyncCli');
+const run = async () => {
-const { addSshKey } = require('./sshKey');
+  const {
-
+    source, remoteUser, remoteHost, remotePort,
-const {
+    deployKeyName, sshPrivateKey,
-  REMOTE_HOST, REMOTE_USER,
+    args, exclude, sshCmdArgs,
-  REMOTE_PORT, SSH_PRIVATE_KEY, DEPLOY_KEY_NAME,
+    scriptBefore, scriptAfter,
-  SOURCE, TARGET, ARGS,
+    rsyncServer
-  GITHUB_WORKSPACE
+  } = inputs;
-} = require('./inputs');
+  // Validate required inputs
-
+  validateRequiredInputs({ sshPrivateKey, remoteHost, remoteUser });
-const defaultOptions = {
+  // Add SSH key
-  ssh: true,
+  addSshKey(sshPrivateKey, deployKeyName);
-  sshCmdArgs: ['-o StrictHostKeyChecking=no'],
+  const { path: privateKeyPath } = getPrivateKeyPath(deployKeyName);
-  recursive: true
+  // Update known hosts if ssh command is present to avoid prompt
-};
+  if (scriptBefore || scriptAfter) {
-
+    updateKnownHosts(remoteHost);
-console.log('[general] GITHUB_WORKSPACE: ', GITHUB_WORKSPACE);
+  }
-
+  // Check Script before
-const sshDeploy = (() => {
+  if (scriptBefore) {
-  const rsync = ({ privateKey, port, src, dest, args }) => {
+    await remoteCmdBefore(scriptBefore, privateKeyPath);
-    console.log(`[Rsync] Starting Rsync Action: ${src} to ${dest}`);
+  }
-
+  /* eslint-disable object-property-newline */
-    try {
+  await sshDeploy({
-      // RSYNC COMMAND
+    source, rsyncServer, exclude, remotePort,
-      nodeRsync({
+    privateKeyPath, args, sshCmdArgs
-        src, dest, args, privateKey, port, ...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 }) => {
-    validateRsync(() => {
-      const privateKey = addSshKey(privateKeyContent, DEPLOY_KEY_NAME || 'deploy_key');
-      const remoteDest = `${username}@${host}:${dest}`;
-
-      rsync({ privateKey, port, src, dest: remoteDest, args });
-    });
-  };
-
-  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
   });
+  // Check script after
+  if (scriptAfter) {
+    await remoteCmdAfter(scriptAfter, privateKeyPath);
+  }
 };
 
-run();
+run()
+  .then((data = '') => {
+    console.log('✅ [DONE]', data);
+  })
+  .catch((error) => {
+    console.error('❌ [ERROR]', error.message);
+    process.exit(1);
+  });

src/inputs.js

@@ -1,11 +1,48 @@
-const inputNames = ['REMOTE_HOST', 'REMOTE_USER', 'REMOTE_PORT', 'SSH_PRIVATE_KEY', 'DEPLOY_KEY_NAME', 'SOURCE', 'TARGET', 'ARGS'];
+const { snakeToCamel } = require('./helpers');
+
+const inputNames = [
+  'REMOTE_HOST', 'REMOTE_USER', 'REMOTE_PORT',
+  'SSH_PRIVATE_KEY', 'DEPLOY_KEY_NAME',
+  'SOURCE', 'TARGET', 'ARGS', 'SSH_CMD_ARGS', 'EXCLUDE',
+  'SCRIPT_BEFORE', 'SCRIPT_AFTER'];
+
+const githubWorkspace = process.env.GITHUB_WORKSPACE;
+const remoteUser = process.env.REMOTE_USER;
+
+const defaultInputs = {
+  source: '',
+  target: `/home/${remoteUser}/`,
+  exclude: '',
+  args: '-rltgoDzvO',
+  sshCmdArgs: '-o StrictHostKeyChecking=no',
+  deployKeyName: 'deploy_key'
+};
 
 const inputs = {
-  GITHUB_WORKSPACE: process.env.GITHUB_WORKSPACE
+  githubWorkspace
 };
-// Get inputs from ENV or WITH workflow settings
+
 inputNames.forEach((input) => {
-  inputs[input] = process.env[input] || process.env[`INPUT_${input}`];
+  const inputName = snakeToCamel(input.toLowerCase());
+  const inputVal = process.env[input] || process.env[`INPUT_${input}`];
+  const validVal = inputVal === undefined ? defaultInputs[inputName] : inputVal;
+  let extendedVal = validVal;
+  // eslint-disable-next-line default-case
+  switch (inputName) {
+    case 'source':
+      extendedVal = `${githubWorkspace}/${validVal}`;
+      break;
+    case 'exclude':
+    case 'args':
+    case 'sshCmdArgs':
+      extendedVal = validVal.split(',').map((item) => item.trim());
+      break;
+  }
+
+  inputs[inputName] = extendedVal;
 });
 
+inputs.sshServer = `${inputs.remoteUser}@${inputs.remoteHost}`;
+inputs.rsyncServer = `${inputs.remoteUser}@${inputs.remoteHost}:${inputs.target}`;
+
 module.exports = inputs;

src/remoteCmd.js

@@ -0,0 +1,40 @@
+const { exec } = require('child_process');
+const { sshServer, githubWorkspace } = require('./inputs');
+const { writeToFile } = require('./helpers');
+
+const handleError = (message, isRequired, callback) => {
+  if (isRequired) {
+    callback(new Error(message));
+  } else {
+    console.warn(message);
+  }
+};
+
+// eslint-disable-next-line max-len
+const remoteCmd = async (content, privateKeyPath, isRequired, label) => new Promise((resolve, reject) => {
+  const filename = `local_ssh_script-${label}.sh`;
+  try {
+    writeToFile({ dir: githubWorkspace, filename, content });
+    console.log(`Executing remote script: ssh -i ${privateKeyPath} ${sshServer}`);
+    exec(
+      `DEBIAN_FRONTEND=noninteractive ssh -i ${privateKeyPath} ${sshServer} 'RSYNC_STDOUT="${process.env.RSYNC_STDOUT}" bash -s' < ${filename}`,
+      (err, data, stderr) => {
+        if (err) {
+          const message = `⚠️ [CMD] Remote script failed: ${err.message}`;
+          console.warn(`${message} \n`, data, stderr);
+          handleError(message, isRequired, reject);
+        } else {
+          console.log('✅ [CMD] Remote script executed. \n', data, stderr);
+          resolve(data);
+        }
+      }
+    );
+  } catch (err) {
+    handleError(err.message, isRequired, reject);
+  }
+});
+
+module.exports = {
+  remoteCmdBefore: async (cmd, privateKeyPath, isRequired) => remoteCmd(cmd, privateKeyPath, isRequired, 'before'),
+  remoteCmdAfter: async (cmd, privateKeyPath, isRequired) => remoteCmd(cmd, privateKeyPath, isRequired, 'after')
+};

src/rsyncCli.js

@@ -1,46 +1,78 @@
-const { sync: commandExists } = require('command-exists');
+const { execSync } = require('child_process');
-const { get: nodeCmd } = require('node-cmd');
+const nodeRsync = require('rsyncwrapper');
 
-const validateRsync = (callback = () => {}) => {
+const nodeRsyncPromise = async (config) => new Promise((resolve, reject) => {
-  const rsyncCli = commandExists('rsync');
+  try {
-
+    nodeRsync(config, (error, stdout, stderr, cmd) => {
-  if (!rsyncCli) {
+      if (error) {
-    nodeCmd(
+        console.error('❌ [Rsync] error: ');
-      'sudo apt-get --no-install-recommends install rsync',
+        console.error(error);
-      (err, data, stderr) => {
+        console.error('❌ [Rsync] stderr: ');
-        if (err) {
+        console.error(stderr);
-          console.log('⚠️ [CLI] Rsync installation failed. Aborting ... ', err.message);
+        console.error('❌️ [Rsync] stdout: ');
-          process.abort();
+        console.error(stdout);
-        } else {
+        console.error('❌ [Rsync] cmd: ', cmd);
-          console.log('✅ [CLI] Rsync installed. \n', data, stderr);
+        reject(new Error(`${error.message}\n\n${stderr}`));
-          callback();
+      } else {
-        }
+        console.log('⭐ [Rsync] cmd finished: ', cmd);
+        resolve(stdout);
       }
-    );
+    });
-  } else {
+  } catch (error) {
-    callback();
+    console.error('❌ [Rsync] command error: ', error.message, error.stack);
+    reject(error);
+  }
+});
+
+const validateRsync = async () => {
+  try {
+    execSync('rsync --version', { stdio: 'inherit' });
+    console.log('✅️ [CLI] Rsync exists');
+    return;
+  } catch (error) {
+    console.warn('⚠️ [CLI] Rsync doesn\'t exists', error.message);
+  }
+
+  console.log('[CLI] Start rsync installation with "apt-get" \n');
+  try {
+    execSync('sudo DEBIAN_FRONTEND=noninteractive apt-get -y update && sudo DEBIAN_FRONTEND=noninteractive apt-get --no-install-recommends -y install rsync', { stdio: 'inherit' });
+    console.log('✅ [CLI] Rsync installed. \n');
+  } catch (error) {
+    throw new Error(`⚠️ [CLI] Rsync installation failed. Aborting ... error: ${error.message}`);
   }
 };
 
-const validateInputs = (inputs) => {
+const rsyncCli = async ({
-  const inputKeys = Object.keys(inputs);
+  source, rsyncServer, exclude, remotePort,
-  const validInputs = inputKeys.filter((inputKey) => {
+  privateKeyPath, args, sshCmdArgs
-    const inputValue = inputs[inputKey];
+}) => {
+  console.log(`[Rsync] Starting Rsync Action: ${source} to ${rsyncServer}`);
+  if (exclude) console.log(`[Rsync] excluding folders ${exclude}`);
 
-    if (!inputValue) {
+  const defaultOptions = {
-      console.error(`⚠️ [INPUTS] ${inputKey} is mandatory`);
+    ssh: true,
-    }
+    recursive: true,
+    onStdout: (data) => console.log(data.toString()),
+    onStderr: (data) => console.error(data.toString())
+  };
 
-    return inputValue;
+  // RSYNC COMMAND
+  /* eslint-disable object-property-newline */
+  return nodeRsyncPromise({
+    ...defaultOptions,
+    src: source, dest: rsyncServer, excludeFirst: exclude, port: remotePort,
+    privateKey: privateKeyPath, args, sshCmdArgs
   });
+};
 
-  if (validInputs.length !== inputKeys.length) {
+const sshDeploy = async (params) => {
-    console.error(`⚠️ [INPUTS] Inputs not valid, aborting ...`);
+  await validateRsync();
-    process.abort();
+  const stdout = await rsyncCli(params);
-  }
+  console.log('✅ [Rsync] finished.', stdout);
+  process.env.RSYNC_STDOUT = `${stdout}`;
+  return stdout;
 };
 
 module.exports = {
-  validateRsync,
+  sshDeploy
-  validateInputs
+};
-}

src/sshKey.js

@@ -1,37 +1,43 @@
-const { writeFileSync } = require('fs');
 const { join } = require('path');
+const { execSync } = require('child_process');
+const { writeToFile } = require('./helpers');
 
-const {
+const KNOWN_HOSTS = 'known_hosts';
-  validateDir,
+const getPrivateKeyPath = (filename = '') => {
-  validateFile
+  const { HOME } = process.env;
-} = require('./helpers');
+  const dir = join(HOME || '~', '.ssh');
+  const knownHostsPath = join(dir, KNOWN_HOSTS);
+  return {
+    dir,
+    filename,
+    path: join(dir, filename),
+    knownHostsPath
+  };
+};
 
-const {
+const addSshKey = (content, deployKeyName) => {
-  HOME
+  const { dir, filename } = getPrivateKeyPath(deployKeyName);
-} = process.env;
+  writeToFile({ dir, filename: KNOWN_HOSTS, content: '' });
-
+  console.log('✅ [SSH] known_hosts file ensured', dir);
-const addSshKey = (key, name) => {
+  writeToFile({ dir, filename, content, isRequired: true, mode: '0400' });
-  const sshDir = join(HOME || __dirname, '.ssh');
+  console.log('✅ [SSH] key added to `.ssh` dir ', dir, filename);
-  const filePath = join(sshDir, name);
+};
-
-  validateDir(sshDir);
-  validateFile(`${sshDir}/known_hosts`);
 
+const updateKnownHosts = (host) => {
+  const { knownHostsPath } = getPrivateKeyPath();
+  console.log('[SSH] Adding host to `known_hosts` ....', host, knownHostsPath);
   try {
-    writeFileSync(filePath, key, {
+    execSync(`ssh-keyscan -H ${host}  >> ${knownHostsPath}`, {
-      encoding: 'utf8',
+      stdio: 'inherit'
-      mode: 0o600
     });
-  } catch (e) {
+  } catch (error) {
-    console.error('⚠️ writeFileSync error', filePath, e.message);
+    console.error('❌ [SSH] Adding host to `known_hosts` ERROR', host, error.message);
-    process.abort();
   }
-
+  console.log('✅ [SSH] Adding host to `known_hosts` DONE', host, knownHostsPath);
-  console.log('✅ Ssh key added to `.ssh` dir ', filePath);
-
-  return filePath;
 };
 
 module.exports = {
+  getPrivateKeyPath,
+  updateKnownHosts,
   addSshKey
-}
+};

test/.dockerignore

@@ -0,0 +1,5 @@
+/node_modules
+.gitignore
+.gitattributes
+LICENSE
+README.md

test/Dockerfile

@@ -0,0 +1,33 @@
+FROM nginx
+
+ARG SSH_PUB_KEY
+
+RUN apt update
+
+RUN apt install openssh-server rsync sudo -y
+
+RUN useradd -rm -d /home/test -s /bin/bash -g root -G sudo -u 1000 test
+
+RUN usermod -aG sudo test
+
+RUN echo "PubkeyAuthentication yes" >> /etc/ssh/sshd_config.d/pub.conf
+RUN echo "AuthorizedKeysFile  .ssh/authorized_keys" >> /etc/ssh/sshd_config.d/pub.conf
+
+RUN mkdir -p /var/www/html
+RUN chown -R test /var/www/html
+RUN mkdir -p /home/test/.ssh
+RUN echo "$SSH_PUB_KEY" > /home/test/.ssh/authorized_keys
+RUN chmod 700 /home/test/.ssh
+RUN chown -R test /home/test/.ssh
+
+RUN service ssh start
+
+RUN  echo 'test:test' | chpasswd
+
+EXPOSE 22
+
+ADD entrypoint.sh /docker-entrypoint.d/entrypoint.sh
+RUN chmod +x /docker-entrypoint.d/entrypoint.sh
+
+
+CMD ["nginx", "-g", "daemon off;"]

test/entrypoint.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+/usr/sbin/sshd -D