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

RSYNC use excludeFirst instead of exclude
2024-11-19 08:08:05 +08:00 · 2021-03-24 18:50:40 +01:00 · 2021-03-24 18:48:12 +01:00 · 2021-03-15 09:54:06 +01:00 · 2021-03-12 07:42:12 +01:00 · 2021-03-12 07:26:41 +01:00
8 changed files with 2133 additions and 28 deletions
--- a/README.md
+++ b/README.md
@@ -49,11 +49,17 @@ The source directory, path relative to `$GITHUB_WORKSPACE` root, eg: `dist/`

 The target directory

+##### 8. `EXCLUDE` (optional, default '')
+
+path to exclude separated by `,`, ie: `/dist/, /node_modules/`
+
 # 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"
@@ -61,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
@@ -86,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"
@@ -94,6 +101,7 @@ jobs:
          REMOTE_HOST: ${{ secrets.REMOTE_HOST }}
          REMOTE_USER: ${{ secrets.REMOTE_USER }}
          TARGET: ${{ secrets.REMOTE_TARGET }}
+          EXCLUDE: "/dist/, /node_modules/"
 ```

 ## Disclaimer
--- a/action.yml
+++ b/action.yml
@@ -27,6 +27,10 @@ inputs:
    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"
--- a/dist/index.js
+++ b/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
-}
+};


 /***/ }),
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "ssh-deploy",
-  "version": "2.1.3",
+  "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": {
--- a/src/index.js
+++ b/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
  });
 };

--- a/src/inputs.js
+++ b/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;
--- a/src/rsyncCli.js
+++ b/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
-}
+};
Author	SHA1	Message	Date
Dragan Filipović	9ab3993555	Merge pull request #35 from easingthemes/feature/RSYNC-exclude-option RSYNC use excludeFirst instead of exclude	2021-03-24 18:50:40 +01:00
Dragan Filipovic	07265c8c95	RSYNC use excludeFirst instead of exclude	2021-03-24 18:48:12 +01:00
Dragan Filipović	a27b8667de	Merge pull request #32 from peterkracik/master Exclude folder parameter	2021-03-15 09:54:06 +01:00
Peter Kracik	2b38f7bf7a	Added exclude parameter	2021-03-12 07:42:12 +01:00
Peter Kracik	cd3b869a28	Update action.yml	2021-03-12 07:26:41 +01:00
Dragan Filipovic	191986574c	[DOCS] Readme update	2020-09-18 23:35:33 +02:00
Dragan Filipovic	d41b136666	[BUILD] rebuild	2020-09-18 23:31:43 +02:00
Dragan Filipovic	1ac1bcb558	[VERSION] version bump	2020-09-18 23:31:31 +02:00
Dragan Filipovic	c14eb85faf	[DOCS] Readme update	2020-09-18 23:29:28 +02:00
Dragan Filipovic	2bc5e10d4d	[Formatting] formatting updates	2020-09-18 23:26:31 +02:00
Dragan Filipović	4f928a3efc	Merge pull request #15 from easingthemes/dependabot/npm_and_yarn/lodash-4.17.19 Bump lodash from 4.17.15 to 4.17.19	2020-08-16 22:52:37 +02:00
dependabot[bot]	aac4cbf0db	Bump lodash from 4.17.15 to 4.17.19 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](https://github.com/lodash/lodash/compare/4.17.15...4.17.19) Signed-off-by: dependabot[bot] <support@github.com>	2020-07-21 08:46:30 +00:00
Dragan Filipovic	4042d3876f	[build] update package lock	2020-07-01 01:01:48 +02:00
Dragan Filipovic	68f9da66f0	[version] prepare rc.1	2020-07-01 00:56:10 +02:00
Dragan Filipovic	073bd0b6f6	[build] rebuild	2020-07-01 00:54:42 +02:00
Dragan Filipovic	14eb503e62	[action] get input vars from ENV or WITH workflow settings	2020-07-01 00:54:24 +02:00