Merge pull request #35 from easingthemes/feature/RSYNC-exclude-option

RSYNC use excludeFirst instead of exclude

README.md

@@ -12,46 +12,54 @@ This action would usually follow a build/test action which leaves deployable cod
 
 Pass configuration with `env` vars
 
-1. `SSH_PRIVATE_KEY` [required]
+##### 1. `SSH_PRIVATE_KEY` [required]
 
-This should be the private key part of an ssh key pair.
+Private key part of an SSH key pair.
 The public key part should be added to the `authorized_keys` file on the server that receives the deployment.
 
-The keys should be generated using the PEM format. You can us this command
+More info for SSH keys: https://www.ssh.com/ssh/public-key-authentication
+
+The keys should be generated using the PEM format. You can use this command
 
 ```
 ssh-keygen -m PEM -t rsa -b 4096
 ```
 
-2. `REMOTE_HOST` [required]
+##### 2. `REMOTE_HOST` [required]
 
 eg: mydomain.com
 
-3. `REMOTE_USER` [required]
+##### 3. `REMOTE_USER` [required]
 
 eg: myusername
 
-3. `REMOTE_PORT` (optional, default '22')
+##### 4. `REMOTE_PORT` (optional, default '22')
 
 eg: '59184'
 
-2. `ARGS` (optional, default '-rltgoDzvO')
+##### 5. `ARGS` (optional, default '-rltgoDzvO')
 
 For any initial/required rsync flags, eg: `-avzr --delete`
 
-3. `SOURCE` (optional, default '')
+##### 6. `SOURCE` (optional, default '')
 
 The source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`
 
-4. `TARGET` (optional, default '/home/REMOTE_USER/')
+##### 7. `TARGET` (optional, default '/home/REMOTE_USER/')
 
 The target directory
 
+##### 8. `EXCLUDE` (optional, default '')
+
+path to exclude separated by `,`, ie: `/dist/, /node_modules/`
+
 # Usage
 
+!!! Please use latest version, Readme file is just an example, eg: ssh-deploy@v2.1.5
+
 ```
   - name: Deploy to Staging server
-    uses: easingthemes/ssh-deploy@v2.0.7
+    uses: easingthemes/ssh-deploy@v2.1.5
     env:
       SSH_PRIVATE_KEY: ${{ secrets.SERVER_SSH_KEY }}
       ARGS: "-rltgoDzvO"
@@ -59,6 +67,7 @@ The target directory
       REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
       REMOTE_USER: ${{ secrets.REMOTE_USER }}
       TARGET: ${{ secrets.REMOTE_TARGET }}
+      EXCLUDE: "/dist/, /node_modules/"
 ```
 
 # Example usage in workflow
@@ -84,7 +93,7 @@ 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@v2.1.5
       env:
           SSH_PRIVATE_KEY: ${{ secrets.SERVER_SSH_KEY }}
           ARGS: "-rltgoDzvO --delete"
@@ -92,6 +101,7 @@ jobs:
           REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
           REMOTE_USER: ${{ secrets.REMOTE_USER }}
           TARGET: ${{ secrets.REMOTE_TARGET }}
+          EXCLUDE: "/dist/, /node_modules/"
 ```
 
 ## Disclaimer

action.yml

@@ -23,6 +23,14 @@ inputs:
     description: "Target directory"
     required: false
     default: "/home/REMOTE_USER/"
+  ARGS:
+    description: "Arguments to pass to rsync"
+    required: false
+    default: "-rltgoDzvO"
+  EXCLUDE: 
+    description: "An array of folder to exclude"
+    required: false
+    default: ""
 outputs:
   status:
     description: "Status"

dist/index.js

@@ -551,6 +551,24 @@ module.exports = {
 
 module.exports = require("path");
 
+/***/ }),
+
+/***/ 659:
+/***/ (function(module) {
+
+const inputNames = ['REMOTE_HOST', 'REMOTE_USER', 'REMOTE_PORT', 'SSH_PRIVATE_KEY', 'DEPLOY_KEY_NAME', 'SOURCE', 'TARGET', 'ARGS', 'EXCLUDE'];
+
+const inputs = {
+  GITHUB_WORKSPACE: process.env.GITHUB_WORKSPACE
+};
+// Get inputs from ENV or WITH workflow settings
+inputNames.forEach((input) => {
+  inputs[input] = process.env[input] || process.env[`INPUT_${input}`];
+});
+
+module.exports = inputs;
+
+
 /***/ }),
 
 /***/ 669:
@@ -571,9 +589,9 @@ const { addSshKey } = __webpack_require__(613);
 const {
   REMOTE_HOST, REMOTE_USER,
   REMOTE_PORT, SSH_PRIVATE_KEY, DEPLOY_KEY_NAME,
-  SOURCE, TARGET, ARGS,
+  SOURCE, TARGET, ARGS, EXCLUDE,
   GITHUB_WORKSPACE
-} = process.env;
+} = __webpack_require__(659);
 
 const defaultOptions = {
   ssh: true,
@@ -584,13 +602,14 @@ const defaultOptions = {
 console.log('[general] GITHUB_WORKSPACE: ', GITHUB_WORKSPACE);
 
 const sshDeploy = (() => {
-  const rsync = ({ privateKey, port, src, dest, args }) => {
+  const rsync = ({ privateKey, port, src, dest, args, exclude }) => {
     console.log(`[Rsync] Starting Rsync Action: ${src} to ${dest}`);
+    if (exclude) console.log(`[Rsync] exluding folders ${exclude}`);
 
     try {
       // RSYNC COMMAND
       nodeRsync({
-        src, dest, args, privateKey, port, ...defaultOptions
+        src, dest, args, privateKey, port, excludeFirst: exclude, ...defaultOptions
       }, (error, stdout, stderr, cmd) => {
         if (error) {
           console.error('⚠️ [Rsync] error: ', error.message);
@@ -608,12 +627,12 @@ const sshDeploy = (() => {
     }
   };
 
-  const init = ({ src, dest, args, host = 'localhost', port, username, privateKeyContent }) => {
+  const init = ({ src, dest, args, host = 'localhost', port, username, privateKeyContent, exclude = [] }) => {
     validateRsync(() => {
       const privateKey = addSshKey(privateKeyContent, DEPLOY_KEY_NAME || 'deploy_key');
       const remoteDest = `${username}@${host}:${dest}`;
 
-      rsync({ privateKey, port, src, dest: remoteDest, args });
+      rsync({ privateKey, port, src, dest: remoteDest, args, exclude });
     });
   };
 
@@ -626,13 +645,14 @@ const run = () => {
   validateInputs({ SSH_PRIVATE_KEY, REMOTE_HOST, REMOTE_USER });
 
   sshDeploy.init({
-    src: `${GITHUB_WORKSPACE}/${SOURCE}` || '',
+    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
+    privateKeyContent: SSH_PRIVATE_KEY,
+    exclude: (EXCLUDE || '').split(',').map((item) => item.trim()) // split by comma and trim whitespace
   });
 };
 
@@ -689,7 +709,7 @@ const validateInputs = (inputs) => {
   });
 
   if (validInputs.length !== inputKeys.length) {
-    console.error(`⚠️ [INPUTS] Inputs not valid, aborting ...`);
+    console.error('⚠️ [INPUTS] Inputs not valid, aborting ...');
     process.abort();
   }
 };
@@ -697,7 +717,7 @@ const validateInputs = (inputs) => {
 module.exports = {
   validateRsync,
   validateInputs
-}
+};
 
 
 /***/ }),

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-deploy",
-  "version": "2.1.0",
+  "version": "2.1.5",
   "description": "This GitHub Action deploys specific directory from `GITHUB_WORKSPACE` to a folder on a server via rsync over ssh.",
   "main": "src/index.js",
   "dependencies": {

src/index.js

@@ -7,9 +7,9 @@ const { addSshKey } = require('./sshKey');
 const {
   REMOTE_HOST, REMOTE_USER,
   REMOTE_PORT, SSH_PRIVATE_KEY, DEPLOY_KEY_NAME,
-  SOURCE, TARGET, ARGS,
+  SOURCE, TARGET, ARGS, EXCLUDE,
   GITHUB_WORKSPACE
-} = process.env;
+} = require('./inputs');
 
 const defaultOptions = {
   ssh: true,
@@ -20,13 +20,14 @@ const defaultOptions = {
 console.log('[general] GITHUB_WORKSPACE: ', GITHUB_WORKSPACE);
 
 const sshDeploy = (() => {
-  const rsync = ({ privateKey, port, src, dest, args }) => {
+  const rsync = ({ privateKey, port, src, dest, args, exclude }) => {
     console.log(`[Rsync] Starting Rsync Action: ${src} to ${dest}`);
+    if (exclude) console.log(`[Rsync] exluding folders ${exclude}`);
 
     try {
       // RSYNC COMMAND
       nodeRsync({
-        src, dest, args, privateKey, port, ...defaultOptions
+        src, dest, args, privateKey, port, excludeFirst: exclude, ...defaultOptions
       }, (error, stdout, stderr, cmd) => {
         if (error) {
           console.error('⚠️ [Rsync] error: ', error.message);
@@ -44,12 +45,12 @@ const sshDeploy = (() => {
     }
   };
 
-  const init = ({ src, dest, args, host = 'localhost', port, username, privateKeyContent }) => {
+  const init = ({ src, dest, args, host = 'localhost', port, username, privateKeyContent, exclude = [] }) => {
     validateRsync(() => {
       const privateKey = addSshKey(privateKeyContent, DEPLOY_KEY_NAME || 'deploy_key');
       const remoteDest = `${username}@${host}:${dest}`;
 
-      rsync({ privateKey, port, src, dest: remoteDest, args });
+      rsync({ privateKey, port, src, dest: remoteDest, args, exclude });
     });
   };
 
@@ -62,13 +63,14 @@ const run = () => {
   validateInputs({ SSH_PRIVATE_KEY, REMOTE_HOST, REMOTE_USER });
 
   sshDeploy.init({
-    src: `${GITHUB_WORKSPACE}/${SOURCE}` || '',
+    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
+    privateKeyContent: SSH_PRIVATE_KEY,
+    exclude: (EXCLUDE || '').split(',').map((item) => item.trim()) // split by comma and trim whitespace
   });
 };
 

src/inputs.js

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

src/rsyncCli.js

@@ -35,7 +35,7 @@ const validateInputs = (inputs) => {
   });
 
   if (validInputs.length !== inputKeys.length) {
-    console.error(`⚠️ [INPUTS] Inputs not valid, aborting ...`);
+    console.error('⚠️ [INPUTS] Inputs not valid, aborting ...');
     process.abort();
   }
 };
@@ -43,4 +43,4 @@ const validateInputs = (inputs) => {
 module.exports = {
   validateRsync,
   validateInputs
-}
+};