wip: initial code and notes

Author: Greg Bowler

README.md

@@ -1,5 +1,7 @@
-Deploy your application using SSH
-=================================
+Deploy your application to servers or containers
+================================================
+
+> **THIS IS CURRENTLY WORK IN PROGRESS** - once v1 is released there will be no more major changes.
 
 After a successful test run, this action can copy the project's files via SSH to another server, a remote Docker container, or into a fresh server.
 
@@ -31,5 +33,5 @@ jobs:
         with:
           hostname: deploy.example.com
           user: webdeploy
-          copy_to: /var/www/example.com
+          path: /var/www/example.com
 ```

action.yml

@@ -0,0 +1,45 @@
+name: Deploy (php-actions)
+description: Deploy your application to servers or containers
+
+inputs:
+  hostname:
+    description: The hostname of the remote server to SSH to
+    required: true
+
+  port:
+    description: The port of the remote server to SSH to
+    required: true
+    default: "22"
+
+  user:
+    description: The SSH user to use for deployment
+    required: true
+    default: "deploy"
+
+  path:
+    description: Absolute path on the remote server to deploy into
+    required: true
+    default: "/app"
+
+  transfer_path:
+    description: Absolute path on the remote server to use for the transfer
+    required: true
+    default: "/tmp/php-actions--deploy/"
+
+runs:
+  using: "composite"
+  steps:
+    - env:
+        ACTION_TOKEN: ${{ github.token }}
+        ACTION_HOSTNAME: ${{ inputs.hostname }}
+        ACTION_PORT: ${{ inputs.port }}
+        ACTION_USER: ${{ inputs.user }}
+        ACTION_PATH: ${{ inputs.path }}
+        ACTION_TRANSFER_PATH: ${{ inputs.transfer_path }}
+      id: deploy_run
+      run: ${{ github.action_path }}/deploy-action.bash
+      shell: bash
+
+branding:
+  icon: "upload-cloud"
+  color: "purple"

deploy-action.bash

@@ -0,0 +1,15 @@
+#!/bin/bash
+set -e
+full_transfer_path="$ACTION_TRANSFER_PATH/$GITHUB_SHA"
+tar -czf - "$GITHUB_WORKSPACE" | \
+	ssh -p "$ACTION_PORT" "$ACTION_USER"@"$ACTION_HOSTNAME" \
+	"mkdir -p $full_transfer_path && cd $full_transfer_path && tar -xzvf -"
+
+# TODO:
+# This should copy the files to the server.
+# Documentation is needed for getting SSH keys set up as secrets.
+# The transferred directory might be full of crap directories - can tar convert the path to relative to the $GITHUB_WORKSPACE?
+# Once transferred, what's the best way to switch the current $ACTION_PATH with the newly-deployed?
+# It's probable that the newly-created directory, once moved in place, will require symlinks adding to mount points (for external volumes)... how should this be handled?
+# On that same note, there will be certain deploy-specific config files needing putting in place... in real apps this will be a branch name database schema, but we could just put the branch name in the config.development.ini and echo it in PHP to prove that it's working...
+# For dev servers, there needs to be a way to deploy into a container with branch name, and for nginx to automatically know what to do with branchname.dev.example.com