Compare commits

...

44 commits
v4.1.7 ... main

Author SHA1 Message Date
github-actions
a1aa0b6cf9 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))
2024-07-24 17:04:53 +00:00
Dragan Filipović
f007431332
fix: Update README.md 2024-07-24 19:04:28 +02:00
github-actions
ece05a2275 chore(release): 5.1.0 [skip ci]
# [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](1befdb1c6b))
* apply deleteFile function to remoteCmd ([b82eced](b82eced457))
2024-07-24 16:55:35 +00:00
Dragan Filipović
b99511bf85
Merge pull request #184 from Armadillidiid/feat/delete-script-after-exec
Feature: Delete Script After Execution
2024-07-24 18:55:06 +02:00
Emmanuel Isenah
b82eced457 feat: apply deleteFile function to remoteCmd 2024-03-17 22:21:09 +01:00
Emmanuel Isenah
1befdb1c6b feat: Add deleteFile function to helpers module 2024-03-17 22:19:34 +01:00
github-actions
01a39e3348 chore(release): 5.0.3 [skip ci]
## [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](4d8bbf0deb))
2024-02-27 08:58:54 +00:00
Dragan Filipović
f517598798
Merge pull request #180 from alekw/main
fix: Update actions to Node.js 20
2024-02-27 09:58:22 +01:00
Aleksander Wolak
4d8bbf0deb fix: trigger automated release 2024-02-26 23:55:50 +01:00
Aleksander Wolak
428f2b152b fix own action version 2024-02-26 23:48:33 +01:00
github-actions
8c3965fd5f chore(release): 5.0.2 [skip ci]
## [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](bb271fe4c6))
* Fix default values used incorrectly. ([a1b383f](a1b383f560))
2024-02-18 17:44:58 +00:00
Dragan Filipović
186d0277e9
Merge pull request #178 from skyArony/fix-#177
fix: added the missing declarations #177
2024-02-18 18:44:30 +01:00
skyArony
a1b383f560 fix: Fix default values used incorrectly. 2024-02-18 22:43:02 +08:00
Aleksander Wolak
d42d2576ab further fixes 2024-02-16 01:06:08 +01:00
Aleksander Wolak
bed42ef321 further fixes 2024-02-16 00:56:27 +01:00
Aleksander Wolak
07d369f5c8 update well known actions 2024-02-16 00:53:05 +01:00
skyArony
bb271fe4c6 fix: added the missing declarations #177 2024-02-02 16:31:41 +08:00
github-actions
3b7118ee8b chore(release): 5.0.1 [skip ci]
## [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](845b578606))
2024-01-31 01:00:14 +00:00
Dragan Filipović
845b578606
fix: Add info for Permission denied issue. 2024-01-31 01:59:36 +01:00
Dragan Filipović
725ce37b9f
Update stale to 90 days 2024-01-18 21:46:42 +01:00
github-actions
16bb35ed0b chore(release): 5.0.0 [skip ci]
# [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](ac1908e5d2)), closes [#173](https://github.com/easingthemes/ssh-deploy/issues/173)

### BREAKING CHANGES

* update to use nodeJS v20
* update to use nodeJS v20
2023-12-12 21:29:39 +00:00
Dragan Filipović
ac1908e5d2
Merge pull request #173 from jeromelachaud/main
BREAKING CHANGE: update to use nodeJS v20

BREAKING CHANGE: update to use nodeJS v20
2023-12-12 22:29:07 +01:00
Jerome Lachaud
d77e3dfdc8 BREAKING CHANGE: update to use nodeJS v20 2023-10-25 13:19:20 +00:00
github-actions
aa1c48118d chore(release): 4.1.10 [skip ci]
## [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](3f5d9aab1a))
2023-09-30 15:13:25 +00:00
Dragan Filipović
448aa45aa1
Merge pull request #156 from mansandersson/fix-key-line-endings
Normalize line endings in SSH key for the underlying OS
2023-09-30 17:12:46 +02:00
Måns Andersson
3f5d9aab1a fix: normalize line endings in SSH key for the underlying OS 2023-09-28 20:05:00 +02:00
github-actions
2942523001 chore(release): 4.1.9 [skip ci]
## [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](627ac29ece))
* add uuid for ssh scripts ([66f6e4b](66f6e4b367))
2023-09-24 15:37:24 +00:00
Dragan Filipović
ef20db4468
Merge pull request #167 from easingthemes/feature/#131-use-unique-file-name-for-scripts
fix: add uuid for ssh scripts
2023-09-24 17:36:52 +02:00
Dragan Filipovic
627ac29ece fix: add compiled file 2023-09-24 17:35:00 +02:00
Dragan Filipovic
66f6e4b367 fix: add uuid for ssh scripts 2023-09-24 17:29:49 +02:00
Dragan Filipović
d91ea7e0f7
Merge pull request #144 from shoshins/70-no-private-key-password-option
#70 - There is no Password option for Rsync SSH. Documentation is up…
2023-09-24 17:16:11 +02:00
Dragan Filipović
28d946e487
Merge pull request #154 from olivertappin/main
Correct typo in README.md
2023-09-24 16:58:48 +02:00
Dragan Filipović
3ab5951ec1
Merge pull request #141 from dbryan0516/remote-cmd-error
Added SCRIPT_BEFORE_REQUIRED and SCRIPT_AFTER_REQUIRED flags
2023-09-24 16:58:09 +02:00
Dragan Filipović
cf583aab4f
Merge pull request #153 from Triloworld/patch-2
Update README.md
2023-08-03 19:18:58 +02:00
Oliver Tappin
8ba86462c0
Correct typo in README.md 2023-06-28 20:36:01 +01:00
Patryk Padus
e7f0312c8c
Update README.md
In reference of this issue and comment: https://github.com/easingthemes/ssh-deploy/issues/149
2023-06-23 14:52:23 +02:00
Sergey Shoshin
35ccd2ccc4 #70 - There is no Password option for Rsync SSH. Documentation is updated 2023-04-25 18:11:13 +04:00
Dylan Bryan
ed53b09c84 Added build file 2023-04-18 17:33:08 -04:00
Dylan Bryan
f9797b28d5 Added SCRIPT_BEFORE_REQUIRED and SCRIPT_AFTER_REQUIRED flags for error throwing on remote cmd errors 2023-04-18 17:24:01 -04:00
github-actions
3884c8554f chore(release): 4.1.8 [skip ci]
## [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](98025d680e))
2023-02-21 22:13:02 +00:00
Dragan Filipović
168ff9f4b8
Merge pull request #124 from easingthemes/bugfix/rebuild
fix: rebuild and update readme
2023-02-21 23:12:21 +01:00
Dragan Filipovic
98025d680e fix: rebuild and update readme 2023-02-21 23:11:54 +01:00
Dragan Filipović
88cc5ade97
Merge pull request #123 from sdelfi/fix/update-dist
chore: build dist
2023-02-21 23:06:19 +01:00
Stanislav Salnikov
ad7eefb5ae chore: build dist 2023-02-21 23:03:40 +01:00
18 changed files with 238 additions and 66 deletions

View file

@ -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

View file

@ -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

View file

@ -27,7 +27,7 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
# ----------------------------------------------------------------
# START E2E Test Specific - steps

View file

@ -15,7 +15,7 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
# : ---------------------------------------------------------------
# : START E2E Test Specific - steps
@ -111,7 +111,7 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
# : ---------------------------------------------------------------
# : START E2E Test Specific - steps
@ -169,7 +169,7 @@ jobs:
# ----------------------------------------------------------------
- name: e2e Test ssh-deploy action - Target 1
uses: easingthemes/ssh-deploy@v3
uses: easingthemes/ssh-deploy@main
env:
# Shared ENV Vars created in previous steps
REMOTE_USER: ${{ env.TEST_USER }}

View file

@ -49,9 +49,9 @@ jobs:
steps:
- name: Checkout repo
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: Commit trigger
@ -64,7 +64,7 @@ jobs:
- name: Run Tests
run: npm test --if-present
- name: Create a release - ${{ github.event.inputs.version }}
uses: cycjimmy/semantic-release-action@v3
uses: cycjimmy/semantic-release-action@v4
with:
dry_run: ${{ github.event.inputs.dryRun == 'true' }}
extra_plugins: |

View file

@ -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: |

View file

@ -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-close: 5
days-before-stale: 90
days-before-close: 15
stale-issue-label: 'stale'

View file

@ -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]
@ -65,25 +67,33 @@ Execution is preformed by storing commands in `.sh` file and executing it via `.
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: "-rlgoDzvc -i"
SOURCE: "dist/"
@ -113,18 +123,18 @@ 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: "-rlgoDzvc -i --delete"
SOURCE: "dist/"
@ -142,13 +152,18 @@ 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

View file

@ -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"

2
dist/index.js vendored

File diff suppressed because one or more lines are too long

View file

@ -1,3 +1,73 @@
## [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)

97
package-lock.json generated
View file

@ -1,12 +1,12 @@
{
"name": "@draganfilipovic/ssh-deploy",
"version": "4.0.5",
"version": "4.1.10",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@draganfilipovic/ssh-deploy",
"version": "4.0.5",
"version": "4.1.10",
"license": "MIT",
"dependencies": {
"rsyncwrapper": "^3.0.1"
@ -1357,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",
@ -1483,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",
@ -1722,12 +1744,18 @@
}
},
"node_modules/semver": {
"version": "6.3.0",
"resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
"integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
"version": "7.5.4",
"resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz",
"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": {
@ -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",
@ -2354,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": {
@ -2965,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",
@ -3058,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": {
@ -3205,10 +3247,13 @@
}
},
"semver": {
"version": "6.3.0",
"resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
"integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
"dev": true
"version": "7.5.4",
"resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz",
"integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==",
"dev": true,
"requires": {
"lru-cache": "^6.0.0"
}
},
"shebang-command": {
"version": "2.0.0",
@ -3370,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",

View file

@ -1,6 +1,6 @@
{
"name": "@draganfilipovic/ssh-deploy",
"version": "4.1.7",
"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"
}
}

View file

@ -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
};

View file

@ -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
@ -24,7 +25,7 @@ const run = async () => {
}
// 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);
}
};

View file

@ -4,7 +4,7 @@ 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 || process.env.INPUT_REMOTE_USER;

View file

@ -1,6 +1,7 @@
const { exec } = require('child_process');
const crypto = require('crypto');
const { sshServer, githubWorkspace, remotePort } = require('./inputs');
const { writeToFile } = require('./helpers');
const { writeToFile, deleteFile } = require('./helpers');
const handleError = (message, isRequired, callback) => {
if (isRequired) {
@ -12,7 +13,8 @@ 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;
@ -28,6 +30,8 @@ const remoteCmd = async (content, privateKeyPath, isRequired, label) => new Prom
} else {
const limited = data.substring(0, dataLimit);
console.log('✅ [CMD] Remote script executed. \n', limited, stderr);
deleteFile({ dir: githubWorkspace, filename });
console.log('✅ [FILE] Script file deleted.');
resolve(limited);
}
}

View file

@ -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,7 +20,7 @@ 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: `${content}\r\n`, isRequired: true, mode: '0400' });
writeToFile({ dir, filename, content: `${content}${EOL}`, isRequired: true, mode: '0400' });
console.log('✅ [SSH] key added to `.ssh` dir ', dir, filename);
};