chore(release): 5.1.1 [skip ci]

## [5.1.1](https://github.com/easingthemes/ssh-deploy/compare/v5.1.0...v5.1.1) (2024-07-24)

### Bug Fixes

* Update README.md ([f007431](f007431332))

.github/workflows/build.yml

@@ -14,13 +14,13 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node-version: [16.x]
+        node-version: [20.x]
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies

.github/workflows/codeql-analysis.yml

@@ -31,11 +31,11 @@ jobs:
         language: [ 'javascript' ]
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
 
@@ -44,4 +44,4 @@ jobs:
         npm run build --if-present
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

.github/workflows/e2e-manual.yml

@@ -0,0 +1,104 @@
+name: e2e Manual Test
+
+on:
+  workflow_dispatch:
+    inputs:
+      ARGS:
+        description: 'ARGS'
+        required: true
+        default: '-rlgoDzvc -i --delete --chmod=ugo+rwX --progress'
+      EXCLUDE:
+        description: 'EXCLUDE'
+        required: true
+        default: 'skip_dir/, /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-manual:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+#         ----------------------------------------------------------------
+#         START E2E Test Specific - steps
+#         ----------------------------------------------------------------
+
+      - name: E2E Test Specific - Clean up old test files
+        run: |
+          docker stop ssh-host-container || true && docker rm ssh-host-container || true
+
+      - name: E2E Test Specific - 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: E2E Test Specific - 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)"
+          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: E2E Test Specific - Create project file
+        run: |
+          mkdir test_project2 && cd "$_"
+          truncate -s 5MB info2.txt
+          cd ../
+          mkdir test_project && cd "$_"
+          touch index.html
+          date +"%Y-%m-%d %H:%M:%S,%3N" >> index.html
+          truncate -s 50MB image.svg
+          truncate -s 5MB info.txt
+          truncate -s 500MB big_file.txt
+          mkdir skip_dir && cd "$_"
+          truncate -s 5MB text_in_skip_dir.txt
+          cd ../
+          cat index.html
+          echo "test_project:" && ls -lR
+          echo "skip_dir:" && ls -lR skip_dir
+
+#         ----------------------------------------------------------------
+#         END E2E Test Specific - steps
+#         ----------------------------------------------------------------
+
+      - name: e2e Test 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 }}
+          SSH_CMD_ARGS: ${{ github.event.inputs.SSH_CMD_ARGS }}
+          SOURCE: test_project/ test_project2/
+          TARGET: /var/www/html/
+          EXCLUDE: ${{ github.event.inputs.EXCLUDE }}
+          SCRIPT_BEFORE: |
+            whoami
+            ls -lR /var/www/html/
+          SCRIPT_AFTER: |
+            ls -lR /var/www/html/
+            echo $RSYNC_STDOUT

.github/workflows/e2e.yml

@@ -3,25 +3,11 @@ 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
+  TEST_USER2: test2
 
 jobs:
   e2e:
@@ -29,13 +15,17 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Clean up old test files
+#         : ---------------------------------------------------------------
+#         : START E2E Test Specific - steps
+#         : ----------------------------------------------------------------
+
+      - name: E2E Test Specific - Clean up old test files
         run: |
           docker stop ssh-host-container || true && docker rm ssh-host-container || true
 
-      - name: Create ssh keys
+      - name: E2E Test Specific - Create ssh keys
         run: |
           echo $HOME
           ls -la $HOME
@@ -47,13 +37,12 @@ jobs:
           cat $HOME/.ssh/id_rsa >> $GITHUB_ENV
           echo "EOF" >> $GITHUB_ENV
 
-      - name: Build Host Server Image
+      - name: E2E Test Specific - 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_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
@@ -61,33 +50,130 @@ jobs:
           echo "EOF" >> $GITHUB_ENV
         shell: bash
 
-      - name: Create project file
+      - name: E2E Test Specific - Create project file
         run: |
-          mkdir test_project
+          mkdir test_project2 && cd "$_"
-          cd test_project
+          truncate -s 5MB info2.txt
+          cd ../
+          mkdir test_project && cd "$_"
           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
+          truncate -s 50MB image.svg
+          truncate -s 5MB info.txt
+          truncate -s 500MB big_file.txt
+          mkdir skip_dir && cd "$_"
+          truncate -s 5MB text_in_skip_dir.txt
+          cd ../
           cat index.html
+          echo "test_project:" && ls -lR
+          echo "skip_dir:" && ls -lR skip_dir
 
-      - name: e2e Test published ssh-deploy action
+#         ----------------------------------------------------------------
+#         END E2E Test Specific - steps
+#         ----------------------------------------------------------------
+
+      - name: set shared ENV variables for multi target deployment
+        run: |
+          echo "ARGS=-rlgoDzvcR -i --delete --chmod=ugo+rwX --progress" >> $GITHUB_ENV
+          echo "SSH_CMD_ARGS=-o StrictHostKeyChecking=no, -o UserKnownHostsFile=/dev/null" >> $GITHUB_ENV
+          echo "SOURCE=test_project/ test_project2/" >> $GITHUB_ENV
+          echo "EXCLUDE=skip_dir/, /node_modules/" >> $GITHUB_ENV
+          echo "SCRIPT_BEFORE<<EOF" >> $GITHUB_ENV
+          echo "whoami" >> $GITHUB_ENV
+          echo "ls -lR /var/www/html/" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+          echo "SCRIPT_AFTER<<EOF" >> $GITHUB_ENV
+          echo $RSYNC_STDOUT >> $GITHUB_ENV
+          echo "ls -lR /var/www/html/" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: e2e Test ssh-deploy action - Target 1
         uses: easingthemes/ssh-deploy@main
         env:
-          # ENV Vars created in previous steps:
+          # Shared 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' }}
+          TARGET: /var/www/html/${{ env.TEST_USER }}
-          SSH_CMD_ARGS: ${{ github.event.inputs.SSH_CMD_ARGS || '-o StrictHostKeyChecking=no, -o UserKnownHostsFile=/dev/null' }}
+
-          SOURCE: "test_project/"
+      - name: e2e Test ssh-deploy action - Target 2
-          TARGET: "/var/www/html/"
+        uses: easingthemes/ssh-deploy@main
-          EXCLUDE: ${{ github.event.inputs.EXCLUDE || '/dist/, /node_modules/' }}
+        env:
-          SCRIPT_BEFORE: |
+          # Shared ENV Vars created in previous steps
-            whoami
+          REMOTE_USER: ${{ env.TEST_USER2 }}
-            ls -al
+          TARGET: /var/www/html/${{ env.TEST_USER2 }}
-          SCRIPT_AFTER: |
+
-            whoami
+      - name: e2e Test ssh-deploy action - Default values
-            ls -al
+        uses: easingthemes/ssh-deploy@main
-            echo $RSYNC_STDOUT
+        env:
+          # Shared ENV Vars created in previous steps
+          REMOTE_USER: ${{ env.TEST_USER }}
+  e2e-v3:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      #         : ---------------------------------------------------------------
+      #         : START E2E Test Specific - steps
+      #         : ----------------------------------------------------------------
+
+      - name: E2E Test Specific - Clean up old test files
+        run: |
+          docker stop ssh-host-container || true && docker rm ssh-host-container || true
+
+      - name: E2E Test Specific - 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: E2E Test Specific - 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)"
+          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: E2E Test Specific - Create project file
+        run: |
+          mkdir test_project2 && cd "$_"
+          truncate -s 5MB info2.txt
+          cd ../
+          mkdir test_project && cd "$_"
+          touch index.html
+          date +"%Y-%m-%d %H:%M:%S,%3N" >> index.html
+          truncate -s 50MB image.svg
+          truncate -s 5MB info.txt
+          truncate -s 500MB big_file.txt
+          mkdir skip_dir && cd "$_"
+          truncate -s 5MB text_in_skip_dir.txt
+          cd ../
+          cat index.html
+          echo "test_project:" && ls -lR
+          echo "skip_dir:" && ls -lR skip_dir
+
+      #         ----------------------------------------------------------------
+      #         END E2E Test Specific - steps
+      #         ----------------------------------------------------------------
+
+      - name: e2e Test ssh-deploy action - Target 1
+        uses: easingthemes/ssh-deploy@main
+        env:
+          # Shared ENV Vars created in previous steps
+          REMOTE_USER: ${{ env.TEST_USER }}
+          TARGET: /var/www/html/${{ env.TEST_USER }}
+          SOURCE: test_project/
+          EXCLUDE: skip_dir/, /node_modules/
+          ARGS: -rlgoDzvcO

.github/workflows/manual-release.yml

@@ -2,39 +2,20 @@ name: Manual Release
 on:
   workflow_dispatch:
     inputs:
-      dryrun:
+      version:
-        description: 'DryRUn'
+        description: 'Version'
+        type: choice
         required: true
-        default: 'false'
+        default: fix
-jobs:
+        options:
-  release:
+          - fix
-    name: Test, Build and Release
+          - feat
-    runs-on: ${{ matrix.os }}
+      dryRun:
-    strategy:
+        description: 'DryRun'
-      matrix:
+        type: boolean
-        os: [ ubuntu-latest ]
+        default: true
-        node-version: [ 16.x ]
+# ENV and Config
-    steps:
+env:
-      - 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
@@ -42,3 +23,50 @@ jobs:
   GIT_COMMITTER_NAME: github-actions
   GIT_COMMITTER_EMAIL: github-actions@github.com
   CI: true
+  CONFIG_NODE_VERSION: '["lts/*"]'
+  CONFIG_OS: '["ubuntu-latest"]'
+# Main Job
+jobs:
+  config:
+    runs-on: ubuntu-latest
+    outputs:
+      NODE_VERSION: ${{ steps.set-config.outputs.CONFIG_NODE_VERSION }}
+      OS: ${{ steps.set-config.outputs.CONFIG_OS }}
+    steps:
+      - id: set-config
+        run: |
+          echo "CONFIG_NODE_VERSION=${{ toJSON(env.CONFIG_NODE_VERSION) }}" >> $GITHUB_OUTPUT
+          echo "CONFIG_OS=${{ toJSON(env.CONFIG_OS) }}" >> $GITHUB_OUTPUT
+  release-manual:
+    name: Test, Build and force Release
+    needs: config
+
+    runs-on: ${{ matrix.OS }}
+    strategy:
+      matrix:
+        OS: ${{ fromJSON(needs.config.outputs.OS) }}
+        NODE_VERSION: ${{ fromJSON(needs.config.outputs.NODE_VERSION) }}
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Setup Node.js ${{ matrix.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.NODE_VERSION }}
+      - name: Commit trigger
+        run: |
+          git commit --allow-empty -m "${{ github.event.inputs.version }}: Trigger Manual Release"
+      - name: Install dependencies
+        run: npm ci
+      - name: Build Library
+        run: npm run build --if-present
+      - name: Run Tests
+        run: npm test --if-present
+      - name: Create a release - ${{ github.event.inputs.version }}
+        uses: cycjimmy/semantic-release-action@v4
+        with:
+          dry_run: ${{ github.event.inputs.dryRun == 'true' }}
+          extra_plugins: |
+            @semantic-release/changelog
+            @semantic-release/git

.github/workflows/release.yml

@@ -12,13 +12,13 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        node-version: [ 16.x ]
+        node-version: [ 20.x ]
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix['node-version'] }}
       - name: Install dependencies
@@ -28,7 +28,7 @@ jobs:
       - name: Run Tests
         run: npm test --if-present
       - name: Release
-        uses: cycjimmy/semantic-release-action@v3
+        uses: cycjimmy/semantic-release-action@v4
         with:
           dry_run: false
           extra_plugins: |

.github/workflows/stale.yml

@@ -17,10 +17,10 @@ jobs:
       issues: write
 
     steps:
-    - uses: actions/stale@v7
+    - uses: actions/stale@v9
       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-stale: 90
-        days-before-close: 5
+        days-before-close: 15
         stale-issue-label: 'stale'

README.md

@@ -28,6 +28,8 @@ The keys should be generated using the PEM format. You can use this command
 ```
 ssh-keygen -m PEM -t rsa -b 4096
 ```
+**Please Note:** You should not set a Passphrase (keep it empty) for the private key you generated.
+Because rsync ssh (used for deploy) does not support private key password to be entered as a command line parameter.
 
 ##### 2. `REMOTE_HOST` [required]
 
@@ -41,13 +43,14 @@ eg: myusername
 
 eg: '59184'
 
-##### 5. `ARGS` (optional, default '-rltgoDzvO')
+##### 5. `ARGS` (optional, default '-rlgoDzvc -i')
 
 For any initial/required rsync flags, eg: `-avzr --delete`
 
 ##### 6. `SOURCE` (optional, default '')
 
-The source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`
+The source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`.
+Multiple sources should be separated by space.
 
 ##### 7. `TARGET` (optional, default '/home/REMOTE_USER/')
 
@@ -61,28 +64,38 @@ path to exclude separated by `,`, ie: `/dist/, /node_modules/`
 
 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`
+If you have issues with `ssh` connection, use this var, eg `SCRIPT_BEFORE: ls`.
+This will force `known_hosts` update, adding your host via `ssh-keyscan`.
 
-##### 10. `SCRIPT_AFTER` (optional, default '')
+##### 10. `SCRIPT_BEFORE_REQUIRED` (optional, default false)
+
+If set to `true`, Job will fail if SCRIPT_BEFORE fails.
+
+##### 11. `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')
+##### 12. `SCRIPT_AFTER_REQUIRED` (optional, default false)
+
+If set to `true`, Job will fail if SCRIPT_AFTER fails.
+
+##### 13. `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
+Use the latest version from Marketplace,eg: ssh-deploy@v5.1.0
 or use the latest version from a branch, eg: ssh-deploy@main
 
 ```
   - name: Deploy to Staging server
     uses: easingthemes/ssh-deploy@main
-    env:
+    with:
       SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
-      ARGS: "-rltgoDzvO"
+      ARGS: "-rlgoDzvc -i"
       SOURCE: "dist/"
       REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
       REMOTE_USER: ${{ secrets.REMOTE_USER }}
@@ -110,20 +123,20 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: Install Node.js
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
-        node-version: '10.x'
+        node-version: '16.x'
     - name: Install npm dependencies
       run: npm install
     - name: Run build task
       run: npm run build --if-present
     - name: Deploy to Server
       uses: easingthemes/ssh-deploy@main
-      env:
+      with:
           SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
-          ARGS: "-rltgoDzvO --delete"
+          ARGS: "-rlgoDzvc -i --delete"
           SOURCE: "dist/"
           REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
           REMOTE_USER: ${{ secrets.REMOTE_USER }}
@@ -139,15 +152,29 @@ Almost 95% of the issues are related to wrong SSH connection or `rsync` params a
 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 `rsync` params for your use-case. Default params are not necessarily going to be enough for everyone, it highly depends on your setup.
 - Check manually your rsync command from your client before opening a bug report.
+- `Deployment Failed, Permission denied (publickey,password)`: This issue occures in some cases, it is related to OS and ssh. This action can only provide a workaround:
+  - Use `SCRIPT_BEFORE` param, eg `SCRIPT_BEFORE: ls`. This will force `known_hosts` update, adding your host via `ssh-keyscan`.
+  - Or manually add public key to authorized_keys and add a new line to a private key.
 
 I've added e2e test for this action.
 Real example is executed on every PR merge to `main`.
 Check actions tab for example.
 
+When opening an issue, please add example of your step with env vars. You can add dummy values.
+
 More info for SSH keys: https://www.ssh.com/ssh/public-key-authentication
 
+## Tips
+
+- Optional ENV variables are created for simple requirements.
+For complex use cases, use `ARGS` and `SSH_CMD_ARGS` to fully configure `rsync` with all possible options.
+- If you need to use multiple steps, eg multi targets deployment, save shared ENV variables in `>> $GITHUB_ENV`.
+Check .github/workflows/e2e.yml for an example
+- For multi sources, use -R ARG to manipulate folders structure.
+- Great post about `rsync` options specific to usage of this action: https://logansnotes.com/2020/gh-action-site-deploy/
+
 
 ## Disclaimer
 

action.yml

@@ -22,11 +22,11 @@ inputs:
   TARGET:
     description: "Target directory"
     required: false
-    default: "/home/REMOTE_USER/"
+    default: ""
   ARGS:
     description: "Arguments to pass to rsync"
     required: false
-    default: "-rltgoDzvO"
+    default: "-rlgoDzvc -i"
   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
@@ -39,15 +39,23 @@ inputs:
     description: "Script to run on host machine before rsync"
     required: false
     default: ""
+  SCRIPT_BEFORE_REQUIRED:
+    description: "If not an empty string, the action will fail if the before script fails. Note: The string 'false' will be treated as true"
+    required: false
+    default: ""
   SCRIPT_AFTER:
     description: "Script to run on host machine after rsync"
     required: false
     default: ""
+  SCRIPT_AFTER_REQUIRED:
+    description: "If not an empty string, the action will fail if the after script fails. Note: The string 'false' will be treated as true"
+    required: false
+    default: ""
 outputs:
   status:
     description: "Status"
 runs:
-  using: "node16"
+  using: "node20"
   main: "dist/index.js"
 branding:
   color: "green"

docs/CHANGELOG.md

@@ -1,3 +1,228 @@
+## [5.1.1](https://github.com/easingthemes/ssh-deploy/compare/v5.1.0...v5.1.1) (2024-07-24)
+
+
+### Bug Fixes
+
+* Update README.md ([f007431](https://github.com/easingthemes/ssh-deploy/commit/f007431332cb2dae49153363ad22fb9f90f4aa75))
+
+# [5.1.0](https://github.com/easingthemes/ssh-deploy/compare/v5.0.3...v5.1.0) (2024-07-24)
+
+
+### Features
+
+* Add deleteFile function to helpers module ([1befdb1](https://github.com/easingthemes/ssh-deploy/commit/1befdb1c6bf3282aa34e6caa431cb2da23d2b17d))
+* apply deleteFile function to remoteCmd ([b82eced](https://github.com/easingthemes/ssh-deploy/commit/b82eced4571cb3f63369d51760a81820ffb1bc7f))
+
+## [5.0.3](https://github.com/easingthemes/ssh-deploy/compare/v5.0.2...v5.0.3) (2024-02-27)
+
+
+### Bug Fixes
+
+* trigger automated release ([4d8bbf0](https://github.com/easingthemes/ssh-deploy/commit/4d8bbf0debaade9fb03b8dc3be3c020955557b12))
+
+## [5.0.2](https://github.com/easingthemes/ssh-deploy/compare/v5.0.1...v5.0.2) (2024-02-18)
+
+
+### Bug Fixes
+
+* added the missing declarations [#177](https://github.com/easingthemes/ssh-deploy/issues/177) ([bb271fe](https://github.com/easingthemes/ssh-deploy/commit/bb271fe4c69eeeacb986a38cdb3347104143c61f))
+* Fix default values used incorrectly. ([a1b383f](https://github.com/easingthemes/ssh-deploy/commit/a1b383f560a7f52a65da3670e61efe6e02f8639a))
+
+## [5.0.1](https://github.com/easingthemes/ssh-deploy/compare/v5.0.0...v5.0.1) (2024-01-31)
+
+
+### Bug Fixes
+
+* Add info for Permission denied issue. ([845b578](https://github.com/easingthemes/ssh-deploy/commit/845b578606c0c5a956c70caf61e00a7d2b13ee37))
+
+# [5.0.0](https://github.com/easingthemes/ssh-deploy/compare/v4.1.10...v5.0.0) (2023-12-12)
+
+
+* Merge pull request #173 from jeromelachaud/main ([ac1908e](https://github.com/easingthemes/ssh-deploy/commit/ac1908e5d2dc749496fdbe8a918aa073e3357d85)), closes [#173](https://github.com/easingthemes/ssh-deploy/issues/173)
+
+
+### BREAKING CHANGES
+
+* update to use nodeJS v20
+* update to use nodeJS v20
+
+## [4.1.10](https://github.com/easingthemes/ssh-deploy/compare/v4.1.9...v4.1.10) (2023-09-30)
+
+
+### Bug Fixes
+
+* normalize line endings in SSH key for the underlying OS ([3f5d9aa](https://github.com/easingthemes/ssh-deploy/commit/3f5d9aab1a743bd426a4d132d07f1f5e9ed0310c))
+
+## [4.1.9](https://github.com/easingthemes/ssh-deploy/compare/v4.1.8...v4.1.9) (2023-09-24)
+
+
+### Bug Fixes
+
+* add compiled file ([627ac29](https://github.com/easingthemes/ssh-deploy/commit/627ac29ece9dc2f1185a50d1002bc2c968fc973c))
+* add uuid for ssh scripts ([66f6e4b](https://github.com/easingthemes/ssh-deploy/commit/66f6e4b367ea39479c285234797a4e86c90d9abd))
+
+## [4.1.8](https://github.com/easingthemes/ssh-deploy/compare/v4.1.7...v4.1.8) (2023-02-21)
+
+
+### Bug Fixes
+
+* rebuild and update readme ([98025d6](https://github.com/easingthemes/ssh-deploy/commit/98025d680e96a5c6c805e377a1b81de2f626aa1e))
+
+## [4.1.7](https://github.com/easingthemes/ssh-deploy/compare/v4.1.6...v4.1.7) (2023-02-21)
+
+
+### Bug Fixes
+
+* [#120](https://github.com/easingthemes/ssh-deploy/issues/120) check undefined data ([2fbb060](https://github.com/easingthemes/ssh-deploy/commit/2fbb06015d1a6ffd32e0100aaf1a1a46949e990e))
+
+## [4.1.6](https://github.com/easingthemes/ssh-deploy/compare/v4.1.5...v4.1.6) (2023-02-21)
+
+
+### Bug Fixes
+
+* [#118](https://github.com/easingthemes/ssh-deploy/issues/118) check undefined default values rebuild ([54f8b6c](https://github.com/easingthemes/ssh-deploy/commit/54f8b6c60b8f2f926d5ed9538557e5521a905d87))
+
+## [4.1.5](https://github.com/easingthemes/ssh-deploy/compare/v4.1.4...v4.1.5) (2023-02-21)
+
+
+### Bug Fixes
+
+* [#118](https://github.com/easingthemes/ssh-deploy/issues/118) check undefined default values ([f0c02fb](https://github.com/easingthemes/ssh-deploy/commit/f0c02fb2a5b3b69bb91004dd49d409eb6adfe7cd))
+
+## [4.1.4](https://github.com/easingthemes/ssh-deploy/compare/v4.1.3...v4.1.4) (2023-02-21)
+
+
+### Bug Fixes
+
+* [#113](https://github.com/easingthemes/ssh-deploy/issues/113) limit ssh script input ([5894f5e](https://github.com/easingthemes/ssh-deploy/commit/5894f5e29008feccaf42787330ec8f49f3ad50b0))
+
+## [4.1.3](https://github.com/easingthemes/ssh-deploy/compare/v4.1.2...v4.1.3) (2023-02-21)
+
+
+### Bug Fixes
+
+* [#113](https://github.com/easingthemes/ssh-deploy/issues/113) limit ssh script output - rebuild ([756a522](https://github.com/easingthemes/ssh-deploy/commit/756a522533d2206203b5d13b5aa11c88b3313784))
+
+## [4.1.2](https://github.com/easingthemes/ssh-deploy/compare/v4.1.1...v4.1.2) (2023-02-21)
+
+
+### Bug Fixes
+
+* [#113](https://github.com/easingthemes/ssh-deploy/issues/113) limit ssh script output ([59827af](https://github.com/easingthemes/ssh-deploy/commit/59827af83c934996efda72f9fbd1fcd0bb9ccaac))
+
+## [4.1.1](https://github.com/easingthemes/ssh-deploy/compare/v4.1.0...v4.1.1) (2023-02-21)
+
+
+### Bug Fixes
+
+* fix default TARGET ([4d08634](https://github.com/easingthemes/ssh-deploy/commit/4d086346af62ac5d57fa37ee6bb46f8de8ad48c3))
+
+# [4.1.0](https://github.com/easingthemes/ssh-deploy/compare/v4.0.5...v4.1.0) (2023-02-19)
+
+
+### Features
+
+* add ssh port from VARs, fix package-lock ([808b002](https://github.com/easingthemes/ssh-deploy/commit/808b0020d44b7c25ef1c13b3979ffdab4f503236))
+
+## [4.0.5](https://github.com/easingthemes/ssh-deploy/compare/v4.0.4...v4.0.5) (2023-01-06)
+
+
+### Bug Fixes
+
+* fix manual release action ([245b7a9](https://github.com/easingthemes/ssh-deploy/commit/245b7a9d2fe5272ee34608f86a612d643694c23b))
+
+## [4.0.4](https://github.com/easingthemes/ssh-deploy/compare/v4.0.3...v4.0.4) (2023-01-03)
+
+
+### Bug Fixes
+
+* update sub dependencies ([2a32c8d](https://github.com/easingthemes/ssh-deploy/commit/2a32c8dcde2d64394a3577decdd9c902f37a30f8))
+
+## [4.0.3](https://github.com/easingthemes/ssh-deploy/compare/v4.0.2...v4.0.3) (2023-01-03)
+
+
+### Bug Fixes
+
+* update v3 e2e test ([450bf42](https://github.com/easingthemes/ssh-deploy/commit/450bf423f388777bde052ad7b5bc24eca392434d))
+
+## [4.0.2](https://github.com/easingthemes/ssh-deploy/compare/v4.0.1...v4.0.2) (2023-01-03)
+
+
+### Bug Fixes
+
+* add githubWorkspace as default source root ([3ef66d0](https://github.com/easingthemes/ssh-deploy/commit/3ef66d0be999ee45434505e8bedea4f8b5b5a909))
+
+## [4.0.1](https://github.com/easingthemes/ssh-deploy/compare/v4.0.0...v4.0.1) (2023-01-03)
+
+
+### Bug Fixes
+
+* fix default source if empty ([9f191f4](https://github.com/easingthemes/ssh-deploy/commit/9f191f42633c4a0f66054f0fc229c9e30a08f00c))
+
+# [4.0.0](https://github.com/easingthemes/ssh-deploy/compare/v3.4.3...v4.0.0) (2023-01-03)
+
+
+### Bug Fixes
+
+* rebuild ([2169399](https://github.com/easingthemes/ssh-deploy/commit/2169399fef9a60a2fea1ab03cce4ec8c2371e5c2))
+
+
+### Performance Improvements
+
+* update default rsync options ([2be7efb](https://github.com/easingthemes/ssh-deploy/commit/2be7efb376866327c1d1209f51eb43f34f07b354))
+
+
+### BREAKING CHANGES
+
+* Default rsync options updated to speed up default deployments.
+from `rltgoDzvO` to `-rlgoDzvc -i`
+
+## [3.4.3](https://github.com/easingthemes/ssh-deploy/compare/v3.4.2...v3.4.3) (2023-01-03)
+
+
+### Bug Fixes
+
+* move e2e tests typo branch name ([6d3554b](https://github.com/easingthemes/ssh-deploy/commit/6d3554b01e9a05de9a9d2b30274bee411a4986ed))
+
+## [3.4.2](https://github.com/easingthemes/ssh-deploy/compare/v3.4.1...v3.4.2) (2023-01-03)
+
+
+### Bug Fixes
+
+* Update changelog ([765f5ff](https://github.com/easingthemes/ssh-deploy/commit/765f5ffd3153c76442521c61c04656cafc182731))
+
+## [3.4.1](https://github.com/easingthemes/ssh-deploy/compare/v3.4.0...v3.4.1) (2023-01-03)
+
+
+### Bug Fixes
+
+* move e2e tests to main branch ([0069fae](https://github.com/easingthemes/ssh-deploy/commit/0069faea9ff3ea3cdd095b0f2663c9e2bcd97480))
+
+# [3.4.0](https://github.com/easingthemes/ssh-deploy/compare/v3.3.4...v3.4.0) (2023-01-03)
+
+
+**Full Changelog**: https://github.com/easingthemes/ssh-deploy/compare/v3.1.0...v3.4.1
+
+### Features
+
+* Add SSH remote script support -  before and after rsync ([2cd8a82](https://github.com/easingthemes/ssh-deploy/commit/2cd8a820e22135b7002fbe6a47cf33f99e2d337b))
+* Add multi source and multi target support ([73a65ec](https://github.com/easingthemes/ssh-deploy/commit/73a65ec97c5046a53f6b4c40823be5fd3826ede0))
+* Add SSH_CMD_ARGS support ([51a0063](https://github.com/easingthemes/ssh-deploy/commit/51a00631e2b91983fb610ca2157a673b9ae03c95))
+* Add manual inputs for e2e test ([8f71595](https://github.com/easingthemes/ssh-deploy/commit/8f715957ab9283ab2934dd1e5be9d78f2eaf3fae))
+
+### Bug Fixes
+
+* Add visible Rsync CMD for debugging ([91b6d28](https://github.com/easingthemes/ssh-deploy/commit/91b6d280aee6a7ae666a11426fb356406f4a25a5))
+* log buffer from rsync stdout ([8e19e0d](https://github.com/easingthemes/ssh-deploy/commit/8e19e0d6bc9b1c332925ce0268ad64b50728fae5))
+* fix e2e yaml step name ([5c13615](https://github.com/easingthemes/ssh-deploy/commit/5c13615d4b7b0bda47f622ac5f4444484d8bcdb4))
+
+## [3.3.4](https://github.com/easingthemes/ssh-deploy/compare/v3.3.3...v3.3.4) (2023-01-02)
+
+
+### Bug Fixes
+
+* Add visible Rsync CMD for debugging ([91b6d28](https://github.com/easingthemes/ssh-deploy/commit/91b6d280aee6a7ae666a11426fb356406f4a25a5))
+
 ## [3.3.3](https://github.com/easingthemes/ssh-deploy/compare/v3.3.2...v3.3.3) (2023-01-02)
 
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@draganfilipovic/ssh-deploy",
-  "version": "3.1.0",
+  "version": "4.1.10",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@draganfilipovic/ssh-deploy",
-      "version": "3.1.0",
+      "version": "4.1.10",
       "license": "MIT",
       "dependencies": {
         "rsyncwrapper": "^3.0.1"
@@ -19,9 +19,9 @@
       }
     },
     "node_modules/@eslint/eslintrc": {
-      "version": "1.4.0",
+      "version": "1.4.1",
-      "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.4.0.tgz",
+      "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.4.1.tgz",
-      "integrity": "sha512-7yfvXy6MWLgWSFsLhz5yH3iQ52St8cdUY6FoGieKkRDVxuxmrNuUetIuu6cmjNWwniUHiWXjxCr5tTXDrbYS5A==",
+      "integrity": "sha512-XXrH9Uarn0stsyldqDYq8r++mROmWRI1xKMXa640Bb//SY1+ECYX6VzT6Lcx5frD0V30XieqJ0oX9I2Xj5aoMA==",
       "dev": true,
       "dependencies": {
         "ajv": "^6.12.4",
@@ -326,21 +326,6 @@
         "node": ">= 8"
       }
     },
-    "node_modules/cross-spawn/node_modules/which": {
-      "version": "2.0.2",
-      "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
-      "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
-      "dev": true,
-      "dependencies": {
-        "isexe": "^2.0.0"
-      },
-      "bin": {
-        "node-which": "bin/node-which"
-      },
-      "engines": {
-        "node": ">= 8"
-      }
-    },
     "node_modules/debug": {
       "version": "4.3.4",
       "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
@@ -470,12 +455,12 @@
       }
     },
     "node_modules/eslint": {
-      "version": "8.30.0",
+      "version": "8.31.0",
-      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.30.0.tgz",
+      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.31.0.tgz",
-      "integrity": "sha512-MGADB39QqYuzEGov+F/qb18r4i7DohCDOfatHaxI2iGlPuC65bwG2gxgO+7DkyL38dRFaRH7RaRAgU6JKL9rMQ==",
+      "integrity": "sha512-0tQQEVdmPZ1UtUKXjX7EMm9BlgJ08G90IhWh0PKDCb3ZLsgAOHI8fYSIzYVZej92zsgq+ft0FGsxhJ3xo2tbuA==",
       "dev": true,
       "dependencies": {
-        "@eslint/eslintrc": "^1.4.0",
+        "@eslint/eslintrc": "^1.4.1",
         "@humanwhocodes/config-array": "^0.11.8",
         "@humanwhocodes/module-importer": "^1.0.1",
         "@nodelib/fs.walk": "^1.2.8",
@@ -770,9 +755,9 @@
       "dev": true
     },
     "node_modules/fastq": {
-      "version": "1.14.0",
+      "version": "1.15.0",
-      "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.14.0.tgz",
+      "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz",
-      "integrity": "sha512-eR2D+V9/ExcbF9ls441yIuN6TI2ED1Y2ZcA5BmMtJsOkWOFRJQ0Jt0g1UwqXJJVAb+V+umH5Dfr8oh4EVP7VVg==",
+      "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==",
       "dev": true,
       "dependencies": {
         "reusify": "^1.0.4"
@@ -1327,9 +1312,9 @@
       "dev": true
     },
     "node_modules/json5": {
-      "version": "1.0.1",
+      "version": "1.0.2",
-      "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz",
+      "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz",
-      "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==",
+      "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==",
       "dev": true,
       "dependencies": {
         "minimist": "^1.2.0"
@@ -1372,6 +1357,18 @@
       "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==",
       "dev": true
     },
+    "node_modules/lru-cache": {
+      "version": "6.0.0",
+      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
+      "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==",
+      "dev": true,
+      "dependencies": {
+        "yallist": "^4.0.0"
+      },
+      "engines": {
+        "node": ">=10"
+      }
+    },
     "node_modules/minimatch": {
       "version": "3.1.2",
       "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
@@ -1498,6 +1495,16 @@
         "node": ">= 0.8.0"
       }
     },
+    "node_modules/optionator/node_modules/word-wrap": {
+      "name": "@aashutoshrathi/word-wrap",
+      "version": "1.2.5",
+      "resolved": "https://registry.npmjs.org/@aashutoshrathi/word-wrap/-/word-wrap-1.2.5.tgz",
+      "integrity": "sha512-plhoNEfSVdHMKXQyAxvH0Zyv3/4NL8r6pwgMQdmHR2vBUXn2t74PN2pBRppqKUa6RMT0yldyvOHG5Dbjwy2mBQ==",
+      "dev": true,
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
     "node_modules/p-limit": {
       "version": "3.1.0",
       "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz",
@@ -1737,12 +1744,18 @@
       }
     },
     "node_modules/semver": {
-      "version": "6.3.0",
+      "version": "7.5.4",
-      "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz",
-      "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
+      "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==",
       "dev": true,
+      "dependencies": {
+        "lru-cache": "^6.0.0"
+      },
       "bin": {
         "semver": "bin/semver.js"
+      },
+      "engines": {
+        "node": ">=10"
       }
     },
     "node_modules/shebang-command": {
@@ -1931,6 +1944,21 @@
         "punycode": "^2.1.0"
       }
     },
+    "node_modules/which": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+      "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+      "dev": true,
+      "dependencies": {
+        "isexe": "^2.0.0"
+      },
+      "bin": {
+        "node-which": "bin/node-which"
+      },
+      "engines": {
+        "node": ">= 8"
+      }
+    },
     "node_modules/which-boxed-primitive": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz",
@@ -1947,21 +1975,18 @@
         "url": "https://github.com/sponsors/ljharb"
       }
     },
-    "node_modules/word-wrap": {
-      "version": "1.2.3",
-      "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz",
-      "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==",
-      "dev": true,
-      "engines": {
-        "node": ">=0.10.0"
-      }
-    },
     "node_modules/wrappy": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
       "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
       "dev": true
     },
+    "node_modules/yallist": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
+      "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==",
+      "dev": true
+    },
     "node_modules/yocto-queue": {
       "version": "0.1.0",
       "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",
@@ -1977,9 +2002,9 @@
   },
   "dependencies": {
     "@eslint/eslintrc": {
-      "version": "1.4.0",
+      "version": "1.4.1",
-      "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.4.0.tgz",
+      "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.4.1.tgz",
-      "integrity": "sha512-7yfvXy6MWLgWSFsLhz5yH3iQ52St8cdUY6FoGieKkRDVxuxmrNuUetIuu6cmjNWwniUHiWXjxCr5tTXDrbYS5A==",
+      "integrity": "sha512-XXrH9Uarn0stsyldqDYq8r++mROmWRI1xKMXa640Bb//SY1+ECYX6VzT6Lcx5frD0V30XieqJ0oX9I2Xj5aoMA==",
       "dev": true,
       "requires": {
         "ajv": "^6.12.4",
@@ -2203,17 +2228,6 @@
         "path-key": "^3.1.0",
         "shebang-command": "^2.0.0",
         "which": "^2.0.1"
-      },
-      "dependencies": {
-        "which": {
-          "version": "2.0.2",
-          "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
-          "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
-          "dev": true,
-          "requires": {
-            "isexe": "^2.0.0"
-          }
-        }
       }
     },
     "debug": {
@@ -2310,12 +2324,12 @@
       "dev": true
     },
     "eslint": {
-      "version": "8.30.0",
+      "version": "8.31.0",
-      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.30.0.tgz",
+      "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.31.0.tgz",
-      "integrity": "sha512-MGADB39QqYuzEGov+F/qb18r4i7DohCDOfatHaxI2iGlPuC65bwG2gxgO+7DkyL38dRFaRH7RaRAgU6JKL9rMQ==",
+      "integrity": "sha512-0tQQEVdmPZ1UtUKXjX7EMm9BlgJ08G90IhWh0PKDCb3ZLsgAOHI8fYSIzYVZej92zsgq+ft0FGsxhJ3xo2tbuA==",
       "dev": true,
       "requires": {
-        "@eslint/eslintrc": "^1.4.0",
+        "@eslint/eslintrc": "^1.4.1",
         "@humanwhocodes/config-array": "^0.11.8",
         "@humanwhocodes/module-importer": "^1.0.1",
         "@nodelib/fs.walk": "^1.2.8",
@@ -2365,7 +2379,7 @@
         "confusing-browser-globals": "^1.0.10",
         "object.assign": "^4.1.2",
         "object.entries": "^1.1.5",
-        "semver": "^6.3.0"
+        "semver": "^7.5.2"
       }
     },
     "eslint-import-resolver-node": {
@@ -2549,9 +2563,9 @@
       "dev": true
     },
     "fastq": {
-      "version": "1.14.0",
+      "version": "1.15.0",
-      "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.14.0.tgz",
+      "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz",
-      "integrity": "sha512-eR2D+V9/ExcbF9ls441yIuN6TI2ED1Y2ZcA5BmMtJsOkWOFRJQ0Jt0g1UwqXJJVAb+V+umH5Dfr8oh4EVP7VVg==",
+      "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==",
       "dev": true,
       "requires": {
         "reusify": "^1.0.4"
@@ -2943,9 +2957,9 @@
       "dev": true
     },
     "json5": {
-      "version": "1.0.1",
+      "version": "1.0.2",
-      "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz",
+      "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz",
-      "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==",
+      "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==",
       "dev": true,
       "requires": {
         "minimist": "^1.2.0"
@@ -2976,6 +2990,15 @@
       "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==",
       "dev": true
     },
+    "lru-cache": {
+      "version": "6.0.0",
+      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
+      "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==",
+      "dev": true,
+      "requires": {
+        "yallist": "^4.0.0"
+      }
+    },
     "minimatch": {
       "version": "3.1.2",
       "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
@@ -3069,7 +3092,15 @@
         "levn": "^0.4.1",
         "prelude-ls": "^1.2.1",
         "type-check": "^0.4.0",
-        "word-wrap": "^1.2.3"
+        "word-wrap": "npm:@aashutoshrathi/word-wrap@1.2.5"
+      },
+      "dependencies": {
+        "word-wrap": {
+          "version": "npm:@aashutoshrathi/word-wrap@1.2.5",
+          "resolved": "https://registry.npmjs.org/@aashutoshrathi/word-wrap/-/word-wrap-1.2.5.tgz",
+          "integrity": "sha512-plhoNEfSVdHMKXQyAxvH0Zyv3/4NL8r6pwgMQdmHR2vBUXn2t74PN2pBRppqKUa6RMT0yldyvOHG5Dbjwy2mBQ==",
+          "dev": true
+        }
       }
     },
     "p-limit": {
@@ -3216,10 +3247,13 @@
       }
     },
     "semver": {
-      "version": "6.3.0",
+      "version": "7.5.4",
-      "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz",
-      "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
+      "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==",
-      "dev": true
+      "dev": true,
+      "requires": {
+        "lru-cache": "^6.0.0"
+      }
     },
     "shebang-command": {
       "version": "2.0.0",
@@ -3359,6 +3393,15 @@
         "punycode": "^2.1.0"
       }
     },
+    "which": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+      "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+      "dev": true,
+      "requires": {
+        "isexe": "^2.0.0"
+      }
+    },
     "which-boxed-primitive": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz",
@@ -3372,18 +3415,18 @@
         "is-symbol": "^1.0.3"
       }
     },
-    "word-wrap": {
-      "version": "1.2.3",
-      "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz",
-      "integrity": "sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==",
-      "dev": true
-    },
     "wrappy": {
       "version": "1.0.2",
       "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
       "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
       "dev": true
     },
+    "yallist": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
+      "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==",
+      "dev": true
+    },
     "yocto-queue": {
       "version": "0.1.0",
       "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@draganfilipovic/ssh-deploy",
-  "version": "3.3.3",
+  "version": "5.1.1",
   "description": "Fast NodeJS action to deploy specific directory from `GITHUB_WORKSPACE` to a server via rsync over ssh.",
   "main": "dist/index.js",
   "files": [
@@ -37,5 +37,9 @@
     "eslint": "^8.30.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.26.0"
+  },
+  "overrides": {
+    "word-wrap": "npm:@aashutoshrathi/word-wrap@1.2.5",
+    "semver": "^7.5.2"
   }
 }

src/helpers.js

@@ -1,4 +1,4 @@
-const { existsSync, mkdirSync, writeFileSync } = require('fs');
+const { existsSync, mkdirSync, writeFileSync, unlink } = require('fs');
 const { join } = require('path');
 
 const validateDir = (dir) => {
@@ -45,6 +45,29 @@ const writeToFile = ({ dir, filename, content, isRequired, mode = '0644' }) => {
   }
 };
 
+const deleteFile = ({ dir, filename, isRequired }) => {
+  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] Deleting ${filePath} file ...`);
+    unlink(filePath, (error) => {
+      if (error) {
+        throw new Error(error);
+      }
+    });
+  } catch (error) {
+    const message = `⚠️[FILE] Deleting file error. filePath: ${filePath}, message:  ${error.message}`;
+    handleError(message, isRequired);
+  }
+};
+
 const validateRequiredInputs = (inputs) => {
   const inputKeys = Object.keys(inputs);
   const validInputs = inputKeys.filter((inputKey) => {
@@ -66,6 +89,7 @@ const snakeToCamel = (str) => str.replace(/[^a-zA-Z0-9]+(.)/g, (m, chr) => chr.t
 
 module.exports = {
   writeToFile,
+  deleteFile,
   validateRequiredInputs,
   snakeToCamel
 };

src/index.js

@@ -10,7 +10,8 @@ const run = async () => {
     source, remoteUser, remoteHost, remotePort,
     deployKeyName, sshPrivateKey,
     args, exclude, sshCmdArgs,
-    scriptBefore, scriptAfter,
+    scriptBefore, scriptBeforeRequired,
+    scriptAfter, scriptAfterRequired,
     rsyncServer
   } = inputs;
   // Validate required inputs
@@ -20,11 +21,11 @@ const run = async () => {
   const { path: privateKeyPath } = getPrivateKeyPath(deployKeyName);
   // Update known hosts if ssh command is present to avoid prompt
   if (scriptBefore || scriptAfter) {
-    updateKnownHosts(remoteHost);
+    updateKnownHosts(remoteHost, remotePort);
   }
   // Check Script before
   if (scriptBefore) {
-    await remoteCmdBefore(scriptBefore, privateKeyPath);
+    await remoteCmdBefore(scriptBefore, privateKeyPath, scriptBeforeRequired);
   }
   /* eslint-disable object-property-newline */
   await sshDeploy({
@@ -33,7 +34,7 @@ const run = async () => {
   });
   // Check script after
   if (scriptAfter) {
-    await remoteCmdAfter(scriptAfter, privateKeyPath);
+    await remoteCmdAfter(scriptAfter, privateKeyPath, scriptAfterRequired);
   }
 };
 

src/inputs.js

@@ -4,18 +4,18 @@ 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'];
+  'SCRIPT_BEFORE', 'SCRIPT_AFTER', 'SCRIPT_BEFORE_REQUIRED', 'SCRIPT_AFTER_REQUIRED'];
 
 const githubWorkspace = process.env.GITHUB_WORKSPACE;
-const remoteUser = process.env.REMOTE_USER;
+const remoteUser = process.env.REMOTE_USER || process.env.INPUT_REMOTE_USER;
 
 const defaultInputs = {
   source: '',
   target: `/home/${remoteUser}/`,
   exclude: '',
-  args: '-rltgoDzvO',
+  args: '-rlgoDzvc -i',
   sshCmdArgs: '-o StrictHostKeyChecking=no',
-  deployKeyName: 'deploy_key'
+  deployKeyName: `deploy_key_${remoteUser}_${Date.now()}`
 };
 
 const inputs = {
@@ -24,16 +24,18 @@ const inputs = {
 
 inputNames.forEach((input) => {
   const inputName = snakeToCamel(input.toLowerCase());
-  const inputVal = process.env[input] || process.env[`INPUT_${input}`];
+  const inputVal = process.env[input] || process.env[`INPUT_${input}`] || defaultInputs[inputName];
   const validVal = inputVal === undefined ? defaultInputs[inputName] : inputVal;
   let extendedVal = validVal;
   // eslint-disable-next-line default-case
   switch (inputName) {
     case 'source':
-      extendedVal = `${githubWorkspace}/${validVal}`;
+      extendedVal = validVal.split(' ').map((src) => `${githubWorkspace}/${src}`);
+      break;
+    case 'args':
+      extendedVal = validVal.split(' ');
       break;
     case 'exclude':
-    case 'args':
     case 'sshCmdArgs':
       extendedVal = validVal.split(',').map((item) => item.trim());
       break;

src/remoteCmd.js

@@ -1,6 +1,7 @@
 const { exec } = require('child_process');
-const { sshServer, githubWorkspace } = require('./inputs');
+const crypto = require('crypto');
-const { writeToFile } = require('./helpers');
+const { sshServer, githubWorkspace, remotePort } = require('./inputs');
+const { writeToFile, deleteFile } = require('./helpers');
 
 const handleError = (message, isRequired, callback) => {
   if (isRequired) {
@@ -12,20 +13,26 @@ const handleError = (message, isRequired, callback) => {
 
 // eslint-disable-next-line max-len
 const remoteCmd = async (content, privateKeyPath, isRequired, label) => new Promise((resolve, reject) => {
-  const filename = `local_ssh_script-${label}.sh`;
+  const uuid = crypto.randomUUID();
+  const filename = `local_ssh_script-${label}-${uuid}.sh`;
   try {
     writeToFile({ dir: githubWorkspace, filename, content });
+    const dataLimit = 10000;
+    const rsyncStdout = (process.env.RSYNC_STDOUT || '').substring(0, dataLimit);
     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}`,
+      `DEBIAN_FRONTEND=noninteractive ssh -p ${(remotePort || 22)} -i ${privateKeyPath} -o StrictHostKeyChecking=no ${sshServer} 'RSYNC_STDOUT="${rsyncStdout}" bash -s' < ${filename}`,
-      (err, data, stderr) => {
+      (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);
+          const limited = data.substring(0, dataLimit);
-          resolve(data);
+          console.log('✅ [CMD] Remote script executed. \n', limited, stderr);
+          deleteFile({ dir: githubWorkspace, filename });
+          console.log('✅ [FILE] Script file deleted.');
+          resolve(limited);
         }
       }
     );

src/rsyncCli.js

@@ -2,6 +2,12 @@ const { execSync } = require('child_process');
 const nodeRsync = require('rsyncwrapper');
 
 const nodeRsyncPromise = async (config) => new Promise((resolve, reject) => {
+  const logCMD = (cmd) => {
+    console.warn('================================================================');
+    console.log(cmd);
+    console.warn('================================================================');
+  };
+
   try {
     nodeRsync(config, (error, stdout, stderr, cmd) => {
       if (error) {
@@ -11,10 +17,12 @@ const nodeRsyncPromise = async (config) => new Promise((resolve, reject) => {
         console.error(stderr);
         console.error('❌️ [Rsync] stdout: ');
         console.error(stdout);
-        console.error('❌ [Rsync] cmd: ', cmd);
+        console.error('❌ [Rsync] command: ');
+        logCMD(cmd);
         reject(new Error(`${error.message}\n\n${stderr}`));
       } else {
-        console.log('⭐ [Rsync] cmd finished: ', cmd);
+        console.log('⭐ [Rsync] command finished: ');
+        logCMD(cmd);
         resolve(stdout);
       }
     });
@@ -47,7 +55,7 @@ const rsyncCli = async ({
   privateKeyPath, args, sshCmdArgs
 }) => {
   console.log(`[Rsync] Starting Rsync Action: ${source} to ${rsyncServer}`);
-  if (exclude) console.log(`[Rsync] excluding folders ${exclude}`);
+  if (exclude && exclude.length > 0) console.log(`[Rsync] excluding folders ${exclude}`);
 
   const defaultOptions = {
     ssh: true,

src/sshKey.js

@@ -1,5 +1,6 @@
 const { join } = require('path');
 const { execSync } = require('child_process');
+const { EOL } = require('os');
 const { writeToFile } = require('./helpers');
 
 const KNOWN_HOSTS = 'known_hosts';
@@ -19,15 +20,15 @@ const addSshKey = (content, deployKeyName) => {
   const { dir, filename } = getPrivateKeyPath(deployKeyName);
   writeToFile({ dir, filename: KNOWN_HOSTS, content: '' });
   console.log('✅ [SSH] known_hosts file ensured', dir);
-  writeToFile({ dir, filename, content, isRequired: true, mode: '0400' });
+  writeToFile({ dir, filename, content: `${content}${EOL}`, isRequired: true, mode: '0400' });
   console.log('✅ [SSH] key added to `.ssh` dir ', dir, filename);
 };
 
-const updateKnownHosts = (host) => {
+const updateKnownHosts = (host, remotePort) => {
   const { knownHostsPath } = getPrivateKeyPath();
   console.log('[SSH] Adding host to `known_hosts` ....', host, knownHostsPath);
   try {
-    execSync(`ssh-keyscan -H ${host}  >> ${knownHostsPath}`, {
+    execSync(`ssh-keyscan -p ${(remotePort || 22)} -H ${host}  >> ${knownHostsPath}`, {
       stdio: 'inherit'
     });
   } catch (error) {

test/Dockerfile

@@ -6,23 +6,32 @@ 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 /var/www/html/test
+RUN mkdir -p /var/www/html/test2
+RUN chmod -R 775 /var/www/html
+
+RUN useradd -rm -d /home/test -s /bin/bash -g root -G sudo -u 1000 test
+RUN usermod -aG sudo test
 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 useradd -rm -d /home/test2 -s /bin/bash -g root -G sudo -u 1002 test2
+RUN usermod -aG sudo test2
+RUN mkdir -p /home/test2/.ssh
+RUN echo "$SSH_PUB_KEY" > /home/test2/.ssh/authorized_keys
+RUN chmod 700 /home/test2/.ssh
+RUN chown -R test2 /home/test2/.ssh
+
 RUN service ssh start
 
 RUN  echo 'test:test' | chpasswd
+RUN  echo 'test2:test2' | chpasswd
 
 EXPOSE 22