+
+
+
+ elimu.ai - Free open-source learning software for out-of-school children 🚀✨ +
++ Website 🌐 + • + Wiki 📃 + • + Projects 👩🏽💻 + • + Milestones 🎯 + • + Community 👋🏽 + • + Support 💜 +
From f0221d79e53d9ed66e316436a85bc03689f29699 Mon Sep 17 00:00:00 2001 From: "Jo G." <1451036+jo-elimu@users.noreply.github.com> Date: Sun, 16 Feb 2025 16:24:05 +0700 Subject: [PATCH 2/6] Update RELEASE.md #1792 --- RELEASE.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index e328fd212..5d3a4d22c 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -5,7 +5,15 @@ See [.github/workflows/maven-release.yml](.github/workflows/maven-release.yml) > [!NOTE] > To perform a release, go to https://github.com/elimu-ai/webapp/actions/workflows/maven-release.yml, and press "Run workflow." - + + +### Create Release Notes 🗒️ + +After the release job has completed, go to https://github.com/elimu-ai/webapp/tags and press "Create release." + + + +Then press "Generate release notes" to automatically include the merged pull requests. And press "Publish release." ## Usage From 5332e9935cbcbdc123a97db1efb6599229086c83 Mon Sep 17 00:00:00 2001 From: "Jo G." <1451036+jo-elimu@users.noreply.github.com> Date: Sun, 16 Feb 2025 16:39:36 +0700 Subject: [PATCH 3/6] docs: execute deployment script #1792 --- RELEASE.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 5d3a4d22c..07e5c8f90 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -7,7 +7,7 @@ See [.github/workflows/maven-release.yml](.github/workflows/maven-release.yml)  -### Create Release Notes 🗒️ +### Create release notes 🗒️ After the release job has completed, go to https://github.com/elimu-ai/webapp/tags and press "Create release." @@ -21,6 +21,16 @@ Then press "Generate release notes" to automatically include the merged pull req After each release, the resulting `.war` file gets uploaded to https://jitpack.io/#elimu-ai/webapp +### Execute deployment script 🚀 + +1. Connect to the server via SSH +2. Execute the [`deploy-webapp.sh`](https://github.com/elimu-ai/webapp/blob/main/src/main/config/centos-stream-9/~/.elimu-ai/deploy-webapp.sh) script: + ``` + # ~/.elimu-ai/deploy-webapp.sh 2.5.11 + ``` + +This will restart the web server with the new release version. To confirm that the deployment succeeded, you can check the release version in the webapp's footer. + ---From d7a2f4894f7edb94758bdc151453a2271f55d57b Mon Sep 17 00:00:00 2001 From: "Jo G." <1451036+jo-elimu@users.noreply.github.com> Date: Sun, 16 Feb 2025 16:56:03 +0700 Subject: [PATCH 4/6] docs: link to release from readme #1792 --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 3e604d0be..092f901b7 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,10 @@ See [`INSTALL.md`](./INSTALL.md) See [`src/main/config/DEPLOY.md`](./src/main/config/DEPLOY.md) +## Release 📦 + +See [`src/main/config/RELEASE.md`](./src/main/config/RELEASE.md) + ## Localization See [`LOCALIZE.md`](./LOCALIZE.md) From 74d5d8d78c05e9740cf35e87a0f65ab0a4fec020 Mon Sep 17 00:00:00 2001 From: "Jo G." <1451036+jo-elimu@users.noreply.github.com> Date: Sun, 16 Feb 2025 16:59:24 +0700 Subject: [PATCH 5/6] docs(release): add link from config doc to release doc #1792 --- src/main/config/DEPLOY.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/config/DEPLOY.md b/src/main/config/DEPLOY.md index c8e157433..99c05d3a2 100644 --- a/src/main/config/DEPLOY.md +++ b/src/main/config/DEPLOY.md @@ -107,6 +107,8 @@ Add the latest release of your `*.war` file to `/opt/jetty-base/webapps/`. In ou > [!IMPORTANT] > The WAR file's name must match the context file's name, e.g. `webapp.war` and `webapp.xml`. +Also see https://github.com/elimu-ai/webapp/blob/main/RELEASE.md for instructions on how to perform releases from a GitHub repo. + #### Add Jetty Context XML File Copy the content from [`webapp.xml`](./centos-stream-9/opt/jetty-base/webapps/webapp.xml) into the Jetty context file: From 7d271a8e30555d65357bf6d015b09a2b74121bc7 Mon Sep 17 00:00:00 2001 From: "Jo G." <1451036+jo-elimu@users.noreply.github.com> Date: Sun, 16 Feb 2025 17:00:51 +0700 Subject: [PATCH 6/6] docs(release): shorten url #1792 --- src/main/config/DEPLOY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/config/DEPLOY.md b/src/main/config/DEPLOY.md index 99c05d3a2..108f911b7 100644 --- a/src/main/config/DEPLOY.md +++ b/src/main/config/DEPLOY.md @@ -107,7 +107,7 @@ Add the latest release of your `*.war` file to `/opt/jetty-base/webapps/`. In ou > [!IMPORTANT] > The WAR file's name must match the context file's name, e.g. `webapp.war` and `webapp.xml`. -Also see https://github.com/elimu-ai/webapp/blob/main/RELEASE.md for instructions on how to perform releases from a GitHub repo. +Also see [`RELEASE.md`](https://github.com/elimu-ai/webapp/blob/main/RELEASE.md) for instructions on how to perform releases from a GitHub repo. #### Add Jetty Context XML File