release-plugin.yml

name: Deploy the Release

# Deploy when a new release is created in the Main branch
on:
  release:
    # Only deploy when the admin publishes/pre-releases from GitHub
    branches:
      - 'main'
      - 'release/**'
    types: [released, edited]

jobs:
  plugin_tests:
    name: "Plugin tests - PHP"
    defaults:
      run:
        shell: bash
    env:
      # To deploy to the E20R WooCommerce target, set E20R_SSH_SERVER, E20R_SSH_USER, E20R_SSH_PORT,
      # E20R_SSH_KEY, and remove traces of the SVN_* variables
      # To deploy to the wordpress.org repository, set SVN_USERNAME and SVN_PASSWORD,
      # and remove traces of the E20R_SSH_* variables
      E20R_PLUGIN_NAME: e20r-members-list
      GITHUB_TOKEN: ${{ secrets.GITHUB }}
      DOCKER_USER: ${{ secrets.DOCKER_USER }}
      CONTAINER_ACCESS_TOKEN: ${{ secrets.CONTAINER_ACCESS_TOKEN }}
      SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
      SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
    strategy:
      matrix:
        php_version: [ '7.3', '7.4', '8.0', '8.1' ]
    runs-on: ubuntu-18.04
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6.0.1
        with:
          repository: eighty20results/e20r-members-list

      # Extract the branch name for all events except for pull requests
      - name: Extract branch or tag name
        id: branch-name
        uses: tj-actions/branch-names@v9

      - name: Setup PHP with Composer V2+
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php_version }}
          extensions: mbstring, xdebug
          tools: composer:v2
          coverage: pcov

      - name: Login to Docker HUB
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKER_USER }}
          password: ${{ secrets.CONTAINER_ACCESS_TOKEN }}

      - name: Load cached Composer and test related dependencies
        uses: actions/cache@v4
        id: composer-cache
        with:
          key: ${{ runner.os }}-composer-cache-${{ hashFiles('**/composer.lock') }}
          restore-keys: ${{ runner.os }}-composer-cache
          path: inc/**

      - name: Install all needed dependencies for Composer
        if: steps.restore-cache.outputs.cache-hit != 'true'
        run: make composer-dev

      - name: Install all needed WordPress plugin dependencies
        if: steps.composer-cache.outputs.cache-hit != 'true'
        run: make wp-deps

      - name: Install all needed dependencies for Docker
        if: steps.composer-cache.outputs.cache-hit != 'true'
        run: make docker-deps

      - name: Run all Standard Tests
        run: make tests

      - name: Download artifacts
        uses: actions/download-artifact@v6

  # To create the plugin .zip archive
  build_plugin:
    name: Build plugin package to the plugin repository (Our License server or WordPress.org)
    needs: [plugin_tests]
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
    env:
       # To deploy to the E20R WooCommerce target, set E20R_SSH_SERVER, E20R_SSH_USER, E20R_SSH_PORT,
       # E20R_SSH_KEY, and remove traces of the SVN_* variables
       # To deploy to the wordpress.org repository, set SVN_USERNAME and SVN_PASSWORD,
       # and remove traces of the E20R_SSH_* variables
      E20R_PLUGIN_NAME: e20r-members-list
      GITHUB_TOKEN: ${{ secrets.GITHUB }}
      DOCKER_USER: ${{ secrets.DOCKER_USER }}
      CONTAINER_ACCESS_TOKEN: ${{ secrets.CONTAINER_ACCESS_TOKEN }}
      SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
      SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6.0.1
        with:
          repository: eighty20results/e20r-members-list

      - name: Install SSH Key
        if: ${{ env.E20R_SSH_SERVER }}
        uses: shimataro/ssh-key-action@v2
        with:
          key: ${{ secrets.SSH_PRIVATE_KEY }}
          known_hosts: 'just-a-placeholder-so-we-dont-get-errors'

      - name: Adding deployment target to known_hosts file
        if: ${{ env.E20R_SSH_SERVER }}
        run: ssh-keyscan -H -p ${{ secrets.SSH_PORT }} ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts

      - name: "Setup PHP with Composer V2+"
        uses: shivammathur/setup-php@v2
        with:
          php-version: '7.4'
          extensions: mbstring, xdebug
          tools: composer:v2
          coverage: pcov

      - name: Login to Docker HUB
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKER_USER }}
          password: ${{ secrets.CONTAINER_ACCESS_TOKEN }}

      - name: Load cached Composer and test related dependencies
        uses: actions/cache@v4
        id: composer-cache
        with:
          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
          restore-keys: ${{ runner.os }}-composer-cache
          path: inc/

      - name: Install all needed dependencies for Composer
        if: steps.composer-cache.outputs.cache-hit != 'true'
        run: make composer-dev

      - name: Install all needed WordPress plugin dependencies
        if: steps.composer-cache.outputs.cache-hit != 'true'
        run: make wp-deps

      - name: Install all needed dependencies for Docker
        if: steps.composer-cache.outputs.cache-hit != 'true'
        run: make docker-deps

      - name: Cache the built plugin package
        uses: actions/cache@v4
        id: plugin-package-cache
        with:
          key: ${{ runner.os }}-plugin-package-cache-${{ hashFiles('**/build/kits/**.zip') }}
          restore-keys: ${{ runner.os }}-plugin-package-cache
          path: build/kits/**.zip

      - name: Build and test plugin before deployment
        run: make build

  # To push the release to the plugin store
  release:
    name: Deploy package to the plugin repository (Our License server or WordPress.org)
    needs: [plugin_tests, build_plugin]
    runs-on: ubuntu-18.04
    defaults:
      run:
        shell: bash
    env:
      # To deploy to the E20R WooCommerce target, set E20R_SSH_SERVER, E20R_SSH_USER, E20R_SSH_PORT,
      # E20R_SSH_KEY, and remove traces of the SVN_* variables
      # To deploy to the wordpress.org repository, set SVN_USERNAME and SVN_PASSWORD, and remove traces of
      # the E20R_SSH_* variables
      E20R_PLUGIN_NAME: e20r-members-list
      GITHUB_TOKEN: ${{ secrets.GITHUB }}
      DOCKER_USER: ${{ secrets.DOCKER_USER }}
      CONTAINER_ACCESS_TOKEN: ${{ secrets.CONTAINER_ACCESS_TOKEN }}
      SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
      SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6.0.1
        with:
          repository: eighty20results/e20r-members-list

      - run: touch ./.am_on_github

      - name: Install SSH Key
        if: ${{ env.E20R_SSH_SERVER }}
        uses: shimataro/ssh-key-action@v2
        with:
          key: ${{ secrets.SSH_PRIVATE_KEY }}
          known_hosts: 'just-a-placeholder-so-we-dont-get-errors'

      - name: Adding deployment target to known_hosts file
        if: ${{ env.E20R_SSH_SERVER }}
        run: ssh-keyscan -H -p ${{ secrets.SSH_PORT }} ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts

      - name: Login to Docker HUB
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKER_USER }}
          password: ${{ secrets.CONTAINER_ACCESS_TOKEN }}

      - name: Setup PHP with Composer V2+
        uses: shivammathur/setup-php@v2
        with:
          php-version: '7.4'
          extensions: mbstring, xdebug
          tools: composer:v2
          coverage: pcov

      - name: Load cached Composer and test related dependencies (Production)
        uses: actions/cache@v4
        id: composer-cache-prod
        with:
          key: ${{ runner.os }}-composer-cache-prod-${{ hashFiles('**/composer.lock') }}
          restore-keys: ${{ runner.os }}-composer-cache-prod
          path: inc/

      - name: Install all needed dependencies for Composer
        if: steps.composer-cache-prod.outputs.cache-hit != 'true'
        run: make composer-dev

      - name: Install all needed WordPress plugin dependencies
        if: steps.composer-cache-prod.outputs.cache-hit != 'true'
        run: make wp-deps

      - name: Install all needed dependencies for Docker
        if: steps.composer-cache-prod.outputs.cache-hit != 'true'
        run: make docker-deps

      - name: Restore the built plugin package
        id: plugin-package-cache
        uses: actions/cache@v4
        with:
          key: ${{ runner.os }}-plugin-package-cache-${{ hashFiles('**/build/kits/**.zip') }}
          restore-keys: ${{ runner.os }}-plugin-package-cache
          path: build/kits/**.zip

      # Extract the branch name for all events except for pull requests
      - name: Decide whether to run deploy action
        id: branch-name
        uses: tj-actions/branch-names@v9

      - name: Show me the branch
        run: |
          echo "Reference branch is: ${{ steps.branch-name.outputs.ref_branch }}"
          echo "Current branch is: ${{ steps.branch-name.outputs.current_branch }}"
          echo "Tag is: ${{ steps.branch-name.outputs.tag }}"
          echo "Tag state is: '${{ steps.branch-name.outputs.is_tag }}'"

      # And then deploy the package if it exists _and_ we're on the main branch with a release tag

      # The deployment target will depend on whether the
      # E20R_SSH_USER or SVN_USERNAME environment variable is defined
      - name: Deploy plugin when building a release (to WooCommerce Store)
        if: ${{ env.E20R_SSH_SERVER }}
        run: make deploy
        env:
          BRANCH_NAME: ${{ steps.branch-name.outputs.tag }}

      - name: Deploy plugin when building a release (to Wordpress.org repo)
        if: ${{ env.SVN_USERNAME }}
        run: make deploy
        env:
          BRANCH_NAME: ${{ steps.branch-name.outputs.tag }}