Allow custom pre-script to be run (#88)

* Allow custom pre-script to be run

Author: crohr

.github/workflows/pullpreview.yml

@@ -36,6 +36,8 @@ jobs:
           registries: docker://${{ secrets.GHCR_PAT }}@ghcr.io
           # how long this instance will stay alive (each further commit will reset the timer)
           ttl: 1h
+          # preinstall script to run on the instance before docker-compose is called, relative to the app_path
+          pre_script: ./pre_script.sh
         env:
           AWS_ACCESS_KEY_ID: "${{ secrets.AWS_ACCESS_KEY_ID }}"
           AWS_SECRET_ACCESS_KEY: "${{ secrets.AWS_SECRET_ACCESS_KEY }}"

action.yml

@@ -65,6 +65,10 @@ inputs:
     description: "Names of private registries to authenticate against. E.g. docker://username:password@ghcr.io"
     required: false
     default: ""
+  pre_script:
+    description: "Path to a bash script to run on the instance, before calling docker compose, relative to the app_path"
+    required: false
+    default: ""
   ttl:
     description: "Maximum time to live for deployments (e.g. 10h, 5d, infinite)"
     required: false
@@ -108,6 +112,8 @@ runs:
     - "${{ inputs.deployment_variant }}"
     - "--registries"
     - "${{ inputs.registries }}"
+    - "--pre-script"
+    - "${{ inputs.pre_script }}"
     - "--ttl"
     - "${{ inputs.ttl }}"
   env:

bin/pullpreview

@@ -37,6 +37,7 @@ up_opts = lambda do |o|
   o.array '--tags', 'Tags to add to the instance'
   o.array '--compose-files', 'Compose files to use when running docker-compose up', default: ["docker-compose.yml"]
   o.array '--compose-options', 'Additional options to pass to docker-compose up, comma-separated', default: ["--build"]
+  o.string '--pre-script', 'Path to a bash script to run on the instance, before calling docker compose', default: ""
 end
 
 

examples/wordpress/pre_script.sh

@@ -0,0 +1,3 @@
+echo "Hello from pre_script.sh"
+echo "This is my current env:"
+env | sort

lib/pull_preview/instance.rb

@@ -19,6 +19,7 @@ class Instance
     attr_reader :size
     attr_reader :tags
     attr_reader :access_details
+    attr_reader :pre_script
 
     class << self
       attr_accessor :client
@@ -48,6 +49,7 @@ def initialize(name, opts = {})
       @size = opts[:instance_type]
       @ssh_results = []
       @tags = opts[:tags] || {}
+      @pre_script = opts[:pre_script]
     end
 
     def launch_and_wait_until_ready!
@@ -177,6 +179,10 @@ def setup_prepost_scripts
           logger.warn "Registry ##{index} is invalid: #{e.message}"
         end
       end
+      if pre_script && !pre_script.empty?
+        tmpfile.puts "echo 'Attempting to run pre-script at #{pre_script}...'"
+        tmpfile.puts "bash -e #{pre_script}"
+      end
       tmpfile.flush
       unless scp(tmpfile.path, "/tmp/pre_script.sh", mode: "0755")
         raise Error, "Unable to copy the pre script on instance. Aborting."