Skip to content

Commit 103c07c

Browse files
authored
Merge pull request #1165 from junpataleta/updateDeprecation
Update the final deprecation policy
2 parents 44ec656 + 39542de commit 103c07c

File tree

1 file changed

+16
-1
lines changed
  • general/development/policies/deprecation

1 file changed

+16
-1
lines changed

general/development/policies/deprecation/index.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,22 @@ Longer deprecation periods can be considered for functions that are widely used.
101101

102102
### Step 2. Final deprecation
103103

104-
- If a function has been marked as deprecated for `3.[x]` (eg. 3.1) and set for removal at `3.[x + 4]` (eg. 3.5), soon after the release of `3.[x + 3].1` (eg. 3.4.1), the `3.[x + 4]` deprecation META will be processed. This means that the deprecated function will undergo final deprecation before `3.[x + 4]`, but only in the main version. This allows any potential regressions caused by the final deprecation of the function to be exposed as soon as possible.
104+
#### Policy
105+
106+
The final deprecation policy for Moodle LMS has been updated to align more closely with the LTS (long-term support) release cycle starting from Moodle 4.5 (LTS).
107+
108+
- The final deprecation of features or functionality that were deprecated before an LTS release will happen on the next major version after the LTS release.
109+
- In terms of the updates in the version numbering for Moodle LMS:
110+
- Functions that have been deprecated in standard, non-LTS releases of the current Moodle LMS series (`X.Y`, with `X` as the series number) will be up for final deprecation on the first release of the next Moodle LMS series (`[X+1].0`).
111+
- Functions that have been deprecated in an LTS version (the last version within a series) will be up for final deprecation on the next major version after the next LTS release (`[X+2].0`).
112+
113+
<ValidExample title="Example">
114+
- Functions deprecated in Moodle 4.4 (Series 4) and below will be up for final deprecation in Moodle 5.0 (the first Series 5 Moodle version).
115+
- Functions deprecated in Moodle 4.5 (LTS) will be up for final deprecation in Moodle 6.0 (the first release for Series 6 right after the Moodle 5.3 (LTS) release).
116+
</ValidExample>
117+
118+
#### Procedure
119+
105120
- When a function undergoes final deprecation, all content of the function should be removed. In the skeleton that remains, an error statement should be included that indicates that the function cannot be used anymore. You can also direct developers to the new function(s) in this message.
106121

107122
<Tabs>

0 commit comments

Comments
 (0)