Additional tools for plugin archives: php-scoper, rector

.github/workflows/build-plugin-archive.yml

@@ -24,15 +24,20 @@ on:
         required: false
         type: string
       COMPOSER_ARGS:
-        description: Set of arguments passed to Composer.
-        default: '--no-dev --no-scripts --prefer-dist --optimize-autoloader'
+        description: Set of arguments passed to Composer when gathering production dependencies.
+        default: '--no-dev --prefer-dist --optimize-autoloader'
         required: false
         type: string
       PHP_VERSION:
-        description: PHP version to use during packaging.
+        description: PHP version to use when gathering production dependencies.
         default: "8.0"
         required: false
         type: string
+      PHP_VERSION_BUILD:
+        description: PHP version to use when executing build tools.
+        default: "8.2"
+        required: false
+        type: string
       ARCHIVE_NAME:
         description: The name of the zip archive (falls back to the repository name).
         default: ''
@@ -78,18 +83,12 @@ on:
         value: ${{ jobs.create-plugin-archive.outputs.artifact }}
 
 jobs:
-  create-plugin-archive:
+  checkout-dependencies:
+    name: Install production dependencies
     timeout-minutes: 5
     runs-on: ubuntu-latest
     env:
-      NODE_OPTIONS: ${{ inputs.NODE_OPTIONS }}
-      NODE_AUTH_TOKEN: ${{ secrets.NPM_REGISTRY_TOKEN }}
-      NODE_CACHE_MODE: ''
-      ARCHIVE_NAME: ${{ inputs.ARCHIVE_NAME }}
-      PLUGIN_FOLDER_NAME: ${{ inputs.PLUGIN_FOLDER_NAME }}
       ENV_VARS: ${{ secrets.ENV_VARS }}
-      GIT_SHA: ${{ github.sha }}
-      PLUGIN_VERSION: ${{ inputs.PLUGIN_VERSION }}
       COMPOSER_AUTH: '${{ secrets.COMPOSER_AUTH_JSON }}'
       # Disables symlinking of local path repositories.
       # During development, symlinking is preferable.
@@ -101,14 +100,6 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Set up archive name
-        id: plugin-data
-        run: echo "archive-name=${ARCHIVE_NAME:-${{ github.event.repository.name }}}" >> $GITHUB_OUTPUT
-
-      - name: Set up plugin folder name
-        id: plugin-folder-name
-        run: echo "plugin-folder-name=${PLUGIN_FOLDER_NAME:-${ARCHIVE_NAME:-${{ github.event.repository.name }}}}" >> $GITHUB_OUTPUT
-
       - name: Set up custom environment variables
         if: ${{ env.ENV_VARS }}
         uses: actions/github-script@v7
@@ -118,82 +109,174 @@ jobs:
               .parse(process.env.ENV_VARS)
               .forEach(envVar => core.exportVariable(envVar.name, envVar.value));
 
-      - name: Set up node cache mode
-        run: |
-          if [ "${{ inputs.PACKAGE_MANAGER }}" == 'npm' ] && { [ -f "${GITHUB_WORKSPACE}/package-lock.json" ] || [ -f "${GITHUB_WORKSPACE}/npm-shrinkwrap.json" ]; }; then
-            echo "NODE_CACHE_MODE=npm" >> $GITHUB_ENV
-          elif [ "${{ inputs.PACKAGE_MANAGER }}" == 'yarn' ] && [ -f "${GITHUB_WORKSPACE}/yarn.lock" ]; then
-            echo "NODE_CACHE_MODE=yarn" >> $GITHUB_ENV
-          else
-            echo "No lock files found or unknown package manager"
-          fi
-
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ inputs.PHP_VERSION }}
           tools: wp-cli
 
-      - name: Install Composer dependencies
-        # ⬑ The idea is to ensure we have non-production tools like Composer Asset Compiler and WordPress Translation Downloader available
+      - name: Install Composer dependencies without dev dependencies
         uses: ramsey/composer-install@v3
         with:
-          composer-options: --prefer-dist
+          composer-options: ${{ inputs.COMPOSER_ARGS }}
+
+      - name: Set artifact name
+        id: set-artifact-name
+        run: echo "artifact=interim-deps" >> $GITHUB_OUTPUT
 
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.set-artifact-name.outputs.artifact }}
+          path: |
+            ./*
+            !./.git
+            !./.ddev
+            !./.github
+  run-build-tools:
+    name: Process build steps
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    needs: checkout-dependencies
+    env:
+      NODE_OPTIONS: ${{ inputs.NODE_OPTIONS }}
+      NODE_AUTH_TOKEN: ${{ secrets.NPM_REGISTRY_TOKEN }}
+      NODE_CACHE_MODE: ''
+    outputs:
+      artifact: ${{ steps.set-artifact-name.outputs.artifact }}
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ needs.checkout-dependencies.outputs.artifact }}
+      - name: Setup PHP with tools
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ inputs.PHP_VERSION_BUILD }}
+          tools: humbug/php-scoper:dev-main
       - name: Check optional Composer build tools
         id: composer-tools
         run: |
-          hasDep(){
-            composer show -i -N -D --strict "${1}" >/dev/null 2>&1
+          hasAssetConfig(){
+            test -f assets-compiler.json
+            local EXIT=$?
+            if [ ! $EXIT ]; then
+              echo "$EXIT"
+              exit 0
+            fi
+            jq '.extra | has("composer-asset-compiler")' < composer.json >/dev/null 2>&1
+            local EXIT=$?
+            echo "$EXIT"
+          }
+          hasTranslateConfig(){
+            jq '.extra | has("wp-translation-downloader")' < composer.json >/dev/null 2>&1
+            local EXIT=$?
+            echo "$EXIT"
+          }
+          hasScoperConfig(){
+            test -f scoper.inc.php
             local EXIT=$?
             echo "$EXIT"
           }
-          echo "assets-compiler=$( hasDep inpsyde/composer-assets-compiler )" >> $GITHUB_OUTPUT
-          echo "translation-downloader=$( hasDep inpsyde/wp-translation-downloader )" >> $GITHUB_OUTPUT
+          echo "assets-compiler=$( hasAssetConfig )" >> $GITHUB_OUTPUT
+          echo "translation-downloader=$( hasTranslateConfig )" >> $GITHUB_OUTPUT
+          echo "php-scoper=$( hasScoperConfig )" >> $GITHUB_OUTPUT
 
-      - name: Check for package.json
-        id: check-for-package
+      - name: Set up node cache mode
         run: |
-          if [ -f package.json ]; then
-            echo "has_package=true" >> $GITHUB_OUTPUT
+          if [ "${{ inputs.PACKAGE_MANAGER }}" == 'npm' ] && { [ -f "${GITHUB_WORKSPACE}/package-lock.json" ] || [ -f "${GITHUB_WORKSPACE}/npm-shrinkwrap.json" ]; }; then
+            echo "NODE_CACHE_MODE=npm" >> $GITHUB_ENV
+          elif [ "${{ inputs.PACKAGE_MANAGER }}" == 'yarn' ] && [ -f "${GITHUB_WORKSPACE}/yarn.lock" ]; then
+            echo "NODE_CACHE_MODE=yarn" >> $GITHUB_ENV
           else
-            echo "has_package=false" >> $GITHUB_OUTPUT
+            echo "No lock files found or unknown package manager"
           fi
 
       - name: Set up node
-        if: steps.check-for-package.outputs.has_package == 'true'
+        if: steps.composer-tools.outputs.assets-compiler == '0'
         uses: actions/setup-node@v4
         with:
           node-version: ${{ inputs.NODE_VERSION }}
           registry-url: ${{ inputs.NPM_REGISTRY_DOMAIN }}
           cache: ${{ env.NODE_CACHE_MODE }}
 
-      - name: Run Composer Asset Compiler
-        if: steps.composer-tools.outputs.assets-compiler == '0' && steps.check-for-package.outputs.has_package == 'true'
-        run: composer compile-assets ${{ inputs.COMPILE_ASSETS_ARGS }}
+      - name: Install and run Composer Asset Compiler
+        if: steps.composer-tools.outputs.assets-compiler == '0'
+        run: |
+          composer global config --no-plugins --no-interaction allow-plugins.inpsyde/composer-assets-compiler true
+          composer global require inpsyde/composer-assets-compiler
+          composer compile-assets ${{ inputs.COMPILE_ASSETS_ARGS }}
 
-      - name: Run WordPress Translation Downloader
+      - name: Install and run WordPress Translation Downloader
         if: steps.composer-tools.outputs.translation-downloader == '0'
-        run: composer wp-translation-downloader:download
+        run: |
+          composer global config --no-plugins --no-interaction allow-plugins.composer/installers true
+          composer global config --no-plugins --no-interaction allow-plugins.inpsyde/wp-translation-downloader true
+          composer global require inpsyde/wp-translation-downloader
+          composer wp-translation-downloader:download
 
-      - name: Install Composer dependencies without dev dependencies
-        # ⬑ Now we want to get rid of dev dependencies and most probably skip composer scripts
-        uses: ramsey/composer-install@v3
+      - name: Run PHP Scoper
+        if: steps.composer-tools.outputs.php-scoper == '0'
+        run: |
+          php-scoper add-prefix --force --output-dir build
+          composer --working-dir=build dump-autoload -o
+          sed -i "s/'__composer_autoload_files'/\'__composer_autoload_files_${{ github.sha }}'/g" "build/vendor/composer/autoload_real.php"
+      - name: Move unchanged code to build directory
+        if: steps.composer-tools.outputs.php-scoper != '0'
+        run: mv * build 2>/dev/null
+
+      - name: Set artifact name
+        id: set-artifact-name
+        run: echo "artifact=interim-built" >> $GITHUB_OUTPUT
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
         with:
-          composer-options: ${{ inputs.COMPOSER_ARGS }}
+          name: ${{ steps.set-artifact-name.outputs.artifact }}
+          path: |
+            build/
+            !build/**/node_modules
+  create-plugin-archive:
+    name: Create build archive
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    needs: run-build-tools
+    env:
+      ARCHIVE_NAME: ${{ inputs.ARCHIVE_NAME }}
+      PLUGIN_FOLDER_NAME: ${{ inputs.PLUGIN_FOLDER_NAME }}
+      GIT_SHA: ${{ github.sha }}
+      PLUGIN_VERSION: ${{ inputs.PLUGIN_VERSION }}
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ needs.run-build-tools.outputs.artifact }}
+
+      - name: Set up plugin folder name
+        id: plugin-folder-name
+        run: echo "plugin-folder-name=${PLUGIN_FOLDER_NAME:-${ARCHIVE_NAME:-${{ github.event.repository.name }}}}" >> $GITHUB_OUTPUT
+
+      - name: Set up archive name
+        id: plugin-data
+        run: echo "archive-name=${ARCHIVE_NAME:-${{ github.event.repository.name }}}" >> $GITHUB_OUTPUT
 
       - name: Add commit hash to plugin header
         run: 'sed -Ei "s/SHA: .*/SHA: ${GIT_SHA}/g" ${{ inputs.PLUGIN_MAIN_FILE }}'
 
       - name: Set plugin version header
         run: 'sed -Ei "s/Version: .*/Version: ${PLUGIN_VERSION}/g" ${{ inputs.PLUGIN_MAIN_FILE }}'
 
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ inputs.PHP_VERSION_BUILD }}
+          tools: wp-cli
+
       - name: Install dist-archive command
         run: wp package install wp-cli/dist-archive-command
 
       - name: Execute custom code before archive creation
         run: |
-            ${{ inputs.PRE_SCRIPT }}
+          ${{ inputs.PRE_SCRIPT }}
 
       - name: Run WP-CLI command
         run: wp dist-archive . ./archive.zip --plugin-dirname=${{ steps.plugin-folder-name.outputs.plugin-folder-name }}
@@ -210,4 +293,4 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.set-artifact-name.outputs.artifact }}
-          path: dist/*
+          path: ./dist/*

docs/archive-creation.md

@@ -46,7 +46,8 @@ jobs:
 | `NPM_REGISTRY_DOMAIN` | `"https://npm.pkg.github.com/"`                               | Domain of the private npm registry                                                             |
 | `PACKAGE_MANAGER`     | `"yarn"`                                                      | Package manager with which the dependencies should be installed (`npm` or `yarn`)              |
 | `COMPOSER_ARGS`       | `'--no-dev --no-scripts --prefer-dist --optimize-autoloader'` | Set of arguments passed to Composer                                                            |
-| `PHP_VERSION`         | `"8.0"`                                                       | PHP version to use during packaging                                                            |
+| `PHP_VERSION`         | `"8.0"`                                                       | PHP version to use when gathering production dependencies                                      |
+| `PHP_VERSION_BUILD`   | `"8.0"`                                                       | PHP version to use when executing build tools                                                  |
 | `ARCHIVE_NAME`        | `""`                                                          | The name of the zip archive (falls back to the repository name)                                |
 | `PLUGIN_MAIN_FILE`    | `"index.php"`                                                 | The name of the main plugin file                                                               |
 | `PLUGIN_FOLDER_NAME`  | `""`                                                          | The name of the plugin folder (falls back to the archive name, if set, or the repository name) |