action.yml

name: Deploy to WP Engine
description: |
  Deploys files to WP Engine.
  
  It can also, at your option:
  
  - Compile CSS with Grunt or Gulp and commit the changes back to the repository
  - Purge the Cloudflare cache in front of the site

inputs:
  wpengine-ssh-gateway-key-private:
    required: true
    description: |
      The private SSH key that you use to connect to the WPEngine SSH Gateway.
      
      You should pass this in from something like `secrets.WPE_SSHG_KEY_PRIVATE`.

  environment-name:
    required: true
    description: The name of your WP Engine install.

  source-path:
    required: true
    description: |
      The source path to the theme you want to upload.
      
      This will be something like “wp-content/themes/your-child-theme”, or possibly “.”.

  remote-path:
    required: true
    description: |
      The remote destination path of the theme you want to upload.
      
      This will be something like “wp-content/themes/your-child-theme”, or possibly “.”.

  compile-and-commit:
    required: true
    default: false
    description: |
      If true, builds the project with Grunt or Gulp and commits the changes (if any).

  rsync-flags:
    required: true
    default: -azvr --inplace --delete --exclude=".*" --exclude-from=.deployignore
    description: |
      Command-line flags passed to rsync(1).

  cloudflare-purge-urls:
    required: false
    description: |
      A string containing a flow-style list (“'["https://a", "https://b"]'”) of URLs to purge from Cloudflare.
      
      If this input is not specified, no purging will be attempted.

  cloudflare-zone:
    required: false
    description: |
      The Cloudflare zone to purge URLs from.
      
      Frequently `secrets.CLOUDFLARE_ZONE`.
      
      This will need to be set for `cloudflare-purge-urls` to work.

  cloudflare-token:
    required: false
    description: |
      The Cloudflare token used to purge URLs.
      
      Frequently `secrets.CLOUDFLARE_TOKEN`.
      
      This will need to be set for `cloudflare-purge-urls` to work.

runs:
  using: composite

  steps:
    - uses: actions/checkout@v3
    - uses: actions/setup-node@v3
      with:
        node-version: 18

    - name: Compile with Grunt
      uses: elstudio/actions-js-build/build@v4
      if:   inputs.compile-and-commit == 'true' || inputs.compile-and-commit == true

    - name: Commit changes
      uses: elstudio/actions-js-build/commit@v4
      if:   inputs.compile-and-commit == 'true' || inputs.compile-and-commit == true
      with:
        commitMessage: Compile CSS

    - name: Deploy to WP Engine
      uses: wpengine/github-action-wpe-site-deploy@v3.1.1
      with:
        # OpenSSH private keys are multiple lines long and start with “---”.
        # `inputs` passing fails if we use the normal ${{ … }} expansion here. YAML literal style (“|”) fixes this.
        WPE_SSHG_KEY_PRIVATE: |
                              ${{ inputs.wpengine-ssh-gateway-key-private }}
        WPE_ENV:              ${{ inputs.environment-name }}
        SRC_PATH:             ${{ inputs.source-path }}
        REMOTE_PATH:          ${{ inputs.remote-path }}
        PHP_LINT:             true
        FLAGS:                ${{ inputs.rsync-flags }}
        CACHE_CLEAR:          true

    - name: Purge Cloudflare cache
      uses: jakejarvis/cloudflare-purge-action@master
      if:   ${{ join(inputs.cloudflare-purge-urls) != '' }}
      env:
        CLOUDFLARE_ZONE:  ${{ inputs.cloudflare-zone }}
        CLOUDFLARE_TOKEN: ${{ inputs.cloudflare-token }}
        PURGE_URLS:       ${{ inputs.cloudflare-purge-urls }}