Skip to content

Commit

Permalink
NOBUG: Add upgrade notes
Browse files Browse the repository at this point in the history
  • Loading branch information
sarjona committed Aug 23, 2024
1 parent c992c75 commit 7ce18d2
Show file tree
Hide file tree
Showing 7 changed files with 118 additions and 0 deletions.
56 changes: 56 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt

For more information see [MDL-82168](https://tracker.moodle.org/browse/MDL-82168)

#### Changed

- Added fields `recipientid` and `recipientfullname` to `user_badge_exporter`, which is used in the return structure of external functions `core_badges_get_user_badge_by_hash` and `core_badges_get_user_badges`.

For more information see [MDL-82742](https://tracker.moodle.org/browse/MDL-82742)

### core

#### Removed
Expand Down Expand Up @@ -63,6 +69,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
- The following method has been deprecated and should no longer be used: `reset_password_and_mail`. Please consider using `setnew_password_and_mail` as a replacement.

For more information see [MDL-64148](https://tracker.moodle.org/browse/MDL-64148)
- `moodle_list` and `list_item` were only used by `qbank_managecategories`, and these usages have been removed, so these classes (and thus all of listlib.php) are now deprecated. This method was the only usage of the `QUESTION_PAGE_LENGTH` constant, which was defined in `question_category_object.php`, and so is also now deprecated.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)
- The following methods have been deprecated, existing usage should switch to secure `\core\encryption` library:
- `rc4encrypt`
- `rc4decrypt`
Expand Down Expand Up @@ -136,6 +145,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
after the improvement.

For more information see [MDL-78030](https://tracker.moodle.org/browse/MDL-78030)
- The `after_config()` callback has been converted to a hook, `\core\hook\after_config`.

For more information see [MDL-79011](https://tracker.moodle.org/browse/MDL-79011)
- The following classes have been renamed.
Existing classes are currently unaffected.
| Old class name | New class name |
Expand Down Expand Up @@ -253,6 +265,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
| `\YUI_config` | `\core\output\requirements\yui` |

For more information see [MDL-82183](https://tracker.moodle.org/browse/MDL-82183)
- A new method, get_deprecated_icons(), has been added to the icon_system class. All deprecated icons should be registered through this method. Plugins can implement a callback to pluginname_get_deprecated_icons() to register their deprecated icons too. When $CFG->debugpageinfo is enabled, a console message will display a list of the deprecated icons.

For more information see [MDL-82212](https://tracker.moodle.org/browse/MDL-82212)
- The Moodle autoloader should now be registered using `\core\component::register_autoloader` rather than manually doing so in any exceptional location which requires it. It is not normally necessary to include the autoloader manually, as it is registered automatically when the Moodle environment is bootstrapped.

For more information see [MDL-82747](https://tracker.moodle.org/browse/MDL-82747)
Expand Down Expand Up @@ -379,6 +394,9 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt
- Method assign_grading_table::col_userid has been deprecated.

For more information see [MDL-82295](https://tracker.moodle.org/browse/MDL-82295)
- The mod_assign_grading_options_form class has been deprecated since it is no longer used.

For more information see [MDL-82857](https://tracker.moodle.org/browse/MDL-82857)

### tool_oauth2

Expand All @@ -402,6 +420,26 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt

For more information see [MDL-78773](https://tracker.moodle.org/browse/MDL-78773)

### qbank_managecategories

#### Deprecated

- question_category_list and question_category_list_item are no longer used, and are deprecated. Category lists are now generated by templates.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)
- The methods `question_is_only_child_of_top_category_in_context`, `question_is_top_category` and `question_can_delete_cat` from `qbank_managecategories\helper` class have been deprecated and moved to the `\core_question\category_manager` class, minus the misleading `question_` prefix. Following the creation of this class, it does not make sense for them to live inside the `qbank_managecategories` plugin.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)
- `qbank_managecategories\question_category_object` is now completely deprecated. Its methods have either been migrated to `qbank_managecategories\question_categories`, `core_question\category_manager`, or are no longer used at all.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)

#### Changed

- The methods in the `question_category_object` class that are still required following this change have been split between `\qbank_managecategories\question_categories` (for the parts used within this plugin for display a list of categories) and `\core_question\category_manager` (for the parts used for generate CRUD operations on question categories, including outside of this plugin). This will allow `question_category_object` to be deprecated, and avoids other parts of the system wishing to manipulate question categories from having to violate cross-component communication rules.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)

### mod_feedback

#### Deprecated
Expand All @@ -413,6 +451,16 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt

For more information see [MDL-81742](https://tracker.moodle.org/browse/MDL-81742)

### repository_onedrive

#### Removed

- The following previously deprecated methods have been removed and can no longer be used:
- `can_import_skydrive_files`
- `import_skydrive_files`

For more information see [MDL-72620](https://tracker.moodle.org/browse/MDL-72620)

### report_eventlist

#### Deprecated
Expand Down Expand Up @@ -755,6 +803,14 @@ The format of this change log follows the advice given at [Keep a CHANGELOG](htt

For more information see [MDL-82146](https://tracker.moodle.org/browse/MDL-82146)

### tool_behat

#### Added

- Behat tests are now checking for deprecated icons. This check can be disabled by using the --no-icon-deprecations option in the behat CLI.

For more information see [MDL-82212](https://tracker.moodle.org/browse/MDL-82212)

### core_filters

#### Added
Expand Down
10 changes: 10 additions & 0 deletions admin/tool/behat/UPGRADING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# tool_behat Upgrade notes

## 4.5dev+

### Added

- Behat tests are now checking for deprecated icons. This check can be disabled by using the --no-icon-deprecations option in the behat CLI.

For more information see [MDL-82212](https://tracker.moodle.org/browse/MDL-82212)

6 changes: 6 additions & 0 deletions badges/UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,9 @@
- New webservices enable_badges and disable_badges have been added.

For more information see [MDL-82168](https://tracker.moodle.org/browse/MDL-82168)

### Changed

- Added fields `recipientid` and `recipientfullname` to `user_badge_exporter`, which is used in the return structure of external functions `core_badges_get_user_badge_by_hash` and `core_badges_get_user_badges`.

For more information see [MDL-82742](https://tracker.moodle.org/browse/MDL-82742)
9 changes: 9 additions & 0 deletions lib/UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
- The following method has been deprecated and should no longer be used: `reset_password_and_mail`. Please consider using `setnew_password_and_mail` as a replacement.

For more information see [MDL-64148](https://tracker.moodle.org/browse/MDL-64148)
- `moodle_list` and `list_item` were only used by `qbank_managecategories`, and these usages have been removed, so these classes (and thus all of listlib.php) are now deprecated. This method was the only usage of the `QUESTION_PAGE_LENGTH` constant, which was defined in `question_category_object.php`, and so is also now deprecated.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)
- The following methods have been deprecated, existing usage should switch to secure `\core\encryption` library:
- `rc4encrypt`
- `rc4decrypt`
Expand Down Expand Up @@ -105,6 +108,9 @@
after the improvement.

For more information see [MDL-78030](https://tracker.moodle.org/browse/MDL-78030)
- The `after_config()` callback has been converted to a hook, `\core\hook\after_config`.

For more information see [MDL-79011](https://tracker.moodle.org/browse/MDL-79011)
- The following classes have been renamed.
Existing classes are currently unaffected.
| Old class name | New class name |
Expand Down Expand Up @@ -222,6 +228,9 @@
| `\YUI_config` | `\core\output\requirements\yui` |

For more information see [MDL-82183](https://tracker.moodle.org/browse/MDL-82183)
- A new method, get_deprecated_icons(), has been added to the icon_system class. All deprecated icons should be registered through this method. Plugins can implement a callback to pluginname_get_deprecated_icons() to register their deprecated icons too. When $CFG->debugpageinfo is enabled, a console message will display a list of the deprecated icons.

For more information see [MDL-82212](https://tracker.moodle.org/browse/MDL-82212)
- The Moodle autoloader should now be registered using `\core\component::register_autoloader` rather than manually doing so in any exceptional location which requires it. It is not normally necessary to include the autoloader manually, as it is registered automatically when the Moodle environment is bootstrapped.

For more information see [MDL-82747](https://tracker.moodle.org/browse/MDL-82747)
Expand Down
3 changes: 3 additions & 0 deletions mod/assign/UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,6 @@
- Method assign_grading_table::col_userid has been deprecated.

For more information see [MDL-82295](https://tracker.moodle.org/browse/MDL-82295)
- The mod_assign_grading_options_form class has been deprecated since it is no longer used.

For more information see [MDL-82857](https://tracker.moodle.org/browse/MDL-82857)
22 changes: 22 additions & 0 deletions question/bank/managecategories/UPGRADING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# qbank_managecategories Upgrade notes

## 4.5dev+

### Deprecated

- question_category_list and question_category_list_item are no longer used, and are deprecated. Category lists are now generated by templates.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)
- The methods `question_is_only_child_of_top_category_in_context`, `question_is_top_category` and `question_can_delete_cat` from `qbank_managecategories\helper` class have been deprecated and moved to the `\core_question\category_manager` class, minus the misleading `question_` prefix. Following the creation of this class, it does not make sense for them to live inside the `qbank_managecategories` plugin.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)
- `qbank_managecategories\question_category_object` is now completely deprecated. Its methods have either been migrated to `qbank_managecategories\question_categories`, `core_question\category_manager`, or are no longer used at all.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)

### Changed

- The methods in the `question_category_object` class that are still required following this change have been split between `\qbank_managecategories\question_categories` (for the parts used within this plugin for display a list of categories) and `\core_question\category_manager` (for the parts used for generate CRUD operations on question categories, including outside of this plugin). This will allow `question_category_object` to be deprecated, and avoids other parts of the system wishing to manipulate question categories from having to violate cross-component communication rules.

For more information see [MDL-72397](https://tracker.moodle.org/browse/MDL-72397)

12 changes: 12 additions & 0 deletions repository/onedrive/UPGRADING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# repository_onedrive Upgrade notes

## 4.5dev+

### Removed

- The following previously deprecated methods have been removed and can no longer be used:
- `can_import_skydrive_files`
- `import_skydrive_files`

For more information see [MDL-72620](https://tracker.moodle.org/browse/MDL-72620)

0 comments on commit 7ce18d2

Please sign in to comment.