Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-83470

Decide Moodle 5.0 requirements and push them to environment.xml (due date: 15 Nov 2024)

XMLWordPrintable

      Policy: PHP & Moodle supported versions

      Since Moodle 3.5 (MDL-59159), these rules apply to decide the Minimum PHP and Moodle versions supported:

      1. An LTS will always require the previous LTS (or later) for upgrading.
      2. The maximum PHP version supported for a branch will be the maximum one achieved throughout the life of the branch. Usually with .0 releases, but it may happen later (we added support for php70 with 3.0.1 or support for php73 with 3.6.4, for example).
      3. The minimum PHP version supported for a branch will be the lower of:
        • The minimum version supported in any way by php that is under support for at least 12 more months when the new Moodle version gets released (so we provide slow, progressive increments).
        • The maximum PHP version supported by the previous LTS branch (so we guarantee jumping between LTS is possible without upgrading PHP at the same time).

      We need to decide ASAP about all the PHP/DB/Moodle version requirements and put all of them into the environmental tests (adding them to all supported branches).

      All the still open linked issues have also been cloned here from the 4.5 sister issue (MDL-79809).

      Usual discussions:

      Feel free to propose areas to be discussed here. A numbered list with all the proposals will be created to vote on and decide the final outcomes of this issue.

       Related Tasks (create issues/PRs whenever they apply):

      TODO-0: Recommendation. It's useful to look at the changes performed for previous versions, especially LTS ones, to see which sort of changes must be applied to this issue. Especially remember that any change to the minimum supported PHP always implies a change to the minimum upgradeable Moodle version (to the first one supporting the new PHP requirement).

      • Done: Minimum Moodle version is set to 4.2.3

      TODO-1: Once the agreement is settled, if there are raised requirements (PHP/Database/Extensions...), create a moodle-ubuntu issue to ensure that the external testers' environment is ready for them.

      TODO-2: Once the agreement is settled, create an MDL issue to guarantee that all the Community sites running the dev version fulfil the new requirements.

      TODO-3: Once the agreement is settled, warn (apart from the previous points) about the agreed changes, listing them so everybody is ready for the upcoming changes. This includes:

      • Integration exposed post.
      • General dev chat.
      • Internal dev chats.

      TODO-4: Composer: To be done as part of this issue (main only):

      1. Changes in the minimum PHP version mean that core composer stuff will need to be updated and regenerated with it (link to detailed instructions).
      2. Also, check that all the php and extensions requirements and recommendations in the composer.json file match the ones specified in the admin/environment.xml file (defined by this issue).
      3. Check for the version changes of the packages in the composer.lock file (e.g. behat/gherkin, etc.). Check the packages' changelog and see if there are any breaking changes we need to be aware of and address.

      TODO-5: Environment and upgrade: To be done as part of this issue:

      1. Add the new version section to the admin/environment.xml file for all the supported (security included) branches. Ensure all the new requirements are applied.
      2. If Moodle requirements have changed, remove any unused upgrade steps (and upgradelib functions) (main only).
      3. Also, don't forget to edit the moodle_minimum_php_version_is_met() function with any new PHP requirement being changed here (see MDL-80819 as the previous update).

      TODO-6: GHA integration: This is to be done as part of this issue (main only). Ensure requirements are fulfilled and jobs are using the new versions.

      1. push.yml
      2. windows.yml
      3. web-installer-test.yml

      TODO-7: phpcs.xml.dist: This is to be done as part of this issue (main only). Ensure that the testVersion config setting matches the range of supported PHP versions. Note that for the main branch, we leave the range open always.

      TODO-8: Once the agreement is settled, ensure that:

      • The affected php docker images fulfil all the requirements (extensions...).
        • Note: No changes in extensions in this issue.
      • Same for (still) non-dockered stuff, like:
        • Legacy CI server. Ensure that bot main jobs and CiBoT runs are executed with minimum supported php version.
        • Performance-comparison jobs.
          • Note: Perf server unavailable at the moment.

      TODO-9: Once the patch is ready for peer-review, update all the configurations @ CI infrastructure:

      • Ensure (nightlyjobs) that every Moodle branch knows its lowest and highest PHP-supported versions.
      • Verify that the runner (moodle-ci-runner) is using the correct database versions.
      • Done: PR #135
      • Configure the following jobs if there is a PHP version bump:
        1. All "bulk-prelaunch" jobs (5), in the "Tracker" tab, configure main branch run using the new PHP version.
        2. In the "Testing" tab, configure all "developer requested" jobs (4) to run by default using the new PHP version (moving it to the top of the list in the available PHP versions list unless they already have a newer version).
          • Note: No change applied as PHP 8.2 is already at the top of the list.

      ( TODO-10: Once applied upstream, changes are needed @ download.moodle.org to show the new requirements (serverscripts).

      TODO-11: Once applied upstream, ensure that both the Mac and Windows packages fulfil the requirements and work ok.

      • Note: Our Windows XAMPP package comes with PHP8.2 but its MariaDB version is stuck at < 10.6, unfortunately.
      • Note: Pinged Ralf Krause to give him a heads-up about the requirements. Hopefully, he'll update the Mac OS package for 5.0dev soon.

      TODO-12: Once applied upstream, warn (apart from the previous points) about the imminent changes, listing them so everybody is ready for the upcoming changes. This includes:

      • Integration exposed post.
      • General dev chat.
      • Internal dev chats.

      TODO-13 Once applied upstream, review the Travis (only moodle-plugin-ci) and GitHub actions configuration for various repositories. The new core requirements may be hitting them. Also, add new branches if missing. Known to need review / fix repos include:

      TODO-14: Consider if there is any PHPUnit upgrade to perform whenever there are PHP version changes.

      TODO-15: Docs:

      1. If the PHP requirements change, document it on the PHP docs page (for example, PR).
      2. Ensure that all the requirements are shown in the corresponding docs (release and/or upgrade). Ask @ devdocs if the new docs version needs to be created (example issue).
      3. Ensure there are landing pages @ docs for all the environmental changes performed.

      TODO-16: Last one, to be able to create it with all the information in this issue:

      1. Ensure that the (clone of this) issue for the next (to this) requirements issue is created and contains all the information.
      2. All the non-resolved details and issues must be dragged (linked) to the new issue.

      TIA and ciao

        1. MDL-83470 A.png
          MDL-83470 A.png
          958 kB
        2. MDL-83470 B.png
          MDL-83470 B.png
          62 kB
        3. MDL-83470 C.png
          MDL-83470 C.png
          377 kB

            jpataleta Jun Pataleta
            jpataleta Jun Pataleta
            Sara Arjona (@sarjona) Sara Arjona (@sarjona)
            Huong Nguyen Huong Nguyen
            Ron Carl Alfon Yu Ron Carl Alfon Yu
            Votes:
            3 Vote for this issue
            Watchers:
            16 Start watching this issue

              Created:
              Updated:
              Resolved:

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 1 day, 2 hours, 33 minutes
                1d 2h 33m

                  Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.