deploy-deployer.yml

name: Deploy with Deployer

on:
  workflow_call:
    inputs:
      ENVIRONMENT:
        description: Name of the target environment to load Deployer settings.
        type: string
        required: true
      VERBOSITY:
        description: Deployer command verbosity.
        required: false
        default: 'v'
        type: string
      PHP_VERSION:
        description: PHP version with which the scripts are executed.
        default: '8.2'
        required: false
        type: string
      PHP_TOOLS:
        description: PHP tools supported by shivammathur/setup-php to be installed.
        default: ''
        required: false
        type: string
      PHP_EXTENSIONS:
        description: PHP extensions supported by shivammathur/setup-php to be installed or disabled.
        default: ''
        required: false
        type: string
      NODE_VERSION:
        description: Node.js version to use when npm workspaces are detected.
        default: '22'
        required: false
        type: string
      NPM_REGISTRY_DOMAIN:
        description: Domain of the private npm registry.
        default: https://npm.pkg.github.com/
        required: false
        type: string
      OVPN_GATEWAY_IP:
        description: The IP address of the OpenVPN gateway.
        required: false
        type: string
    secrets:
      COMPOSER_AUTH_JSON:
        description: Authentication for privately hosted packages and repositories as a JSON formatted object.
        required: true
      GITHUB_USER_SSH_KEY:
        description: Private SSH key to be used to reach remote destinations.
        required: true
      DEPLOY_HOSTNAME:
        description: Name of the target host.
        required: false
      DEPLOY_PORT:
        description: SSH port on the target host.
        required: false
      DEPLOY_USER:
        description: SSH user on the target host.
        required: false
      WIREGUARD_CONFIGURATION:
        description: "The full content of the WireGuard configuration file. Deprecated: the support for WireGuard will be removed in the future in favour of OpenVPN."
        required: false
      OVPN_CONFIG:
        description: The full content of the OpenVPN configuration file.
        required: false
      OVPN_USERNAME:
        description: The username to authenticate with the OpenVPN server.
        required: false
      OVPN_PASSWORD:
        description: The password to authenticate with the OpenVPN server.
        required: false
      NPM_REGISTRY_TOKEN:
        description: Authentication for the private npm registry.
        required: false
jobs:
  deploy:
    runs-on: ubuntu-latest
    env:
      COMPOSER_NO_DEV: 1

    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          fetch-depth: 0
          ssh-key: ${{ secrets.GITHUB_USER_SSH_KEY }}

      - name: Set up Git
        uses: inpsyde/reusable-workflows/.github/actions/setup-git@main
        with:
          ssh-private-key: ${{ secrets.GITHUB_USER_SSH_KEY }}

      - name: Set up WireGuard
        uses: inpsyde/actions/setup-wireguard@v1
        env:
          WIREGUARD_CONFIGURATION: ${{ secrets.WIREGUARD_CONFIGURATION }}
        if: ${{ env.WIREGUARD_CONFIGURATION != '' }}
        with:
          wireguard-configuration: ${{ secrets.WIREGUARD_CONFIGURATION }}

      - name: Set up OpenVPN
        uses: inpsyde/reusable-workflows/.github/actions/setup-openvpn@main
        env:
          OVPN_CONFIG: ${{ secrets.OVPN_CONFIG }}
          OVPN_USERNAME: ${{ secrets.OVPN_USERNAME }}
          OVPN_PASSWORD: ${{ secrets.OVPN_PASSWORD }}
          OVPN_GATEWAY_IP: ${{ inputs.OVPN_GATEWAY_IP }}
          WIREGUARD_CONFIGURATION: ${{ secrets.WIREGUARD_CONFIGURATION }}
        if: ${{ env.WIREGUARD_CONFIGURATION == '' && env.OVPN_CONFIG != '' && env.OVPN_USERNAME != '' && env.OVPN_PASSWORD != '' && env.OVPN_GATEWAY_IP != '' }}
        with:
          ovpn-config: ${{ env.OVPN_CONFIG }}
          ovpn-username: ${{ env.OVPN_USERNAME }}
          ovpn-password: ${{ env.OVPN_PASSWORD }}
          ovpn-gateway-ip: ${{ env.OVPN_GATEWAY_IP }}

      - name: Set up PHP
        uses: inpsyde/reusable-workflows/.github/actions/setup-php@main
        with:
          php-version: ${{ inputs.PHP_VERSION }}
          php-extensions: ${{ inputs.PHP_EXTENSIONS }}
          php-tools: 'composer, ${{ inputs.PHP_TOOLS }}'
          composer-options: ''
          composer-auth-json: ${{ secrets.COMPOSER_AUTH_JSON }}

      - name: Detect npm workspaces
        id: npm-workspaces
        run: |
          if [ -f package.json ] && node -e "const p = require('./package.json'); if (!p.workspaces) process.exit(1)"; then
            echo "enabled=true" >> $GITHUB_OUTPUT
          else
            echo "enabled=false" >> $GITHUB_OUTPUT
          fi

      - name: Set up Node
        if: steps.npm-workspaces.outputs.enabled == 'true'
        uses: inpsyde/reusable-workflows/.github/actions/setup-node@main
        with:
          node-version: ${{ inputs.NODE_VERSION }}
          registry-url: ${{ inputs.NPM_REGISTRY_DOMAIN }}
          node-auth-token: ${{ secrets.NPM_REGISTRY_TOKEN }}

      - name: Run the build using workspaces
        if: steps.npm-workspaces.outputs.enabled == 'true'
        run: npm run build -ws --if-present

      - name: Install Deployer
        uses: ramsey/composer-install@v3
        env:
          COMPOSER_AUTH: '${{ secrets.COMPOSER_AUTH_JSON }}'
        with:
          working-directory: ./deployment

      - name: Configure ssh key
        env:
          DEPLOY_HOSTNAME: ${{ secrets.DEPLOY_HOSTNAME }}
          DEPLOY_PORT: ${{ secrets.DEPLOY_PORT }}
        if: ${{ env.DEPLOY_HOSTNAME && env.DEPLOY_PORT }}
        run: |
          mkdir -p ~/.ssh
          ssh-keyscan -p ${{ secrets.DEPLOY_PORT }} ${{ secrets.DEPLOY_HOSTNAME }} >> ~/.ssh/known_hosts

      - name: Run Deployer
        env:
          ENVIRONMENT: ${{ inputs.ENVIRONMENT }}
          DEPLOY_HOSTNAME: ${{ secrets.DEPLOY_HOSTNAME }}
          DEPLOY_PORT: ${{ secrets.DEPLOY_PORT }}
          DEPLOY_USER: ${{ secrets.DEPLOY_USER }}
        run: |
          cd deployment
          ./$(composer config bin-dir)/dep deploy ${{ inputs.ENVIRONMENT }} -${{ inputs.VERBOSITY}}