From 266c8ec44bb69d023861be41b5e0bac240b9e0f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Chlup?= Date: Tue, 2 Jul 2024 16:52:23 +0200 Subject: [PATCH] Add RELEASING.md with necessary instructions --- RELEASING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 00000000..b5f9fc87 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,24 @@ +# Releasing new version + +## Step-by-step + +In order to release a new version, there are several steps that must happen: + + 0. make sure all issues (in GitHub and in JIRA) targeted to the version are resolved + 1. create a pull request in which you change the [version string](https://github.com/modcluster/mod_proxy_cluster/blob/main/native/include/mod_proxy_cluster.h#L21) according to the format described in [another section](#version-naming-conventions) + 2. get review and merge the pull request + 3. release the version through GH release functionality with the tag corresponding to version from the pull request + 4. mark the corresponding version released in [JIRA](https://issues.redhat.com/projects/MODCLUSTER?release-page) as well + + +## Version naming conventions + +Version string must have the following format: + +* `major.minor.micro.Alpha` +* `major.minor.micro.Beta` +* `major.minor.micro.CR` +* `major.minor.micro.Final` + +where `` is a mandatory numerical value starting from `1`. Any version marked `Final` must not have a number. If there +is any issue with such a version, just increase a micro version and go through the process again.