From 8f3ad9c092932a09c1ea5fdd4df6244d8186e092 Mon Sep 17 00:00:00 2001 From: Adam Monsen Date: Thu, 14 Aug 2025 17:17:11 -0700 Subject: [PATCH] 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/ --- .../docs/en/chapters/release/configuration-gpg.adoc | 2 +- .../src/docs/en/chapters/release/configuration.adoc | 5 +++-- fineract-doc/src/docs/en/chapters/release/index.adoc | 2 +- .../src/docs/en/chapters/release/maintenance.adoc | 7 ++++++- .../src/docs/en/chapters/release/process-step06.adoc | 2 ++ fineract-doc/src/docs/en/chapters/release/process.adoc | 10 +--------- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/fineract-doc/src/docs/en/chapters/release/configuration-gpg.adoc b/fineract-doc/src/docs/en/chapters/release/configuration-gpg.adoc index d85d07d1a..f22122c41 100644 --- a/fineract-doc/src/docs/en/chapters/release/configuration-gpg.adoc +++ b/fineract-doc/src/docs/en/chapters/release/configuration-gpg.adoc @@ -22,7 +22,7 @@ License GNU GPL-3.0-or-later 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, diff --git a/fineract-doc/src/docs/en/chapters/release/configuration.adoc b/fineract-doc/src/docs/en/chapters/release/configuration.adoc index 3b4de6997..6f19a2c51 100644 --- a/fineract-doc/src/docs/en/chapters/release/configuration.adoc +++ b/fineract-doc/src/docs/en/chapters/release/configuration.adoc @@ -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] diff --git a/fineract-doc/src/docs/en/chapters/release/index.adoc b/fineract-doc/src/docs/en/chapters/release/index.adoc index 67b670d2c..3a67ca3df 100644 --- a/fineract-doc/src/docs/en/chapters/release/index.adoc +++ b/fineract-doc/src/docs/en/chapters/release/index.adoc @@ -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%] diff --git a/fineract-doc/src/docs/en/chapters/release/maintenance.adoc b/fineract-doc/src/docs/en/chapters/release/maintenance.adoc index 8cf8abd2a..2f38f8d26 100644 --- a/fineract-doc/src/docs/en/chapters/release/maintenance.adoc +++ b/fineract-doc/src/docs/en/chapters/release/maintenance.adoc @@ -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. \ No newline at end of file +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 <> 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). diff --git a/fineract-doc/src/docs/en/chapters/release/process-step06.adoc b/fineract-doc/src/docs/en/chapters/release/process-step06.adoc index d967baba7..c480f78e3 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step06.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step06.adoc @@ -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 diff --git a/fineract-doc/src/docs/en/chapters/release/process.adoc b/fineract-doc/src/docs/en/chapters/release/process.adoc index 6ef1b9f7a..0fe797819 100644 --- a/fineract-doc/src/docs/en/chapters/release/process.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process.adoc @@ -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]