From d1bd72ec207a5a9596a78a4e90e57123543eb8df Mon Sep 17 00:00:00 2001 From: Shamim Rezaie Date: Tue, 17 Feb 2026 12:55:19 +1100 Subject: [PATCH] NOBUG: Add upgrade notes --- UPGRADING.md | 66 ++++++++++++++++++++++++++++ public/admin/tool/xmldb/UPGRADING.md | 10 +++++ public/course/UPGRADING.md | 3 ++ public/course/format/UPGRADING.md | 3 ++ public/lib/UPGRADING.md | 35 +++++++++++++++ public/question/UPGRADING.md | 9 ++++ public/theme/UPGRADING.md | 8 ++++ 7 files changed, 134 insertions(+) create mode 100644 public/admin/tool/xmldb/UPGRADING.md diff --git a/UPGRADING.md b/UPGRADING.md index 66430a05f5c..625aa6ec3e6 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -55,6 +55,15 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt To support this a new `get_results(): array;` method has been created which returns an array of `\core\check\result` objects. For more information see [MDL-87648](https://tracker.moodle.org/browse/MDL-87648) +- A new path_section parameter type for routing has been created + + For more information see [MDL-87671](https://tracker.moodle.org/browse/MDL-87671) +- Nodes from sections with visible restrictions have been added to the navigation tree + + For more information see [MDL-87671](https://tracker.moodle.org/browse/MDL-87671) +- New `\core\attribute\description` attribute, previously `\core_sms\description`, for representing a language string in code attributes + + For more information see [MDL-87799](https://tracker.moodle.org/browse/MDL-87799) #### Changed @@ -78,6 +87,21 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt - `\core\output\core_renderer::confirm()`'s `$displayoptions` parameter now also accepts a `headinglevel` option that developers can use to specify the heading level of the confirmation's heading. If not specified, the confirmation heading will be rendered in an `h4` tag. For more information see [MDL-87694](https://tracker.moodle.org/browse/MDL-87694) +- The following classes have been renamed and now support autoloading. + + The old names will be maintained without debugging until Moodle 6.0. + + | Old class name | New class name | + | --- | --- | + | `\phpunit_coverage_info` | `\core\test\phpunit\coverage_info` | + | `\phpunit_event_mock` | `\core\test\phpunit\event_mock` | + | `\phpunit_event_sink` | `\core\test\phpunit\event_sink` | + | `\phpunit_message_sink` | `\core\test\phpunit\message_sink` | + | `\phpunit_phpmailer_sink` | `\core\test\phpunit\phpmailer_sink` | + | `\phpunit_util` | `\core\test\phpunit\phpunit_util` | + | `\testing_util` | `\core\test\testing_util` | + + For more information see [MDL-87716](https://tracker.moodle.org/browse/MDL-87716) #### Removed @@ -90,6 +114,17 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt - `core/modal_factory` For more information see [MDL-79182](https://tracker.moodle.org/browse/MDL-79182) +- The `moodle-core-notification-confirm` YUI module has been removed after an extensive deprecation period. Please use the AMD `core/modal` module as a replacement. + + For more information see [MDL-81962](https://tracker.moodle.org/browse/MDL-81962) +- The following feaetures of the `moodle-core-notification` YUI module have been removed after an extensive deprecation process.: + + - method: `keyDelegation` + - property: `lightbox` + + There is no direct replacement for these features, but they were not widely used and their removal should not cause significant issues. If you were using these features, you will need to implement your own solutions for key delegation and lightbox functionality. + + For more information see [MDL-81962](https://tracker.moodle.org/browse/MDL-81962) - Legacy constructors have been removed. These relate to PHP 4 and earlier. For more information see [MDL-82284](https://tracker.moodle.org/browse/MDL-82284) @@ -277,6 +312,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt - Deprecates set_coursemodule_groupmode in favor of core_courseformat\cmactions::set_groupmode For more information see [MDL-86857](https://tracker.moodle.org/browse/MDL-86857) +- The duplicate_module has been deprecated in favor of core_courseformat\cmactions::duplicate + + For more information see [MDL-86858](https://tracker.moodle.org/browse/MDL-86858) - The `course_set_marker` function has been deprecated and should no longer be used. Please consider using the equivalent methods, `set_marker` or `remove_all_markers`, in `core_courseformat\local\sectionactions` instead. For more information see [MDL-86860](https://tracker.moodle.org/browse/MDL-86860) @@ -306,6 +344,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt - Add set_groupmode method to the core_courseformat\cmactions (course format actions) For more information see [MDL-86857](https://tracker.moodle.org/browse/MDL-86857) +- Create a new core_courseformat\cmactions::duplicate aiming to replace the course/lib.php version + + For more information see [MDL-86858](https://tracker.moodle.org/browse/MDL-86858) - Added `set_marker` and `remove_all_markers` methods to the `core_courseformat\sectionactions` class. For more information see [MDL-86860](https://tracker.moodle.org/browse/MDL-86860) @@ -481,6 +522,15 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt #### Removed +- core_question: + - message: | + Final deprecation of `moodle-question-chooser` YUI module. + type: removed + - message: | + Final deprecation of `core_question/qbank_chooser` template. + type: removed + + For more information see [MDL-81961](https://tracker.moodle.org/browse/MDL-81961) - - The following methods have been removed from `public/question/renderer.php`: - `\core_question_bank_renderer::render_category_condition()` - `\core_question_bank_renderer::render_category_condition_advanced()` @@ -914,6 +964,14 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt For more information see [MDL-87426](https://tracker.moodle.org/browse/MDL-87426) +### theme + +#### Added + +- The manual completion button has been moved to the activity header to improve visibility and proximity to the activity name. A new theme layout option, `completioninheader`, has been introduced to control this behaviour and is enabled by default. Themes that set completioninheader to false must manually override the relevant template (such as `activity_header` or `activity_info`) to ensure the completion information is displayed correctly. + + For more information see [MDL-87662](https://tracker.moodle.org/browse/MDL-87662) + ### theme_boost #### Removed @@ -938,6 +996,14 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt For more information see [MDL-87003](https://tracker.moodle.org/browse/MDL-87003) +### tool_xmldb + +#### Changed + +- Generated `rename_field(...)` upgrade step code now checks for field existence, to ensure it can be executed multiple times + + For more information see [MDL-87158](https://tracker.moodle.org/browse/MDL-87158) + ## 5.1 ### core diff --git a/public/admin/tool/xmldb/UPGRADING.md b/public/admin/tool/xmldb/UPGRADING.md new file mode 100644 index 00000000000..e7cd13e325c --- /dev/null +++ b/public/admin/tool/xmldb/UPGRADING.md @@ -0,0 +1,10 @@ +# tool_xmldb Upgrade notes + +## 5.2dev + +### Changed + +- Generated `rename_field(...)` upgrade step code now checks for field existence, to ensure it can be executed multiple times + + For more information see [MDL-87158](https://tracker.moodle.org/browse/MDL-87158) + diff --git a/public/course/UPGRADING.md b/public/course/UPGRADING.md index 3297834c235..c1429fd585c 100644 --- a/public/course/UPGRADING.md +++ b/public/course/UPGRADING.md @@ -31,6 +31,9 @@ - Deprecates set_coursemodule_groupmode in favor of core_courseformat\cmactions::set_groupmode For more information see [MDL-86857](https://tracker.moodle.org/browse/MDL-86857) +- The duplicate_module has been deprecated in favor of core_courseformat\cmactions::duplicate + + For more information see [MDL-86858](https://tracker.moodle.org/browse/MDL-86858) - The `course_set_marker` function has been deprecated and should no longer be used. Please consider using the equivalent methods, `set_marker` or `remove_all_markers`, in `core_courseformat\local\sectionactions` instead. For more information see [MDL-86860](https://tracker.moodle.org/browse/MDL-86860) diff --git a/public/course/format/UPGRADING.md b/public/course/format/UPGRADING.md index 3493463be39..64f50d7daed 100644 --- a/public/course/format/UPGRADING.md +++ b/public/course/format/UPGRADING.md @@ -13,6 +13,9 @@ - Add set_groupmode method to the core_courseformat\cmactions (course format actions) For more information see [MDL-86857](https://tracker.moodle.org/browse/MDL-86857) +- Create a new core_courseformat\cmactions::duplicate aiming to replace the course/lib.php version + + For more information see [MDL-86858](https://tracker.moodle.org/browse/MDL-86858) - Added `set_marker` and `remove_all_markers` methods to the `core_courseformat\sectionactions` class. For more information see [MDL-86860](https://tracker.moodle.org/browse/MDL-86860) diff --git a/public/lib/UPGRADING.md b/public/lib/UPGRADING.md index 6d9b25a45b6..8ec1dddc9cc 100644 --- a/public/lib/UPGRADING.md +++ b/public/lib/UPGRADING.md @@ -47,6 +47,15 @@ To support this a new `get_results(): array;` method has been created which returns an array of `\core\check\result` objects. For more information see [MDL-87648](https://tracker.moodle.org/browse/MDL-87648) +- A new path_section parameter type for routing has been created + + For more information see [MDL-87671](https://tracker.moodle.org/browse/MDL-87671) +- Nodes from sections with visible restrictions have been added to the navigation tree + + For more information see [MDL-87671](https://tracker.moodle.org/browse/MDL-87671) +- New `\core\attribute\description` attribute, previously `\core_sms\description`, for representing a language string in code attributes + + For more information see [MDL-87799](https://tracker.moodle.org/browse/MDL-87799) ### Changed @@ -70,6 +79,21 @@ - `\core\output\core_renderer::confirm()`'s `$displayoptions` parameter now also accepts a `headinglevel` option that developers can use to specify the heading level of the confirmation's heading. If not specified, the confirmation heading will be rendered in an `h4` tag. For more information see [MDL-87694](https://tracker.moodle.org/browse/MDL-87694) +- The following classes have been renamed and now support autoloading. + + The old names will be maintained without debugging until Moodle 6.0. + + | Old class name | New class name | + | --- | --- | + | `\phpunit_coverage_info` | `\core\test\phpunit\coverage_info` | + | `\phpunit_event_mock` | `\core\test\phpunit\event_mock` | + | `\phpunit_event_sink` | `\core\test\phpunit\event_sink` | + | `\phpunit_message_sink` | `\core\test\phpunit\message_sink` | + | `\phpunit_phpmailer_sink` | `\core\test\phpunit\phpmailer_sink` | + | `\phpunit_util` | `\core\test\phpunit\phpunit_util` | + | `\testing_util` | `\core\test\testing_util` | + + For more information see [MDL-87716](https://tracker.moodle.org/browse/MDL-87716) ### Removed @@ -82,6 +106,17 @@ - `core/modal_factory` For more information see [MDL-79182](https://tracker.moodle.org/browse/MDL-79182) +- The `moodle-core-notification-confirm` YUI module has been removed after an extensive deprecation period. Please use the AMD `core/modal` module as a replacement. + + For more information see [MDL-81962](https://tracker.moodle.org/browse/MDL-81962) +- The following feaetures of the `moodle-core-notification` YUI module have been removed after an extensive deprecation process.: + + - method: `keyDelegation` + - property: `lightbox` + + There is no direct replacement for these features, but they were not widely used and their removal should not cause significant issues. If you were using these features, you will need to implement your own solutions for key delegation and lightbox functionality. + + For more information see [MDL-81962](https://tracker.moodle.org/browse/MDL-81962) - Legacy constructors have been removed. These relate to PHP 4 and earlier. For more information see [MDL-82284](https://tracker.moodle.org/browse/MDL-82284) diff --git a/public/question/UPGRADING.md b/public/question/UPGRADING.md index e21e99f12e5..bfb065b2e33 100644 --- a/public/question/UPGRADING.md +++ b/public/question/UPGRADING.md @@ -10,6 +10,15 @@ ### Removed +- core_question: + - message: | + Final deprecation of `moodle-question-chooser` YUI module. + type: removed + - message: | + Final deprecation of `core_question/qbank_chooser` template. + type: removed + + For more information see [MDL-81961](https://tracker.moodle.org/browse/MDL-81961) - - The following methods have been removed from `public/question/renderer.php`: - `\core_question_bank_renderer::render_category_condition()` - `\core_question_bank_renderer::render_category_condition_advanced()` diff --git a/public/theme/UPGRADING.md b/public/theme/UPGRADING.md index 5572297bbc7..d302bcc78c2 100644 --- a/public/theme/UPGRADING.md +++ b/public/theme/UPGRADING.md @@ -1,5 +1,13 @@ # theme (plugin type) Upgrade notes +## 5.2dev + +### Added + +- The manual completion button has been moved to the activity header to improve visibility and proximity to the activity name. A new theme layout option, `completioninheader`, has been introduced to control this behaviour and is enabled by default. Themes that set completioninheader to false must manually override the relevant template (such as `activity_header` or `activity_info`) to ensure the completion information is displayed correctly. + + For more information see [MDL-87662](https://tracker.moodle.org/browse/MDL-87662) + ## 5.1 ### Deprecated