Skip to content

Commit 6653c3e

Browse files
committed
add upgrading readme with basic how to upgrade, and patch
1 parent 952e045 commit 6653c3e

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ Features not yet implemented:
6868

6969
| Moodle version | Branch | PHP | SimpleSAMLphp |
7070
| ----------------- | ------------------ |-----------|---------------|
71-
| Moodle 4.5 | `MOODLE_405_STABLE`| 8.1+ | v2.3.5 |
71+
| Moodle 4.5 | `MOODLE_405_STABLE`| 8.1+ | v2.3.7 |
7272
| Moodle 4.4 | `MOODLE_404_STABLE`| 8.1+ | v2.3.5 |
7373
| Moodle 3.9 to 4.3 | `MOODLE_39_STABLE` | 7.4+ | v2.0.5 |
74-
| Totara 19+ | `TOTARA_19` | 7.4+ | v2.0.5 |
74+
| Totara 19+ | `TOTARA_19` | 7.4+ | v2.0.5 |
7575
| Totara 13+ | `TOTARA_13_STABLE` | 7.4+ | v2.0.5 |
7676

7777
## Installation

UPGRADING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Upgrading
2+
Older branches have simplesamlphp included in `.extlib` folder, see `UPGRADE.md` in that folder for instructions.
3+
4+
Newer versions we are using composer to install and update simplesamlphp, which is what the rest of this section is about.
5+
6+
There has been a `Dockerfile` and `docker-compose.yaml` added to allow running composer update consistently without relying on local configuration of php.
7+
8+
To run an upgrade running `docker compose up` will start the container and run `composer update --no-dev`. You can then commit the result with the updated `vendor` folder and updated `composer.lock` file.
9+
10+
11+
# Patches
12+
We are using composer patches to manage any changes needed for simplesamlphp, or any other composer packages. To do this you must generate a [git patch](https://git-scm.com/docs/git-format-patch), add it to the `patches/` folder, and reference it in the list in `composer.json`.

0 commit comments

Comments
 (0)