From 3b2a5bcb30f3c917d74f3a20eec56098ce4a2b30 Mon Sep 17 00:00:00 2001 From: Adam Monsen Date: Fri, 23 Jan 2026 13:08:43 -0800 Subject: [PATCH] FINERACT-2448: standardize on release ready, improve releases section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I want us to standardize on being "release ready". That is, we agree to do our best to keep incomplete features off `develop` and to keep the build passing. As part of this change I also want to update the [VERSIONS section in the README](https://github.com/apache/fineract/blob/d093a089c9c13051eb8922100e38e44a3933fd9c/README.md#versions) to more accurately reflect how we do releases today. --- README.md | 12 ++++++++---- fineract-doc/src/docs/en/chapters/release/index.adoc | 2 ++ 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ff11bc4b6..127b8b7ea 100644 --- a/README.md +++ b/README.md @@ -333,14 +333,18 @@ Please check `application.properties` to see which connection pool settings can NOTE: We keep backwards compatibility until one of the next releases to ensure that things are working as expected. Environment variables prefixed `fineract_tenants_*` can still be used to configure the database connection, but we strongly encourage using `FINERACT_HIKARI_*` with more options. -VERSIONS +RELEASES ============ -A release version is derived from source control. The version will include `-SNAPSHOT` unless the current branch looks like a release or release maintenance branch. See `gitVersioning` settings in `build.gradle` for details. +[Official releases](https://fineract.apache.org/#downloads) are created quarterly, at the end of each quarter. Our [documented release procedure](https://fineract.apache.org/docs/current/#_releases) follows the [ASF release policy](https://www.apache.org/legal/release-policy.html). -The latest stable release can be viewed on the develop branch: [Latest Release on Develop](https://github.com/apache/fineract/tree/develop "Latest Release"). +See for an archive of historical release notes along with JIRA issues relevant to each release. -The progress of this project can be viewed in the left hand navigation under [this page of the wiki](https://cwiki.apache.org/confluence/display/FINERACT/Fineract+Releases) +See for a list of PRs and contributors for each release. + +EOL/unsupported releases are [archived](https://www.apache.org/legal/release-policy.html#archived). + +Versioned build products created from the `develop` branch will include `-SNAPSHOT`. See [related settings](https://github.com/qoomon/gradle-git-versioning-plugin) near `version` and `gitVersioning` in `build.gradle` for details. LICENSE diff --git a/fineract-doc/src/docs/en/chapters/release/index.adoc b/fineract-doc/src/docs/en/chapters/release/index.adoc index 3a67ca3df..99f86a136 100644 --- a/fineract-doc/src/docs/en/chapters/release/index.adoc +++ b/fineract-doc/src/docs/en/chapters/release/index.adoc @@ -8,6 +8,8 @@ This chapter explains how we make the https://github.com/apache/fineract[source include::{diagramsdir}/release-schedule.puml[] ---- +TIP: Be **release ready** and reduce release time by weeks. Keep incomplete features off `develop` and fix the build as soon as it breaks. If `develop` is kept release ready, this 17 day timeline can be reduced to about a week: Skip the "ca. 2 weeks" indicated in <>. + include::configuration.adoc[leveloffset=+1] include::process.adoc[leveloffset=+1]