FINERACT-2349: final 1.12.1 release doc updates

Tidy up docs post-1.12.1 release, alongside updates to https://cwiki.apache.org/confluence/display/FINERACT/
2025-08-21 18:16:53 +02:00
parent fb911db8a9
commit 8f3ad9c092
6 changed files with 14 additions and 14 deletions
@@ -22,7 +22,7 @@ License GNU GPL-3.0-or-later <https://gnu.org/licenses/gpl.html>
 This is free software: you are free to change and redistribute it.
 There is NO WARRANTY, to the extent permitted by law.

-Home: /home/user/.gnupg
+Home: /home/aleks/.gnupg
 Supported algorithms:
 Pubkey: RSA, ELG, DSA, ECDH, ECDSA, EDDSA
 Cipher: IDEA, 3DES, CAST5, BLOWFISH, AES, AES192, AES256, TWOFISH,
@@ -5,11 +5,12 @@ Before you can start using the Fineract release plugin to create releases you ha
 * All official communication concerning releases happens on the mailto:dev@fineract.apache.org[mailing list]. Every release manager needs to be a member of and engaging on the mailing list for credibility.
 * Make sure you have edit permissions on the https://cwiki.apache.org/confluence/display/FINERACT[Apache Confluence Wiki]
 * You need full permissions on https://issues.apache.org/jira[Apache JIRA] to be able to move issues to the next release
-* Git committer privileges to be allowed to create tags and the release branch
+* Git committer privileges to be allowed to create tags and the release branch, and to upload release candidates to ASF's distribution dev (staging) area
 * Familiarity with building Fineract locally and creating release distributions is required
-* You need to be a member of the PMC to be able to upload release artifacts; this task can be delegated though
+* You need to be a member of the PMC to be able to upload release artifacts to ASF's distribution release area; this task can be delegated though
 * A general Familiarity with PGP/GPG is recommended (at least to setup your keypairs), but the release plugin does most of the heavy lifting
 * Make sure to read the release plugin documentation for troubleshooting
+* Read, understand, and follow everything listed at http://www.apache.org/dev/#releases. It helps to pair with someone who has previously done a release.

 include::configuration-secrets.adoc[leveloffset=+1]

@@ -1,6 +1,6 @@
 = Releases

-https://cwiki.apache.org/confluence/x/DRwIB[How to Release Apache Fineract] documents the process how we make the source code that is available here in this Git repository into a binary release tar.gz available on http://fineract.apache.org.
+This chapter explains how we make the https://github.com/apache/fineract[source code] into an official release available on https://fineract.apache.org.

 .Release Schedule
 [plantuml, format=svg, width=100%]
@@ -10,4 +10,9 @@ IMPORTANT: This is a first attempt to introduce maintenance releases. Some detai
 - NO new features, tables, data, REST endpoints
 - NO major (or "minor" framework upgrades); i. e. if we used Spring Boot "2.6.1" in version "1.6.0" of Fineract we can upgrade dependencies to "2.6.10" (unless it breaks something of course), but not to "2.7.2" of Spring Boot

-NOTE: The rest of the release process is the same as for normal releases. In the future we might have smaller time windows for reviews.
+NOTE: The rest of the release process is the same as for normal releases. In the future we might have smaller time windows for reviews.
+
+== JIRA
+
+- Continuously update the <<Step 1: Heads-Up Email,JIRA umbrella issue>> to make sure we catch all ticket changes.
+- List tickets that have discrepancies, e. g. tickets still open while associated PR merged, ticket on wrong version (i. e. associated PR already merged before with another release).
@@ -40,6 +40,8 @@ Ideally you'd build code and docs and run every possible test and check, but htt

 Finally, inspect `apache-fineract-bin-{revnumber}.tar.gz`. Make sure the `fineract-provider-{revnumber}.jar` can be run directly, and the `fineract-provider.war` can be run with Tomcat.

+NOTE: We don't release any artifacts to Apache's Maven repository.
+
 == Gradle Task

 .Command
@@ -1,14 +1,6 @@
 = Release Process

-TODO:
-
-* create "Jira anchor ticket" with all issues linked that are going into this release.
-* maintenance: continuously update the "Jira anchor ticket" to make sure we catch all ticket changes
-* maintenance: list tickets that have discrepancies, e. g. tickets still open while associated PR merged, ticket on wrong version (i. e. associated PR already merged before with another release).
-
-TBD
-
-CAUTION: Consider the Gradle plugin commands an experimental feature!
+CAUTION: Fineract release plugin Gradle tasks are experimental and incomplete.

 .Release Process Diagram
 [plantuml,format=svg]