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

Bump all versions, requires and dependencies near the 4.5 release

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Fixed
    • Icon: Blocker Blocker
    • 4.5
    • 4.5
    • General, Installation
    • MOODLE_405_STABLE
    • MOODLE_405_STABLE
    • MDL-83309-main
    • Hide

      A) Definition: "VERSION" == 2024100700 (planned release version/date)
      B) Definition: "REQUIRE" == 2024100100 (current Beta/RCX) - set to RC1

      export VERSION=2024100700
      export REQUIRE=2024100100
      

      0) TEST: Verify that CiBoT is completely green in this issue. Specifically, no lines with comments and missing full stops should be reported.

      Only the main branch needs to be tested with the following points:

      1) TEST: Visually verify that all the changes in the patch point to the correct "VERSION" versions and all the requires and dependencies point to the correct "REQUIRE" and nothing else is changed.

      • Note main version.php file must be >= "REQUIRE". Any dependency using the ANY_VERSION constant should remain unchanged by the patch.
      • Note that some lines may have comments with a final full-stop added if previously missing.

      2) Upgrade from 4.5dev version using the web interface

      • TEST: In the plugins screen ALL the plugins are showing "to upgrade" (or removed).
      • TEST: All the target versions show "VERSION" and all the dependencies show the "REQUIRE" version along the whole page.
      • TEST: Run upgrade. Ends without error.

      3) Verify that there isn't any plugin version.php file missing the "VERSION". Something like this should do the trick (ignore main version.php, that's ok, will be updated on release day):

      find . -name version.php | grep -v fixtures | xargs grep -L $VERSION
      

      4) Verify that there isn't any plugin version.php containing a comment with anything looking like a numeric version. Can be verified by checking that there aren't cases returned by:

      find . -name version.php | xargs grep -P '; *\/.*[0-9.]{3}'
      

      5) Verify that there isn't any plugin->release in core, it's no sense there. Can be verified running:

      find . -name version.php | xargs grep -P '>release' | grep -v fixtures
      

      6) TEST: To integrators, minutes after integration, verify that the "Check version.php files (main)" job in the integration server ends without error, that everything points to "VERSION" / "REQUIRE" versions, and that the report does not include any "ERROR" looking to the generated "versions_check_set.txt" file in the workspace. Note that some "WARN" can exist, but that's not relevant to this issue.

      Show
      A) Definition: "VERSION" == 2024100700 (planned release version/date) B) Definition: "REQUIRE" == 2024100100 (current Beta/RCX) - set to RC1 export VERSION=2024100700 export REQUIRE=2024100100 0) TEST: Verify that CiBoT is completely green in this issue. Specifically, no lines with comments and missing full stops should be reported. Only the main branch needs to be tested with the following points: 1) TEST: Visually verify that all the changes in the patch point to the correct "VERSION" versions and all the requires and dependencies point to the correct "REQUIRE" and nothing else is changed. Note main version.php file must be >= "REQUIRE". Any dependency using the ANY_VERSION constant should remain unchanged by the patch. Note that some lines may have comments with a final full-stop added if previously missing. 2) Upgrade from 4.5dev version using the web interface TEST: In the plugins screen ALL the plugins are showing "to upgrade" (or removed). TEST: All the target versions show "VERSION" and all the dependencies show the "REQUIRE" version along the whole page. TEST: Run upgrade. Ends without error. 3) Verify that there isn't any plugin version.php file missing the "VERSION". Something like this should do the trick (ignore main version.php, that's ok, will be updated on release day): find . -name version.php | grep -v fixtures | xargs grep -L $VERSION 4) Verify that there isn't any plugin version.php containing a comment with anything looking like a numeric version. Can be verified by checking that there aren't cases returned by: find . -name version.php | xargs grep -P '; *\/.*[0-9.]{3}' 5) Verify that there isn't any plugin->release in core, it's no sense there. Can be verified running: find . -name version.php | xargs grep -P '>release' | grep -v fixtures 6) TEST: To integrators, minutes after integration, verify that the "Check version.php files (main)" job in the integration server ends without error, that everything points to "VERSION" / "REQUIRE" versions, and that the report does not include any "ERROR" looking to the generated "versions_check_set.txt" file in the workspace. Note that some "WARN" can exist, but that's not relevant to this issue.

      This task corresponds to point #3 of the 1 week prior release tasks.

      It's achieved semi-automatically using the "versions_check_set.sh" script available in the local_ci plugin.

      1) Create a working main instance local_ci plugin installed. Remove Composer's "vendor" directory and any non-core plugins if you're working on an existing instance.

      2) Define and export all the env variables required by the script.

      • $WORKSPACE: Path to the directory where test results will be sent (/tmp)
      • $phpcmd: Path to the PHP CLI executable (e.g. /usr/bin/php)
      • $gitdir: Directory containing git repo (the dirroot of the git, working site)
      • $setversion: 10digits (YYYYMMDD00) to set all versions to. Empty = not set. Since Moodle 2.7, it has been agreed to bump to the planned release version for easier automated checks later in stable land.
      • $setrequires: 10 digits (YYYYMMDD00) to set all required values. Empty = default to $setversion. Since Moodle 2.7, it has been agreed to perform the required bump to the current master version (usually an RC one).

      3) Run the "versions_check_set.sh" script. If there are errors, they will be reported, and fixing them will be necessary. (look for "ERROR" in the $WORKSPACE/versions_check_set.txt file and/or check the exit status of the script)

      4) Without errors, all the versions, requires, and dependencies will be bumped.

      5) Commit

      6) Note that the main version file is NOT updated at all. One extra commit bumping may be necessary (to anything >= requires version).

      7) Rerun the checker to verify that there are no errors, and no more changes are performed.

      Note that the checker is also run periodically by the CI server and as part of the "remote_branch_checker," so normally, all the version.php files should be under control.

      (This issue will be cloned for each major release).

      Ciao

            jpataleta Jun Pataleta
            jpataleta Jun Pataleta
            Carlos Escobedo Carlos Escobedo
            Sara Arjona (@sarjona) Sara Arjona (@sarjona)
            Kim Jared Lucas Kim Jared Lucas
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved:

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

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