Initial commit

Author: ilCollez

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'daily'

README.md

@@ -0,0 +1,88 @@
+# SSH & SCP Deploy
+This GitHub Action lets you deploy your project to a remote server using SSH and SCP. Even though there are many other actions like this, i wanted to create a more customizable one.
+
+## Input Variables
+- `host` - [**REQUIRED**] Remote host
+- `port` -  Remote port. Default: 22
+- `username` - [**REQUIRED**] SSH remote user
+- `password` -  SSH remote password
+- `key` -  SSH private key, can be either a path to a file or the key itself
+- `passphrase` -  SSH key passphrase
+- `files` - [**REQUIRED**] Files and folders to upload. You can use glob patterns.
+- `remote-path` -  Remote destination path
+- `clean` -  Whether to clean the remote path before uploading. Default: false
+- `before-upload` -  Commands to execute before the SCP file transfer, on the host machine
+- `after-upload` -  Commands to execute after the SCP file transfer, on the host machine
+
+## Example Usage
+**NOTE**: For security reasons, it is recommended to store things like passwrds, ssh keys, passphrases etc. in the `Secrets` section of your GitHub repository.
+### Using User & Password
+```yaml
+uses: ilCollez/ssh-scp-deploy@main
+with:
+    host: ${{ secrets.SSH_HOST }} # "example.com"
+    port: ${{ secrets.SSH_PORT }} # 22
+    username: ${{ secrets.SSH_USER }} # "user"
+    password: ${{ secrets.SSH_PASSWORD }} # "password"
+    files: |
+        *.json
+        public
+        dist
+        lib/**/*.js
+    remote-path: "/var/www/html"
+    clean: true
+```
+
+### Using Private Key
+```yaml
+uses: ilCollez/ssh-scp-deploy@main
+with:
+    host: ${{ secrets.SSH_HOST }} # "example.com"
+    port: ${{ secrets.SSH_PORT }} # 22
+    username: ${{ secrets.SSH_USER }} # "user"
+    key: ${{ secrets.SSH_KEY }} # "~/.ssh/id_rsa", can also be the key itself
+    passphrase: ${{ secrets.SSH_PASSPHRASE }} # "passphrase"
+    files: |
+        *.json
+        public
+        dist
+        lib/**/*.js
+    remote-path: "/var/www/html"
+```
+
+### Using pre-upload and post-upload commands
+```yaml
+uses: ilCollez/ssh-scp-deploy@main
+with:
+    host: ${{ secrets.SSH_HOST }} # "example.com"
+    port: ${{ secrets.SSH_PORT }} # 22
+    username: ${{ secrets.SSH_USER }} # "user"
+    key: ${{ secrets.SSH_KEY }} # "~/.ssh/id_rsa", can also be the key itself
+    passphrase: ${{ secrets.SSH_PASSPHRASE }} # "passphrase"
+    files: |
+        *.json
+        public
+        dist
+        lib/**/*.js
+    remote-path: "/var/www/html"
+    clean: true
+    before-upload: |
+        echo "Executed before upload"
+
+        pm2 stop service
+    after-upload: |
+        echo "Executed after upload"
+
+        npm ci --production
+        npm run build
+        npm test
+
+        pm2 start service        
+```
+
+## To Do
+- [ ] Add support for SSH proxy
+- [ ] Add Tests
+
+## License
+This GitHub Action is licensed under the MIT License.

action.yml

@@ -0,0 +1,40 @@
+name: 'SSH-SCP Server Deploy'
+author: 'Collez'
+description: 'Deploys files and executes commands to a remote host'
+
+inputs:
+  host:
+    description: 'Remote host'
+    required: true
+  port:
+    description: 'Remote port'
+    default: 22
+  username:
+    description: 'SSH remote user'
+    required: true
+  password:
+    description: 'SSH remote password'
+  key:
+    description: 'SSH private key, can be either a path to a file or the key itself'
+  passphrase:
+    description: 'SSH key passphrase'
+  files:
+    description: 'Files and folders to upload. You can use glob patterns'
+    required: true
+  remote-path:
+    description: 'Remote destination path'
+  clean:
+    description: 'Whether to clean the remote path before uploading'
+    default: false
+  before-upload:
+    description: 'Commands to execute before the SCP file transfer, on the host machine'
+  after-upload:
+    description: 'Commands to execute after the SCP file transfer, on the host machine'
+
+branding:
+  icon: 'server'
+  color: 'blue'
+
+runs:
+  using: 'node12'
+  main: 'index.js'

index.js

@@ -0,0 +1,76 @@
+const {
+    getInput,
+    getMultilineInput,
+    setFailed,
+    setSecret,
+    getBooleanInput,
+} = require('@actions/core');
+
+const Deployer = require('./lib/Deployer.js');
+
+const deployer = new Deployer();
+
+const fail = (message) => {
+    setFailed(message);
+    deployer.disconnect();
+    process.exit(1);
+};
+
+const password = getInput('password');
+const privateKey = getInput('key');
+const passphrase = getInput('passphrase');
+
+setSecret(password);
+setSecret(privateKey);
+setSecret(passphrase);
+
+if (!password && !privateKey)
+    fail('You must provide either a password or a private key');
+
+(async () => {
+    console.log('🚀 Connecting...');
+
+    await deployer
+        .connect({
+            host: getInput('host', { required: true }),
+            port: parseInt(getInput('port')),
+            username: getInput('username', { required: true }),
+            password,
+            privateKey,
+            passphrase,
+        })
+        .catch(fail);
+
+    console.log('✅ Successfully connected');
+
+    deployer.cwd = getInput('remote-path');
+
+    const beforeUpload = getMultilineInput('before-upload');
+    if (beforeUpload) {
+        console.log('📄 Executing before-upload script...');
+        await deployer.run(beforeUpload).catch(fail);
+        console.log('✅ Successfully executed before-upload');
+    }
+
+    if (getBooleanInput('clean')) {
+        console.log('🗑 Cleaning remote directory...');
+        await deployer.run('rm -rf *').catch(fail);
+        console.log('✅ Successfully cleaned remote path');
+    }
+
+    const files = getMultilineInput('files', { required: true });
+    console.log('📂 Uploading files...');
+    await deployer.upload(files, '.').catch(fail);
+    console.log('✅ Files uploaded successfully');
+
+    const afterUpload = getMultilineInput('after-upload');
+    if (afterUpload) {
+        console.log('📄 Executing after-upload script...');
+        await deployer.run(afterUpload);
+        console.log('✅ Successfully executed after-upload');
+    }
+
+    console.log('🚀 All done! disconnecting...');
+
+    deployer.disconnect();
+})();

lib/Deployer.js

@@ -0,0 +1,47 @@
+const { NodeSSH } = require('node-ssh');
+const fg = require('fast-glob');
+const { join } = require('path');
+
+module.exports = class Deployer {
+    _sshClient = new NodeSSH();
+    cwd = undefined;
+
+    async connect(options) {
+        await this._sshClient.connect(options);
+    }
+
+    async run(command, options) {
+        if (Array.isArray(command)) {
+            command = command.join('&&');
+        }
+
+        await this._sshClient.execCommand(command, {
+            cwd: this.cwd,
+            ...options
+        });
+    }
+
+    async upload(file, remotePath) {
+        const glob = await fg(file, {
+            onlyFiles: false,
+            markDirectories: true
+        });
+        
+        for (const file of glob) {
+            console.log(`📦 Uploading ${file}...`);
+
+            const localPath = join(process.cwd(), file);
+            const remoteFilePath = join(this.cwd || '', remotePath, file);
+
+            if (file.endsWith('/')) {
+                await this._sshClient.putDirectory(localPath, remoteFilePath);
+            } else {
+                await this._sshClient.putFile(localPath, remoteFilePath);
+            }
+        }
+    }
+
+    disconnect() {
+        this._sshClient.dispose();
+    }
+}