From ca6aa0730465ad871a2abc3bf696a01893fc62fc Mon Sep 17 00:00:00 2001 From: talyz Date: Thu, 9 Feb 2023 16:28:25 +0100 Subject: [PATCH] discourse: Document how to update --- .../web-apps/discourse/how_to_update.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 pkgs/servers/web-apps/discourse/how_to_update.md diff --git a/pkgs/servers/web-apps/discourse/how_to_update.md b/pkgs/servers/web-apps/discourse/how_to_update.md new file mode 100644 index 000000000000..c402325babc8 --- /dev/null +++ b/pkgs/servers/web-apps/discourse/how_to_update.md @@ -0,0 +1,24 @@ +To update discourse, do the following: + +1. Switch to and work from the `master` branch and the directory this + file is in. +2. Run `./update.py print-diffs` and update the nginx settings and + backend settings accordingly. If you don't know how to, ask for + help - do not skip this step! +3. Run `./update.py update`. +4. Run `nix build -L -f ../../../../ discourse.tests` to make sure the + update works. Also test manually, if possible. +5. If the update works, commit it. If not, apply necessary fixes and + commit. No manual fixes that would be overwritten by the + `./update.py` script should be committed - the script should be + fixed instead. +6. Run `./update.py update-mail-receiver`. If there's an update, do + step 4 and 5 again. +7. Run `./update.py update-plugins`. +8. Run `nix build -L -f ../../../../ discourseAllPlugins.tests` to + make sure the plugins build and discourse starts with them. Also + test manually, if possible. +9. If the update works, commit it. If not, apply necessary fixes and + commit. No manual fixes that would be overwritten by the + `./update.py` script should be committed - the script should be + fixed instead.