Create site.preview.yml.example

Author: jonpugh

.github/workflows/site.preview.yml.example

@@ -0,0 +1,81 @@
+#
+# site.preview.yml
+# 
+# Launch and test preview sites for each pull request.
+#
+# Requires a runner on a persistant server.
+#
+name: Preview Site
+on:
+  pull_request:
+
+# Cancel jobs if another push is received.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}
+  cancel-in-progress: false
+
+jobs:
+  
+  # Installs DDEV, clones code, starts the site.
+  create-site:
+    name: Create Preview Site
+    uses: operations-project/github-action-ddev-runner/.github/workflows/operations.site.deploy.ddev.yml@feature/reusable-workflows
+    with:
+
+      # Where to install your site.
+      git_root: /home/runner/Sites/${{ github.repository }}/pr${{ github.event.number }}
+
+      # Project name for this instance. Used to generate the domain name.
+      ddev_project_name: yourproject.pr${{ github.event.number }}
+
+      # Top-level domain. Sites are hosted as subdomains under this.
+      ddev_project_tld: preview.yourproject.com
+
+      # Tell the remote workflow what to run on.
+      github_runs_on: self-hosted
+
+      # Define the github environment name, to be displayed in the UI.
+      github_environment_name: pr${{ github.event.number }}
+
+      # Define a github environment url, a link to be shown on the pull request.
+      github_environment_url: http://yourproject.pr${{ github.event.number }}.preview.yourproject.com
+
+      # To persist a site's data, set "run_prepare_command" to false.
+      run_prepare_command: true
+
+      # Prepare the site's data. Run your sync/import/install script.
+      prepare_command: ddev drush site:install
+
+      # Command to run after deploying code changes
+      deploy_command: ddev drush updb
+
+      # Additional ddev config to apply to the environment.
+      # Will be saved to .ddev/config.zzz.runner.yaml
+      # See your project's .ddev/config.yaml file for examples.
+      ddev_config: |
+        additional_fqdns:
+          - admin.pr${{ github.event.number }}.preview.yourproject.com
+
+  run-command:
+    name: DDEV Status
+    uses: operations-project/github-action-ddev-runner/.github/workflows/operations.site.command.yml@feature/reusable-workflows
+    needs: create-site
+    with:
+      working_directory: /home/runner/Sites/${{ github.repository }}/pr${{ github.event.number }}
+      github_runs_on: self-hosted
+      command: |
+        ddev status
+
+  test-site:
+    name: Run tests
+    needs: run-command
+    runs-on: self-hosted
+    steps:
+      - uses: jonpugh/goatscripts@main
+      - name: Check homepage
+        env:
+          SUCCESS: "Tests pass. :check:"
+          ERROR: "TESTS FAILED! :x:"
+        run: |
+          run-with-summary curl http://pr${{ github.event.number }}.sites.thinkdrop.net
+          curl -s http://yourproject.pr${{ github.event.number }}.preview.yourproject.com | grep "Hello World!"