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

Decide Moodle 4.3 requirements and push them to environment.xml (due date: 2023-05-08)

XMLWordPrintable

    • MOODLE_403_STABLE
    • MOODLE_311_STABLE, MOODLE_39_STABLE, MOODLE_400_STABLE, MOODLE_401_STABLE, MOODLE_402_STABLE
    • MDL-76724_401
    • Hide

      0 - Prerequisites

      1. Ensure that there is NOT any $CFG->moodledata/environment directory in your installation. If it exists... it contains old environment info. Remove the directory completely before continuing with the tests below.

      A - On Master, 402, 401, 400, 311 and 39 (all supported and security supported branches):

      Note: -This needs to be tested on all the databases that are affected by the changes (Check the databases mentioned on the list)-Because there aren't database changes, it's enough to test this only with one of them.

      1. Go to admin -> server -> environment
      2. One "4.3 upwards" Moodle version should be available.
      3. VERIFY that It shows the same requirements as the 4.3 version without any difference. 100% the same.

      B - Verify, for all the numeric (XYZ) branches above, that the environment.xml file is 100% the same (requires git or diff use). All the commands should return NO differences (nothing should be output):

      Note: It's enough to test on one instance only (e.g. on a master instance)

      1. git diff MOODLE_XYZ_STABLE master admin/environment.xml

      C - Upgrade tests (easier with MDK):

      Note: Test on master only. No need to test on the other branches.

      C-1 Using minimum supported version

      1. Install Moodle 3.11.8
        1. Uninstall your current instance

          mdk uninstall -y
          

        2. Checkout the 3.11.8 tag

          git checkout v3.11.8
          

        3. Install

          mdk install
          

      2. Add some courses and one activity or two

        mdk run makecourse
        

      3. Attempt upgrade to master
        1. Checkout the master branch.

          git checkout master
          

        2. Upgrade either via the browser or via CLI (mdk upgrade)
      4. VERIFY: that upgrade works

      C-2 Using older, non-supported version

      1. Install Moodle 3.11.7
        1. Uninstall your current instance

          mdk uninstall -y
          

        2. Checkout the 3.11.7 tag

          git checkout v3.11.7
          

        3. Install

          mdk install
          

      2. Add some courses and one activity or two

        mdk run makecourse
        

      3. Attempt upgrade to master
        1. Checkout the master branch.

          git checkout master
          

        2. Open the moodle instance on your browser
      4. VERIFY: that upgrade is blocked
      Show
      0 - Prerequisites Ensure that there is NOT any $CFG->moodledata/environment directory in your installation. If it exists... it contains old environment info. Remove the directory completely before continuing with the tests below. A - On Master, 402, 401, 400, 311 and 39 (all supported and security supported branches): Note: -This needs to be tested on all the databases that are affected by the changes (Check the databases mentioned on the list)-Because there aren't database changes, it's enough to test this only with one of them. Go to admin -> server -> environment One "4.3 upwards" Moodle version should be available. VERIFY that It shows the same requirements as the 4.3 version without any difference. 100% the same. B - Verify, for all the numeric (XYZ) branches above, that the environment.xml file is 100% the same (requires git or diff use). All the commands should return NO differences (nothing should be output): Note: It's enough to test on one instance only (e.g. on a master instance) git diff MOODLE_XYZ_STABLE master admin/environment.xml C - Upgrade tests (easier with MDK): Note: Test on master only. No need to test on the other branches. C-1 Using minimum supported version Install Moodle 3.11.8 Uninstall your current instance mdk uninstall -y Checkout the 3.11.8 tag git checkout v3.11.8 Install mdk install Add some courses and one activity or two mdk run makecourse Attempt upgrade to master Checkout the master branch. git checkout master Upgrade either via the browser or via CLI ( mdk upgrade ) VERIFY : that upgrade works C-2 Using older, non-supported version Install Moodle 3.11.7 Uninstall your current instance mdk uninstall -y Checkout the 3.11.7 tag git checkout v3.11.7 Install mdk install Add some courses and one activity or two mdk run makecourse Attempt upgrade to master Checkout the master branch. git checkout master Open the moodle instance on your browser VERIFY : that upgrade is blocked

      Policy: PHP & Moodle supported versions

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

      1. A LTS will always require the previous LTS (or later) for upgrading.
      2. The maximum PHP version supported for a branch will be the max one achieved along the life of the branch. Usually with .0 releases but 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 the day of the Moodle release (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 versions requirements and put all them into the environmental tests (adding them to all supported branches).

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

      Usual discussions:

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

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

      TODO-0: Recommendation. It's useful to look to the changes performed for previous versions, specially LTS ones, to see which sort of changes must be applied with this issue. Specially 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).

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

      TODO-2: (not needed) - Once the agreement is settled, create a MDL issue about to guarantee that all the Community sites 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 in advance for the upcoming changes. This includes:

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

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

      1. (not needed) - Raised lower PHP version does imply that core composer stuff need to be updated and regenerated with it.
      2. (not needed) - 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).

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

      1. Add the new version section to the admin/environment.xml files, for all the supported (security included) branches. Ensure all the new requirements are applied.
      2. (not needed) - If Moodle requirements have changed, remove any upgrade step (and upgradelib functions) not used anymore (master only).

      TODO-6: (not needed) - GHA integration: To be done as part of this issue (master only). Ensure requirements are fulfilled and there are jobs using the new versions.

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

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

      • The affected php docker images fulfill all the requirements (extensions...).
      • Same for (still) non-dockered stuff, like:
        • Legacy CI server. Ensure that bot master jobs and CiBoT runs are executed with minimum supported php version.
        • Performance-comparison jobs.

      TODO-9: (not needed) Once the patch is ready to peer-review, update all the configuration @ CI infrastructure:

      • (not needed) Ensure (nightlyjobs) that every Moodle branch knows its lowest and highest PHP supported versions.
      • (not needed) Verify that the runner (moodle-ci-runner) is using correct database versions.
      • (not needed) Configure the following jobs if there is a PHP version bump:
        1. All "bulk-prelaunch" jobs (3), in the "Tracker" tab, configure master branch run using the new PHP version.
        2. All "developer requested" jobs (4), in the "Testing" tab, configure them to run by default using the new PHP version (moving it to the top of the list in the available PHP versions list).

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

      TODO-11: (not needed) - Once applied upstream, ensure that both the Mac and Windows packages fulfill the requirements and work ok.

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

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

      TODO-13 (not needed) 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.

      • PHPUnit 10 has been released, but we aren't in a hurry to upgrade. More yet, it only supports PHP 8.1 and up, so we cannot update to it until that PHP version is made a requirement for Moodle.

      TODO-15: MDL-78496 - Ensure that the (clone of this) issue for next (to this) requirements issue is created and contains all the information. All the non-resolved details and issues must be dragged to the new issue.

      TODO-16: Docs:

      1. (somehow related PR#668) - If there is any raise to PHP requirements, document it the PHP docs page (example PR).
      2. Ensure that all the requirements are shown in the corresponding docs (release and/or upgrade). Ask @ devdocs if the new version docs need to be created (example issue).
      3. (not needed) Ensure that there are landing pages @ docs for all the environmental changes performed.

      TIA and ciao
       

            stronk7 Eloy Lafuente (stronk7)
            stronk7 Eloy Lafuente (stronk7)
            Andrew Lyons Andrew Lyons
            Jun Pataleta Jun Pataleta
            Kim Jared Lucas Kim Jared Lucas
            Votes:
            0 Vote for this issue
            Watchers:
            15 Start watching this issue

              Created:
              Updated:
              Resolved:

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 4 hours, 50 minutes
                4h 50m

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