sftp-zip-deploy 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [![Node Version](https://img.shields.io/badge/nodejs-%2026-green.svg?logo=node.js&style=flat)](https://nodejs.org)
4
4
 
5
- Simple and efficient way to auto-deploy your project to a server:
5
+ Fast and efficient way to auto-deploy your project to a server:
6
6
 
7
7
  - It zips your distribution folder and sends the archive to your server via SFTP
8
8
  - It optionally runs remote commands, before / after zip deployment, via SSH2
@@ -22,14 +22,14 @@ npm i sftp-zip-deploy --save-dev
22
22
 
23
23
  In the example below, we deploy a NodeJS project into `/root/web` on our remote server.
24
24
 
25
- Once the zip file is deployed, we run commands to set that folder as active, then unpack
25
+ Once the zip file is deployed, we use `cmd.after` commands to set that folder as active, then unpack
26
26
  the archive and install the project's dependencies.
27
27
 
28
28
  ```ts
29
29
  import {zipAndDeploy} from 'sftp-zip-deploy';
30
30
 
31
31
  await zipAndDeploy({
32
- srcDir: './dist', // folder with content to deploy
32
+ srcDir: './dist', // local folder with content to deploy
33
33
  destDir: '/root/web/', // remote folder to copy our zip file
34
34
  zipFile: {
35
35
  name: 'release.zip', // set custom name for the archive
@@ -62,9 +62,9 @@ The main interface [ISftpZipDeployConfig] has a number of options, including eve
62
62
  * [onFilter] - to let you filter files inside distribution folder
63
63
  * [onCmdOutput] - to get all output from remote commands
64
64
 
65
- [onZipReady]:https://github.com/vitaly-t/sftp-zip-deploy/blob/main/src/config.ts#L67
66
- [onFilter]:https://github.com/vitaly-t/sftp-zip-deploy/blob/main/src/config.ts#L61
67
- [onCmdOutput]:https://github.com/vitaly-t/sftp-zip-deploy/blob/main/src/config.ts#L81
65
+ [onZipReady]:https://github.com/vitaly-t/sftp-zip-deploy/blob/main/src/config.ts#L69
66
+ [onFilter]:https://github.com/vitaly-t/sftp-zip-deploy/blob/main/src/config.ts#L63
67
+ [onCmdOutput]:https://github.com/vitaly-t/sftp-zip-deploy/blob/main/src/config.ts#L86
68
68
 
69
69
  [ISftpZipDeployConfig]:https://github.com/vitaly-t/sftp-zip-deploy/blob/main/src/config.ts#L6
70
70
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sftp-zip-deploy",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "Zip and deploy folder over SFTP",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",