From 48d0bca1c63b8a0d8dc25629768c1dd7bf936e4d Mon Sep 17 00:00:00 2001 From: Marvin Flock Date: Tue, 12 Aug 2025 01:12:57 +0200 Subject: [PATCH] chore: add release process to readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 02a675d..219f8fe 100644 --- a/README.md +++ b/README.md @@ -83,3 +83,23 @@ JConfig: `./data/joomla_data/configuration.php` 7. Click on "Start Listening for PHP Debug Connections" in the top row of intellij 8. (Not sure if optional) Install a browser extension by Jetbrains https://chromewebstore.google.com/detail/xdebug-helper-by-jetbrain/aoelhdemabeimdhedkidlnbkfhnhgnhm + + +### How to release +Hint: for technical details regarding the release process have a look into .github/... +To create a release these steps need to be followed +1. make sure all needed code changes are merged from dev -> stage -> prod, since releases may only be build on prod branch +2. give pull requests meaningful names and label them enhancement/bug/chore since labels and names are used for release note generation + Hint: if a specific pull request should be ignored, add the label changelog-ignore +3. tag a commit (recommended is the latest merge on prod). The pipeline is listening for any tag fitting `v[0-9]+.[0-9]+.[0-9]+` + ```shell + git tag -a v1.2.3 1a2b3c4 -m "Release version 1.2.3" + ``` +4. push the tag + ```shell + git push origin --tags + ``` +5. the tag push will trigger the pipeline, and it will create the release and store in GitHub + +A release can be created again anytime by deleting the release from GitHub, deleting the tag (from GitHub and additionally from git) +and repeating step 3 and 4