Upgrade notes: Difference between revisions
(Add a summary of places to note upgrade changes.) |
(Add an example for normal periods to explain the expected behaviour in that case) |
||
| Line 1: | Line 1: | ||
Moodle uses a variety of methods to distribute information about changes to released Moodle versions which might affect users, designers, administrators, and developers. | Moodle uses a variety of methods to distribute information about changes to released Moodle versions which might affect users, designers, administrators, and developers. | ||
== Release notes == | == Release notes == | ||
Each released version of Moodle comes with a set of Release notes which include notes of changes which may affect users, designers, administrators, and developers. | Each released version of Moodle comes with a set of Release notes which include notes of changes which may affect users, designers, administrators, and developers. | ||
See the [[Releases|list of releases]] for a full list of released versions. | See the [[Releases|list of releases]] for a full list of released versions. | ||
== Tracker labels == | == Tracker labels == | ||
The following labels are used within the Moodle tracker to identify issues which may affect different groups: | The following labels are used within the Moodle tracker to identify issues which may affect different groups: | ||
| Line 11: | Line 9: | ||
* upgrade_notes | * upgrade_notes | ||
* ui_change | * ui_change | ||
== upgrade.txt == | == upgrade.txt == | ||
Each component and subsystem may make use of an ''upgrade.txt'' file in the top level folder of that component or subsystem. | Each component and subsystem may make use of an ''upgrade.txt'' file in the top level folder of that component or subsystem. | ||
A title is used to identify the Moodle version where the change was introduced, and signficant changes for that version relating to that component or subsystem are displayed. | A title is used to identify the Moodle version where the change was introduced, and signficant changes for that version relating to that component or subsystem are displayed. | ||
Please note that when changes are integrated to multiple ''development'' branches (i.e. two major releases), and a change is commented in the upgrade.txt notes, the version listed in upgrade.txt will be the ''earliest'' development branch that the change was made to. | Please note that when changes are integrated to multiple ''development'' branches (i.e. two major releases), and a change is commented in the upgrade.txt notes, the version listed in upgrade.txt will be the ''earliest'' development branch that the change was made to. So, for example: | ||
If a change was made to 3.9.3, 3.10, and master (4.0) then that change will be marked as 3.9.3 on the MOODLE_39_STABLE branch, and 3.10 for both MOODLE_310_STABLE, and master. | * In normal period, during the 4.1 development, if a change is applied to 4.0.2 and master, then the upgrade.txt notes will show 4.0.2 in both branches (MOODLE_400_STABLE and master). | ||
* During the 3.10 development, which was developed in parallel with the master branch for Moodle 4.0, if a change is applied to 3.10 and master then the upgrade.txt notes will show 3.10 in both branches. If a change was made to 3.9.3, 3.10, and master (4.0) then that change will be marked as 3.9.3 on the MOODLE_39_STABLE branch, and 3.10 for both MOODLE_310_STABLE, and master. | |||
Revision as of 10:15, 31 May 2022
Moodle uses a variety of methods to distribute information about changes to released Moodle versions which might affect users, designers, administrators, and developers.
Release notes
Each released version of Moodle comes with a set of Release notes which include notes of changes which may affect users, designers, administrators, and developers.
See the list of releases for a full list of released versions.
Tracker labels
The following labels are used within the Moodle tracker to identify issues which may affect different groups:
- release_notes
- upgrade_notes
- ui_change
upgrade.txt
Each component and subsystem may make use of an upgrade.txt file in the top level folder of that component or subsystem. A title is used to identify the Moodle version where the change was introduced, and signficant changes for that version relating to that component or subsystem are displayed.
Please note that when changes are integrated to multiple development branches (i.e. two major releases), and a change is commented in the upgrade.txt notes, the version listed in upgrade.txt will be the earliest development branch that the change was made to. So, for example:
- In normal period, during the 4.1 development, if a change is applied to 4.0.2 and master, then the upgrade.txt notes will show 4.0.2 in both branches (MOODLE_400_STABLE and master).
- During the 3.10 development, which was developed in parallel with the master branch for Moodle 4.0, if a change is applied to 3.10 and master then the upgrade.txt notes will show 3.10 in both branches. If a change was made to 3.9.3, 3.10, and master (4.0) then that change will be marked as 3.9.3 on the MOODLE_39_STABLE branch, and 3.10 for both MOODLE_310_STABLE, and master.
