Initial commit

Author: Jose Diaz-Gonzalez

Dockerfile

@@ -0,0 +1,6 @@
+FROM alpine:3.12.1
+
+RUN apk --no-cache add git==2.26.2-r0 openssh==8.3_p1-r0 && \
+    mkdir -p ~/.ssh
+
+COPY bin /bin

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Olivier Brassard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,75 @@
+# dokku github-action
+
+Easily deploy an app to your Dokku Instance from GitHub
+
+### Requirements
+
+Please note that this action is compatible with `dokku >= 0.11.6`.
+
+## Inputs
+
+#### `deploy_branch`
+
+Optional. The branch to be deployed when pushing to Dokku (default to `master`). Useful when a [custom deploy branch](http://dokku.viewdocs.io/dokku/deployment/methods/git/#changing-the-deploy-branch) is set on Dokku.
+
+Example Value: `develop`
+
+#### `remote_url`
+
+**Required**. The dokku app's git repository url **(in SSH format)**.
+
+Example Value: `ssh://dokku@dokku.myhost.ca:22/appname`
+
+#### `ssh_key`
+
+**Required**. A private ssh key that has push access to your Dokku instance.
+
+Example Value:
+
+```
+-----BEGIN OPENSSH PRIVATE KEY-----
+MIIEogIBAAKCAQEAjLdCs9kQkimyfOSa8IfXf4gmexWWv6o/IcjmfC6YD9LEC4He
+qPPZtAKoonmd86k8jbrSbNZ/4OBelbYO0pmED90xyFRLlzLr/99ZcBtilQ33MNAh
+...
+SvhOFcCPizxFeuuJGYQhNlxVBWPj1Jl6ni6rBoHmbBhZCPCnhmenlBPVJcnUczyy
+zrrvVLniH+UTjreQkhbFVqLPnL44+LIo30/oQJPISLxMYmZnuwudPN6O6ubyb8MK
+-----END OPENSSH PRIVATE KEY-----
+
+```
+
+> :bulb: Tip : It is recommended to use [Encrypted Secrets](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets) to store sensitive information such as SSH Keys.
+
+## Example usage
+
+This action is particularly useful when triggered by new pushes:
+
+```yml
+name: 'Deploy to my Dokku instance'
+
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Cancel Previous Runs # Optional step
+      uses: styfle/cancel-workflow-action@0.4.0
+      with:
+        access_token: ${{ github.token }}
+
+    - name: Cloning repo # This step is required
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0 # This is required or you will get an error regarding shallow pushes from Dokku
+
+    - name: Push to dokku
+      uses: obrassard/action-dokku-deploy@v1.0.3
+      with:
+        deploy_branch: 'master'
+        remote_url: 'ssh://dokku@dokku.myhost.ca:22/appname'
+        ssh_key: ${{ secrets.SSH_KEY }}
+```

action.yml

@@ -0,0 +1,28 @@
+# action.yml
+name: 'Dokku'
+description: 'Deploys an app via git push to a Dokku instance'
+author: 'Dokku'
+branding:
+  icon: 'upload-cloud'
+  color: 'blue'
+inputs:
+  deploy_branch:
+    description: 'The branch to be deployed when pushing to Dokku (default: master)'
+    required: false
+    default: "master"
+  remote_url:
+    description: "The dokku app's git repository url (in SSH format)"
+    required: true
+  ssh_key:
+    description: 'A private SSH key that has push acces to your Dokku instance'
+    required: true
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  entrypoint: '/bin/entrypoint'
+  post-entrypoint: '/bin/dokku-unlock'
+  post-if: cancelled()
+  env:
+    SSH_PRIVATE_KEY : ${{ inputs.ssh_key }}
+    REMOTE_URL : ${{ inputs.remote_url }}
+    DEPLOY_BRANCH : ${{ inputs.deploy_branch }}

bin/dokku-unlock

@@ -0,0 +1,9 @@
+#!/bin/sh -l
+
+. "/bin/setup-ssh"
+
+echo ""
+log-info "Unlocking Dokku deployment";
+
+app=$(echo $REMOTE_URL | sed -e 's/.*\///')
+ssh -p ${ssh_port:=22} dokku@$ssh_host apps:unlock $app

bin/entrypoint

@@ -0,0 +1,10 @@
+#!/bin/sh -l
+
+. "/bin/setup-ssh"
+
+echo ""
+log-info "Pushing to Dokku Host";
+
+git push $REMOTE_URL $GITHUB_SHA:refs/heads/$DEPLOY_BRANCH --force
+
+[ $? -eq 0 ]  || exit 1

bin/log-info

@@ -0,0 +1,3 @@
+#!/bin/sh -l
+
+echo -e "\u001b[32m${@}\u001b[0m";

bin/setup-ssh

@@ -0,0 +1,13 @@
+#!/bin/sh -l
+
+log-info "Setting up SSH Key"
+
+mkdir -p /root/.ssh
+echo "$SSH_PRIVATE_KEY" | tr -d '\r' > /root/.ssh/id_rsa
+chmod 600 /root/.ssh/id_rsa
+ssh_host=$(echo $REMOTE_URL | sed -e 's/.*@//' -e 's/[:/].*//')
+# Extract port number. Defaults to port 22.
+ssh_port=$(echo $REMOTE_URL | sed -e 's/.*@//' -e 's/\/.*//' -ne 's/.*:\([0-9]*\)/\1/p')
+ssh-keyscan -H -p "${ssh_port:=22}" "$ssh_host" >> /root/.ssh/known_hosts
+eval "$(ssh-agent -s)"
+ssh-add /root/.ssh/id_rsa