feat(*) Add 2.4.8 compatibility and use it as default (#15)

* feat(*): Update default to Magento 2.4.8 and PHP 8.3

* feat(*): Use opensearch for 2.4.8 and higher

* ci(end to end): Fix workflow

* ci(static): Fix workflow for unit test

* ci(mftf): Fix workflow

* feat(*): Prepare release 4.0.0

Author: julienloizelet

.github/workflows/markdown.yml renamed to .github/workflows/doc-links.yml

@@ -1,13 +1,19 @@
+name: Documentation links
+
 on:
   workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
-name: Markdown files test and update
 permissions:
-  contents: write
-  pull-requests: write
+  contents: read
 jobs:
-  markdown-test-and-update:
-    name: Markdown files test and update
+  markdown-test-links:
+    name: Markdown test links
     runs-on: ubuntu-latest
     steps:
 
@@ -16,7 +22,7 @@ jobs:
         with:
           path: sources
 
-      - name: Lauch localhost server
+      - name: Launch localhost server
         run: |
           sudo npm install --global http-server
           http-server ./sources &
@@ -26,16 +32,8 @@ jobs:
         with:
           ruby-version: 2.6
 
-      - name: Check links in Mardown files
+      - name: Check links in Markdown files
         run: |
           gem install awesome_bot
           cd sources
           awesome_bot README.md --skip-save-results --allow-dupe --base-url http://localhost:8080/ --white-list repo.magento.com,ddev.site
-
-      - uses: technote-space/toc-generator@v4
-        with:
-          MAX_HEADER_LEVEL: 3
-          COMMIT_NAME: Okaeli Dev Bot
-          TARGET_PATHS: 'README.md'
-          CHECK_ONLY_DEFAULT_BRANCH: true
-          CREATE_PR: true

.github/workflows/mftf-tests.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # Last version
+        # Latest version
         m2-version: [ "2.4.7" ]
         php-version: [ "8.3" ]
         magento-repository: ['https://repo.magento.com/']
@@ -57,14 +57,10 @@ jobs:
         run: |
           cd .ddev && ddev nginx-config okaeli-add-on/magento2/custom_files/mftf/nginx-site.conf
 
-      - name: Disable some extensions for 2.4.7
-        if: startsWith(matrix.m2-version, '2.4.7')
-        run: |
-          ddev magento module:disable Magento_AdminAdobeImsTwoFactorAuth
-
       - name: Disable some extensions for 2.4
         if: startsWith(matrix.m2-version, '2.4')
         run: |
+          ddev magento module:disable Magento_AdminAdobeImsTwoFactorAuth
           ddev magento module:disable Magento_TwoFactorAuth
           ddev magento module:disable Magento_AdminNotification
 

.github/workflows/module-with-end-to-end-tests.yml

@@ -19,16 +19,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # Last 2 patches for the current minor, and last one for the previous minor, greatest php version
+        # Latest 2 patches for the current minor, and latest one for the previous minor, greatest php version
         include:
           - m2-version: '2.3.7-p4'
             php-version: '7.4'
             magento-repository: 'https://repo.magento.com/'
-          - m2-version: '2.4.6'
-            php-version: '8.2'
-            magento-repository: 'https://mirror.mage-os.org/'
           - m2-version: '2.4.7'
             php-version: '8.3'
+            magento-repository: 'https://mirror.mage-os.org/'
+          - m2-version: '2.4.8'
+            php-version: '8.4'
             magento-repository: 'https://repo.magento.com/'
 
 
@@ -57,7 +57,7 @@ jobs:
 
       - name: Add playwright to DDEV
         run: |
-          ddev get https://github.com/julienloizelet/ddev-playwright/archive/refs/tags/v1.0.2.tar.gz
+          ddev add-on get https://github.com/julienloizelet/ddev-playwright/archive/refs/tags/v1.0.2.tar.gz
           ddev restart
 
       - name: Clone M2 ${{ env.EXTENSION_NAME }} files
@@ -80,8 +80,8 @@ jobs:
         run: |
           ddev composer require ${{ env.EXTENSION_PACKAGE_NAME }}:@dev --no-interaction
 
-      - name: Disable some extensions for >= 2.4.6
-        if: contains(fromJson('["2.4.6","2.4.7"]'),matrix.m2-version)
+      - name: Disable some extensions for >= 2.4.7
+        if: contains(fromJson('["2.4.7","2.4.8"]'),matrix.m2-version)
         run: |
           ddev magento module:disable Magento_AdminAdobeImsTwoFactorAuth
 

.github/workflows/module-with-static-and-unit-tests.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # First and last patch for the current and previous minor, greatest php version
+        # First and latest patch for the current and previous minor, greatest php version
         include:
           - m2-version: '2.3.0'
             php-version: '7.2'
@@ -32,8 +32,8 @@ jobs:
           - m2-version: '2.4.0'
             php-version: '7.4'
             magento-repository: 'https://repo.magento.com/'
-          - m2-version: '2.4.7'
-            php-version: '8.3'
+          - m2-version: '2.4.8'
+            php-version: '8.4'
             magento-repository: 'https://repo.magento.com/'
 
     name: Static and unit test suite
@@ -97,9 +97,9 @@ jobs:
           ddev exec cat dev/tests/static/testsuite/Magento/Test/Php/_files/phpstan/phpstan.neon
           ddev phpstan vendor/${{ env.EXTENSION_PACKAGE_NAME }} --debug
 
-      - name: Fix Unit Test for Magento 2.4.6
+      - name: Fix Unit Test for Magento 2.4.8
         # @see https://github.com/magento/magento2/issues/36702
-        if: contains(fromJson('["2.4.6"]'),matrix.m2-version)
+        if: contains(fromJson('["2.4.8"]'),matrix.m2-version)
         run: sed -i  's/allure\/allure.config.php/dev\/tests\/unit\/allure\/allure.config.php/g' dev/tests/unit/phpunit.xml.dist
 
       - name: PHP UNIT

.github/workflows/module-with-varnish-test.yml

@@ -24,14 +24,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # Last one for the current and previous minor, greatest php version
-        m2-version: [ "2.3.7-p4", "2.4.7" ]
-        php-version: [ "7.4", "8.3" ]
+        # Latest one for the current and previous minor, greatest php version
+        m2-version: [ "2.3.7-p4", "2.4.8" ]
+        php-version: [ "7.4", "8.4" ]
         magento-repository: [ "https://repo.magento.com/", "https://mirror.mage-os.org/" ]
         exclude:
-          - { php-version: "8.3", m2-version: "2.3.7-p4" }
-          - { php-version: "7.4", m2-version: "2.4.7" }
-          - { php-version: "8.3", m2-version: "2.4.7", "magento-repository" : "https://mirror.mage-os.org/" }
+          - { php-version: "8.4", m2-version: "2.3.7-p4" }
+          - { php-version: "7.4", m2-version: "2.4.8" }
 
     name: Installation and Varnish test suite
     # @see https://devdocs.magento.com/marketplace/sellers/installation-and-varnish-tests.html
@@ -88,8 +87,8 @@ jobs:
           ddev magento config:set system/full_page_cache/caching_application 2
           ddev magento setup:performance:generate-fixtures ./varnish-profile.xml
 
-      - name: Disable some extensions for 2.4.7
-        if: startsWith(matrix.m2-version, '2.4.7')
+      - name: Disable some extensions for 2.4.8
+        if: startsWith(matrix.m2-version, '2.4.8')
         run: |
           ddev magento maintenance:enable
           ddev magento module:disable --clear-static-content Magento_AdminAdobeImsTwoFactorAuth

.github/workflows/release.yml

@@ -1,5 +1,5 @@
 name: Create Release
-# example: gh workflow run release.yml -f tag_name=v1.1.4 -f draft=true
+# example: gh workflow run release.yml -f tag_name=v1.1.4
 on:
   workflow_dispatch:
     branches:
@@ -8,14 +8,7 @@ on:
       tag_name:
         type: string
         required: true
-      draft:
-        type: boolean
-        description: Draft release
-        default: false
-      prerelease:
-        type: boolean
-        description: Prerelease
-        default: false
+
 
 jobs:
   create-release:
@@ -106,8 +99,8 @@ jobs:
           body_path: CHANGELOG.txt
           name: ${{ env.VERSION_NUMBER }}
           tag_name: ${{ github.event.inputs.tag_name }}
-          draft: ${{ github.event.inputs.draft }}
-          prerelease: ${{ github.event.inputs.prerelease }}
+          draft: false
+          prerelease: false
 
       - name: Set outputs
         id: set-outputs

CHANGELOG.md

@@ -10,6 +10,19 @@ The [public API](https://semver.org/spec/v2.0.0.html#spec-item-1) of this projec
 
 ---
 
+## [4.0.0](https://github.com/julienloizelet/magento2-ddev-installation/releases/tag/v4.0.0) - 2025-04-10
+[_Compare with previous release_](https://github.com/julienloizelet/magento2-ddev-installation/compare/v3.0.0...v4.0.0)
+
+### Changed
+
+- **Breaking change**: Use `2.4.8` as default Magento version
+- **Breaking change**: Use `8.3` as default PHP version
+
+### Added
+
+- Use `opensearch` search engine for Magento >= `2.4.8`
+
+
 ## [3.1.1](https://github.com/julienloizelet/magento2-ddev-installation/releases/tag/v3.1.1) - 2024-10-18
 [_Compare with previous release_](https://github.com/julienloizelet/magento2-ddev-installation/compare/v3.1.0...v3.1.1)
 

README.md

@@ -6,7 +6,7 @@
 [![End-to-end tests](https://github.com/julienloizelet/magento2-ddev-installation/actions/workflows/module-with-end-to-end-tests.yml/badge.svg)](https://github.com/julienloizelet/magento2-ddev-installation/actions/workflows/module-with-end-to-end-tests.yml)
 [![MFTF tests](https://github.com/julienloizelet/magento2-ddev-installation/actions/workflows/mftf-tests.yml/badge.svg)](https://github.com/julienloizelet/magento2-ddev-installation/actions/workflows/mftf-tests.yml)
 
-A GitHub Action to install Magento 2 with [DDEV](https://github.com/ddev/ddev).
+A GitHub Action for installing Magento 2 with [DDEV](https://github.com/ddev/ddev).
 
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -34,7 +34,7 @@ _We will suppose here that you want to test on a Magento 2.4.5 instance with PHP
 You can add the following step in your workflow:
 
 ```yaml
-- uses: julienloizelet/magento2-ddev-installation@v3
+- uses: julienloizelet/magento2-ddev-installation@v4
   with:
     php_version: "8.1"
     magento_version: "2.4.5"
@@ -57,9 +57,9 @@ The following keys are available as `step.with` keys:
 
 PHP version to use in the web container.
 
-Default: `8.2`.
+Default: `8.3`.
 
-Allowed values are: `7.2`, `7.3`, `7.4`, `8.1`, `8.2`, `8.3`.
+Allowed values are: `7.2`, `7.3`, `7.4`, `8.1`, `8.2`, `8.3`, `8.4`.
 
 Please choose a PHP version that is compatible with the `magento_version` below.
 
@@ -102,7 +102,7 @@ Could be "magento/project-community-edition", "magento/project-enterprise-editio
 
 The Magento release version to install.  
 
-Default: `2.4.7`.
+Default: `2.4.8`.
 
 You can use `X.Y.Z` format or `X.Y.Z-pN` format for patch release.
 
@@ -307,14 +307,16 @@ bin/magento setup:install \
    --currency=USD \
    --timezone=America/Chicago \
    --use-rewrites=1 \
-   --elasticsearch-host=elasticsearch --search-engine=elasticsearch7
+   <SEARCH_ENGINE_STRING>
 ```
+where `SEARCH_ENGINE_STRING` is `--elasticsearch-host=elasticsearch --search-engine=elasticsearsh7` for Magento < 2.4.8 
+and`--opensearch-host=elasticsearch --search-engine=opensearch` for Magento >= 2.4.8.
 
 
 The Magento 2 environment is a Docker environment created  with DDEV and comes with the following services:
 - `web`: PHP (version depends on `php_version` input), nginx-fpm, NodeJs
 - `db`: Depends on the `database` input
-- `elastisearch`
+- `elastisearch` (or `opensearch` for Magento >= `2.4.8`)
 - `memcached`
 - `redis`
 

action.yaml

@@ -1,13 +1,13 @@
 name: "Magento 2 installation with DDEV"
 author: "Julien Loizelet"
-description: " A Github Action for installing Magento 2 with DDEV"
+description: "A GitHub Action for installing Magento 2 with DDEV"
 
 inputs:
 
   php_version:
     type: string
     required: false
-    default: "8.2"
+    default: "8.3"
     description: "PHP Version to use"
 
   database:
@@ -25,7 +25,7 @@ inputs:
   magento_version:
     type: string
     required: false
-    default: "2.4.7"
+    default: "2.4.8"
     description: "The Magento release version to install"
 
   magento_repository:
@@ -102,11 +102,15 @@ runs:
 
     - name: Install DDEV tools add-on
       shell: bash
-      run: ddev get julienloizelet/ddev-tools
+      run: ddev add-on get julienloizelet/ddev-tools
 
-    - name: Prepare Elastic search
+    - name: Prepare Elasticsearch
       shell: bash
-      run: ddev get ddev/ddev-elasticsearch
+      run: ddev add-on get ddev/ddev-elasticsearch
+
+    - name: Prepare OpenSearch
+      shell: bash
+      run: ddev add-on get ddev/ddev-opensearch
 
     - name: Set Magento 2 settings
       shell: bash
@@ -122,15 +126,22 @@ runs:
         mkdir -p .ddev/homeadditions/.composer
         echo "$composer_auth" > .ddev/homeadditions/.composer/auth.json
 
-    - name: Set ELASTIC_INSTALL_STRING env for 2.4
+    - name: Set SEARCH_ENGINE_STRING env
       shell: bash
       if: startsWith(inputs.magento_version, '2.4')
-      run: echo "ELASTIC_INSTALL_STRING=--elasticsearch-host=elasticsearch --search-engine=elasticsearch7" >> $GITHUB_ENV
+      run: |
+        magento_version="${{ inputs.magento_version }}"
+        # Check if the version is 2.4.8 or higher
+        if [[ "$(printf '%s\n' "$magento_version" "2.4.8" | sort -V | head -n1)" == "2.4.8" ]]; then
+          echo "SEARCH_ENGINE_STRING=--opensearch-host=opensearch --search-engine=opensearch" >> $GITHUB_ENV
+        else
+          echo "SEARCH_ENGINE_STRING=--elasticsearch-host=elasticsearch --search-engine=elasticsearch7" >> $GITHUB_ENV
+        fi
 
-    - name: Set ELASTIC_INSTALL_STRING env for 2.3
+    - name: Set SEARCH_ENGINE_STRING env for 2.3
       shell: bash
       if: startsWith(inputs.magento_version, '2.3')
-      run: echo "ELASTIC_INSTALL_STRING=" >> $GITHUB_ENV
+      run: echo "SEARCH_ENGINE_STRING=" >> $GITHUB_ENV
 
     - name: Handle PHP version
       shell: bash
@@ -230,7 +241,7 @@ runs:
                          --currency=USD \
                          --timezone=America/Chicago \
                          --use-rewrites=1 \
-                         ${{ env.ELASTIC_INSTALL_STRING }}
+                         ${{ env.SEARCH_ENGINE_STRING }}
 
 outputs:
   m2_url: