Update action

Author: antonmedv

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Anton Medvedev
+Copyright (c) 2021 Anton Medvedev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,29 +2,24 @@
 
 ```yaml
   - name: Deploy
-    uses: deployphp/action@master
+    uses: deployphp/action@1
     with:
       private-key: ${{ secrets.PRIVATE_KEY }}
-      known-hosts: ${{ secrets.KNOWN_HOSTS }}
-      ssh-config: ${{ secrets.SSH_CONFIG }}
-      dep: deploy prod -v
+      dep: deploy all
 ```
 
 ## Inputs
 
-- `private-key` - Required. A private key to accessing servers.
-- `known-hosts` - Optional. Host fingerprints. If omitted `StrictHostKeyChecking=no` will be used unless `ssh-config` is provided.
-- `ssh-config` - Optional. SSH configuration.
-- `dep` - Required. Arguments to pass to Deployer command.
+See [action.yaml](action.yaml).
 
 ## Deployer version
 
-First, the action will check for Deployer bin at those paths:
+First, the action will check for Deployer binary at those paths:
 - `vendor/bin/dep`
-- `bin/dep`
 - `deployer.phar`
 
-If bin not found, phar version will be downloaded. 
+If the binary not found, phar version will be downloaded from 
+[deployer.org](https://deployer.org/download).
 
 ## Example
 

action.yaml

@@ -1,24 +1,42 @@
 name: 'deployphp/action'
+
 description: 'Deploy with Deployer'
+
 inputs:
+
   private-key:
-    description: 'Private key'
     required: true
+    description: >
+      Private key for connecting to remote hosts. To generate private key:
+      `ssh-keygen -o -t rsa -C '[email protected]'`.
+
+  dep:
+    required: true
+    description: >
+      The deployer task to run. For example:
+      `deploy all`.
+
   known-hosts:
-    description: 'Known hosts'
     required: false
     default: ''
+    description: >
+      Content of `~/.ssh/known_hosts` file. The public SSH keys for a
+      host may be obtained using the utility `ssh-keyscan`. For example,
+      `ssh-keyscan deployer.org`.
+
+      If known-hosts omitted, `StrictHostKeyChecking no` will be added to
+      `ssh_config`.
+
   ssh-config:
-    description: 'SSH configuration'
-    required: false
-    default: ''
-  dep:
-    description: 'Deployer command'
     required: false
     default: ''
+    description: >
+      The SSH configuration.
+
 runs:
   using: 'node12'
   main: 'index.js'
+
 branding:
   color: blue
   icon: send

index.js

@@ -1,18 +1,17 @@
 const core = require('@actions/core')
 const fs = require('fs')
 const execa = require('execa')
-const split = require('argv-split')
 
-void function main() {
+void async function main() {
   try {
-    ssh()
-    dep()
+    await ssh()
+    await dep()
   } catch (err) {
     core.setFailed(err.message)
   }
 }()
 
-function ssh() {
+async function ssh() {
   let ssh = `${process.env['HOME']}/.ssh`
 
   if (!fs.existsSync(ssh)) {
@@ -37,14 +36,14 @@ function ssh() {
 
   const sshConfig = core.getInput('ssh-config')
   if (sshConfig !== '') {
-    fs.writeFile(`${ssh}/config`, sshConfig)
+    fs.writeFileSync(`${ssh}/config`, sshConfig)
     fs.chmodSync(`${ssh}/config`, '600')
   }
 }
 
-function dep() {
+async function dep() {
   let dep
-  for (let c of ['vendor/bin/dep', 'bin/dep', 'deployer.phar']) {
+  for (let c of ['vendor/bin/dep', 'deployer.phar']) {
     if (fs.existsSync(c)) {
       dep = c
       break
@@ -54,14 +53,15 @@ function dep() {
   if (!dep) {
     execa.commandSync('curl -LO https://deployer.org/deployer.phar')
     execa.commandSync('sudo chmod +x deployer.phar')
-    dep = './deployer.phar'
+    dep = 'deployer.phar'
   }
 
-  const subprocess = execa(dep, split(core.getInput('dep')))
-
-  subprocess.stdout.pipe(process.stdout);
-
-  subprocess.catch(err => {
+  let p = execa.command(`php ${dep} ${core.getInput('dep')}`)
+  p.stdout.pipe(process.stdout)
+  p.stderr.pipe(process.stderr)
+  try {
+    await p
+  } catch (err) {
     core.setFailed(err.shortMessage)
-  })
+  }
 }