| 1 |
efrain |
1 |
Upgrading this plugin
|
|
|
2 |
=====================
|
|
|
3 |
|
|
|
4 |
This is an internal documentation for plugin developers with some notes what has to be considered when updating this plugin to a new Moodle major version.
|
|
|
5 |
|
|
|
6 |
General
|
|
|
7 |
-------
|
|
|
8 |
|
|
|
9 |
* Generally, this is a quite simple plugin with just one purpose.
|
|
|
10 |
* It does not rely on any fluctuating library functions and should remain quite stable between Moodle major versions.
|
|
|
11 |
* Thus, the upgrading effort is low.
|
|
|
12 |
|
|
|
13 |
|
|
|
14 |
Upstream changes
|
|
|
15 |
----------------
|
|
|
16 |
|
|
|
17 |
* This plugin relies on the thiry-party Opcache-GUI tool which is located within the plugin directory. This tool is under active development and has to be updated within the plugin every now and then.
|
|
|
18 |
* Basically, you will just need to take the index.php file from the Opcache-GUI repo on https://github.com/amnuts/opcache-gui and replace the /lib/opcache-gui/index.php.inc file with this new version.
|
|
|
19 |
* However, as we want to use a CDN-less version of Opcache-GUI, you will have to rebuild the software according to https://github.com/amnuts/opcache-gui#the-javascript.
|
|
|
20 |
|
|
|
21 |
|
|
|
22 |
Automated tests
|
|
|
23 |
---------------
|
|
|
24 |
|
|
|
25 |
* The plugin has a good coverage with Behat tests which test all of the plugin's user stories.
|
|
|
26 |
|
|
|
27 |
|
|
|
28 |
Manual tests
|
|
|
29 |
------------
|
|
|
30 |
|
|
|
31 |
* There aren't any manual tests needed to upgrade this plugin.
|
|
|
32 |
|
|
|
33 |
|
|
|
34 |
Visual checks
|
|
|
35 |
-------------
|
|
|
36 |
|
|
|
37 |
* It might be advisable to have a look at the admin page of the plugin in the Moodle GUI as Moodle themes or the Opcache-GUI itself can always change small details in this area.
|