Merge pull request #1 from Cyb3r-Jak3/cyb3rjak3/use_ssh_key

Allows for the usage of an ssh key (encrypted or plaintext)

.gitignore

@@ -0,0 +1,95 @@
+# Dependency directory
+# node_modules
+
+# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# OS metadata
+.DS_Store
+Thumbs.db

README.md

@@ -6,14 +6,16 @@ This action uploads an entire directory to your remote SFTP server on push.
 
 _(all default to an empty string)_
 
-| Name      | Required? | Description                                                                     |
-| --------- | --------- | ------------------------------------------------------------------------------- |
-| host      | yes       | SFTP server                                                                     |
-| port      | yes       | SFTP server port                                                                |
-| username  | yes       | SFTP username                                                                   |
-| password  | yes       | SFTP password                                                                   |
-| sourceDir | yes       | Source directory to upload from (will upload all files in this directory)       |
-| targetDir | yes       | Remote directory to upload to (WARNING: overwrites ALL files in this directory) |
+| Name       | Required? | Description                                                                     |
+| ---------- | --------- | ------------------------------------------------------------------------------- |
+| host       | yes       | SFTP server                                                                     |
+| port       | yes       | SFTP server port                                                                |
+| username   | no        | SFTP username                                                                   |
+| password   | no        | SFTP password                                                                   |
+| sourceDir  | yes       | Source directory to upload from (will upload all files in this directory)       |
+| targetDir  | yes       | Remote directory to upload to (WARNING: overwrites ALL files in this directory) |
+| privateKey | no        | SSH key to authenticate with                                                    |
+| passphrase | no        | Passphrase for an encrypted private key                                         |
 
 ## Example usage
 
@@ -24,8 +26,8 @@ with:
     port: 22
     username: root
     password: ${{ secrets.password }}
-    local-dir: ./app/src/
-    server-dir: ./html/
+    sourceDir: ./app/src/
+    targetDir: ./html/
 ```
 
 ## Feature Wishlist

action.yml

@@ -11,12 +11,18 @@ inputs:
     default: '22'
   username:
     description: 'SFTP username'
-    required: true
+    required: false
     default: ''
   password:
     description: 'SFTP password'
-    required: true
+    required: false
     default: ''
+  privateKey:
+    description: "SSH Key"
+    required: false
+  passphrase:
+    description: "Passphrase for encrypted private keys"
+    required: false
   sourceDir:
     description: 'Source directory to upload from (will upload all files in this directory)'
     required: true

index.js

@@ -7,6 +7,8 @@ const username = core.getInput('username')
 const password = core.getInput('password')
 const sourceDir = core.getInput('sourceDir')
 const targetDir = core.getInput('targetDir')
+const privateKey = core.getInput('privateKey')
+const passphrase = core.getInput('passphrase')
 
 core.info(`connecting to ${username}@${host}:${port}...`)
 
@@ -22,6 +24,8 @@ sftp
     port,
     username,
     password,
+    privateKey,
+    passphrase,
     readyTimeout: 5000,
     retries: 5,
   })
@@ -30,7 +34,7 @@ sftp
     return sftp.uploadDir(sourceDir, targetDir)
   })
   .then(() => {
-    core.info(`succesfully uploaded ${sourceDir} to ${targetDir} 🎉`)
+    core.info(`successfully uploaded ${sourceDir} to ${targetDir} 🎉`)
   })
   .catch((error) => {
     core.setFailed(error.message)