RELEASE.md

How to perform a release 📦

See .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

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 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.

---

elimu.ai - Free open-source learning software for out-of-school children 🚀✨

Website 🌐  •  Wiki 📃  •  Projects 👩🏽‍💻  •  Milestones 🎯  •  Community 👋🏽  •  Support 💜