Add automated deployment using middleman deploy

Author: dennisameling

.github/workflows/ci.yml

@@ -1,20 +1,30 @@
-name: Update live developer docs
+name: Build developer docs (and deploy on push)
 
 on:
   push:
     branches:
       - master
+  pull_request:
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-    - name: update live developer docs using SSH
-      uses: garygrossgarten/github-action-ssh@release
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
       with:
-        command: cd /var/www/developer && git pull && bundle install --quiet && bundle exec middleman build | grep -E '\b(create|delete|error|update)\b'
-        host: ${{ secrets.SSH_HOST }}
-        username: ${{ secrets.SSH_USER }}
-        passphrase: ${{ secrets.SSH_PASSPHRASE }}
-        privateKey: ${{ secrets.SSH_PRIVATE_KEY }}
+        ruby-version: 2.3.1
+        bundler-cache: true
+    - name: install deps
+      run: bundle install
+    - name: build docs
+      run: bundle exec middleman build
+    - name: deploy docs
+      if: ${{ github.event_name == 'push' }}
+      run: bundle exec middleman deploy
+      env:
+        SSH_HOST: ${{ secrets.SSH_HOST }}
+        SSH_DEPLOYMENT_PATH: ${{ secrets.SSH_PATH }}
+        SSH_USER: ${{ secrets.SSH_USER }}
+        SSH_PASSWORD: ${{ secrets.SSH_PASSWORD }}

Gemfile

@@ -12,6 +12,9 @@ gem "middleman-syntax"
 # Plugin for middleman to generate Github pages
 gem 'middleman-gh-pages'
 
+# For deploying to Mautic's live server
+gem 'middleman-deploy', '~> 1.0'
+
 # Live-reloading plugin
 gem "middleman-livereload", "~> 3.3.0"
 
@@ -27,4 +30,4 @@ end
 
 gem "rake", "~> 12.3.3"
 
-gem 'therubyracer', :platforms => :ruby
+gem 'therubyracer', :platforms => :ruby

Gemfile.lock

@@ -72,6 +72,10 @@ GEM
       rack-test (~> 0.6.2)
       thor (>= 0.15.2, < 2.0)
       tilt (~> 1.4.1, < 2.0)
+    middleman-deploy (1.0.0)
+      middleman-core (>= 3.2)
+      net-sftp
+      ptools
     middleman-gh-pages (0.3.1)
       rake (> 0.9.3)
     middleman-livereload (3.3.4)
@@ -88,12 +92,16 @@ GEM
       rouge (~> 1.0)
     minitest (5.9.0)
     multi_json (1.15.0)
+    net-sftp (3.0.0)
+      net-ssh (>= 5.0.0, < 7.0.0)
+    net-ssh (6.1.0)
     padrino-helpers (0.12.8)
       i18n (~> 0.6, >= 0.6.7)
       padrino-support (= 0.12.8)
       tilt (~> 1.4.1)
     padrino-support (0.12.8)
       activesupport (>= 3.1)
+    ptools (1.4.2)
     rack (1.6.13)
     rack-livereload (0.3.16)
       rack
@@ -139,6 +147,7 @@ PLATFORMS
 
 DEPENDENCIES
   middleman (~> 3.3.0)
+  middleman-deploy (~> 1.0)
   middleman-gh-pages
   middleman-livereload (~> 3.3.0)
   middleman-syntax
@@ -150,4 +159,4 @@ DEPENDENCIES
   wdm (~> 0.1.0)
 
 BUNDLED WITH
-   1.11.2
+   1.17.3

config.rb

@@ -35,3 +35,11 @@
   # set :http_prefix, "/Content/images/"
 end
 
+activate :deploy do |deploy|
+  deploy.method   = :sftp
+  deploy.port     = 22
+  deploy.path     = ENV["SSH_DEPLOYMENT_PATH"]
+  deploy.host     = ENV["SSH_HOST"]
+  deploy.user     = ENV["SSH_USER"]
+  deploy.password = ENV["SSH_PASSWORD"]
+end