Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document describes how to release Fineract. It is a work in progress and should be refined by the Release Manager (RM) as they come across aspects of the release process not yet documented here

Note
titleGit repoisotry

Apache Fineract git repository moved from incubating https://git-wip-us.apache.org/repos/asf/incubator-fineract.git to https://git-wip-us.apache.org/repos/asf/fineract.git

 

Give a heads up

Give a heads up

The RM should first create list of issues/features and then setup a timeline for release branch point. The time for the day the issue list is created to the release branch point must be at The RM should first create list of issues/features and then setup a timeline for release branch point. The time for the day the issue list is created to the release branch point must be at least two weeks in order to give the community a chance to prioritize and commit any last minute features and issues they would like to see in the upcoming release.

...

The RM should then inform users once branch point is created.

To: dev@fineract.incubator.apache.org
Subject: Work on $release release has started
Created a tracking jira (jira#) for the Fineract $release and plan to branch tentatively on $date. 
What would you like to see included?
Thanks, $RM

...

 

Code Block
languagejava
project = fineract and fixVersion = 0.7.0-incubating and status not in( resolved, done, Accepted, Closed)
You can also run the following query to make sure that the issues fixed for the to-be-released version look accurate:
Code Block
languagejava
project = fineract and fixVersion = '0.7.0-incubating'

Finally, check out the output of the JIRA release note tool to see which JIRAs are included in the release, in order to do a sanity check.

...

Send an email to developer mailing list(dev@fineract.incubator.apache.org) to notify that you are about to branch. Ask to hold off any commits until this is finished. Send another email after branching is done.

...

Code Block
languagebash
% git clone https://git-wip-us.apache.org/repos/asf/incubator-fineract.git
% cd incubator-fineract

Check that current HEAD points to commit on which you want to base new  release branch. Checkout particular commit if not.

...

Code Block
languagebash
% git checkout -b 0.7.0-incubating
Push new branch to Apache Fineract repository
Code Block
languagejava
% git push origin 0.7.0-incubating
Add new release notes in Release Folders

...

Send en email announcing the new release branch
To: dev@fineract.incubator.apache.org
Subject: New release branch 0.7.0-incubating
I've just created new release branch for upcoming 0.7.0-incubating release.
Please continue committing to develop branch as usual.
I'll cherry-pick commits to branch 0.7.0-incubating on per needed basis. Thanks, $RM

...

Code Block
languagejava
% git checkout 0.7.0-incubating 
% git tag -a release-0.7.0-incubating -m "Fineract 0.7.0-incubating release"
#Make sure compiles/tests run fine and rat check is fine (% cd fineract-provider, % gradlew clean integrationTest)
% git push origin release-0.7.0-incubating
Create source and binary artifacts. The steps are defined in Release Sign

...

% cd /fineract-release-preparations
% tar -xvf apache-fineract-0.7.0-incubating-src.tar.gz
#Do a fresh clone of the tag
% git clone https://git-wip-us.apache.org/repos/asf/incubator-fineract.git
% cd incubator- fineract/
% git checkout tags/release-0.7.0-incubating
% cd ..
% diff -r incubator-fineract apache-fineract-0.7.0-incubating-srcsrc
Make sure code compiles and tests pass on the uncompressed source.
#Make sure prerequisites are met before running these commands
% cd
apache-fineract-0.7.0-incubating-src/fineract-provider
% gradlew clean integrationTest (For running integration tests)
% gradlew clean build (For building deploy able war)
% gradlew rat (For RAT checks)

...

  • Make sure release artifacts are hosted @https://dist.apache.org/repos/dist/dev/incubator/fineract/
  • Release candidates should be in format apache-$project-$version.tar.gz 
  • Verify signatures and hashes.  You may have to import the public key of the release manager to verify the signatures. (gpg --recv-key <key id>)
  • git tag matches the released bits (diff -rf)
  • Can compile successfully from source
  • Verify DISCLAIMER, NOTICE and LICENSE (year etc)
  • All files have correct headers (Rat check should be clean - gradlew rat)
  • No jar files in the source artifacts
  • Integration tests should work.
 Running the vote

Voting has to be done on dev@fineract.incubator.apache.org and . You can close the vote after voting period expires and you accumulate sufficient votes.

 Call for voting on dev list (PMC)
To: dev@fineract.incubator.apache.org
Subject: [VOTE] [APACHE FINERACT] 0.7.0-incubating for release
We have created Apache Fineract 0.7.0-incubating release, with the artifacts below up for a vote. It fixes the following issues: {list of issues fixed} Source & Binary files : https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/ Tag to be voted on (rc#): https://git-wip-us.apache.org/repos/asf?p=incubator-fineract.git;a=commit;h=refs/heads/0.7.0-incubating Fineract's KEYS containing the PGP key we used to sign the release: https://dist.apache.org/repos/dist/dev/incubator/fineract//KEYS Note that this release contains source and binary artifacts Vote will be open for 72 hours. [ ] +1 approve [ ] +0 no opinion [ ] -1 disapprove (and reason why) Thanks, $RM

Upon receiving 3 +1s from the PMC, reply to the voting thread and prefixing [RESULT] to the subject line with the results.

To: dev@fineract.incubator.apache.org
Subject: [RESULT][VOTE] [APACHE FINERACT] 0.7.0-incubating for release
Voting is now closed and has passed with the following tally, Binding +1s: JustinMyrle McLeanKrantz,Jim Avik JagielskiGanguly,John DEd AmentCable Non binding +1s: ShaikFriendly new Nazeercontributor, Adi Raju, Markus, MyrleFriendly well-wisher, Friendly dude off the street Thanks to everyone who voted! I'll continue with the rest of the release process. $RM
Call for voting on dev list (IPMC)
To: general@incubator.apache.org
CC: dev@fineract.incubator.apache.org Subject: [RESULT][VOTE] [APACHE FINERACT] 0.7.0-incubating for release
Hello Incubator PMC,
The Apache Fineract community has voted and approved the proposal to release Apache Fineract 0.7.0 (incubating). We now kindly request the Incubator
PMC members review and vote on this incubator release.
Apache Fineract is an open source system for core banking as a platform. Fineract provides a reliable, robust, and affordable solution for entrepreneurs,
financial institutions, and service providers to offer financial services to the world’s 2 billion under banked and unbanked. More information
can be found at http://fineract.incubator.apache.org/
The Apache Fineract-0.7.0-incubating release candidate is now available with the following artifacts for a project vote:
[VOTE] Thread:
http://mail-archives.apache.org/mod_mbox/incubator-fineract-dev/201701.mbox/%3CCAOSe2ysBL1pS6YMSbSHS-BT1PPb29K-ZuGqYBd2igepQSFMm%2Bg%40mail.gmail.com%3E
[VOTE RESULT] Thread:
http://mail-archives.apache.org/mod_mbox/incubator-fineract-dev/201701.mbox/%3CCAOSe2yuvdNRkt1cAbGQcEwdWVgTpanz7kS5fAQUsnsZZWrRhCw%40mail.gmail.com%3E
The release candidate(s) to be voted on is available at:
https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/
Git tag for the release:
https://github.com/apache/incubator-fineract/tree/0.7.0-incubating
or
https://git-wip-us.apache.org/repos/asf?p=incubator-fineract.git;a=shortlog;h=refs/heads/0.7.0-incubating
Source release verification:
Source release candidate:
https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/apache-fineract-0.7.0-incubating-src.tar.gz
PGP signature:
https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/apache-fineract-0.7.0-incubating-src.tar.gz.asc
MD5/SHA Hash:
https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/apache-fineract-0.7.0-incubating-src.tar.gz.md5
https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/apache-fineract-0.7.0-incubating-src.sha512
Binary release verification:
Binary release candidate:
https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/apache-fineract-0.7.0-incubating-binary.tar.gz
PGP signature:
https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/apache-fineract-0.7.0-incubating-binary.tar.gz.asc
MD5/SHA Hash:
https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/apache-fineract-0.7.0-incubating-binary.tar.gz.md5
https://dist.apache.org/repos/dist/dev/incubator/fineract/0.7.0-incubating/apache-fineract-0.7.0-incubating-binary.sha512
Keys to verify the signature of the release artifacts are available at:
https://dist.apache.org/repos/dist/dev/incubator/fineract/KEYS
Release Notes:
https://cwiki.apache.org/confluence/display/FINERACT/0.7.0-incubating+Release-+Apache+Fineract
Build & RAT verification steps can be found at:
https://github.com/apache/incubator-fineract/blob/0.7.0-incubating/README.md
or refer 'README.md' in apache-fineract-0.7.0-incubating-src.tar.gz
Binary deployment steps can be found at:
https://cwiki.apache.org/confluence/display/FINERACT/Fineract+Installation+on+Ubuntu+Server
Note: {some notes here, if you need to give info to IPMC members}
The vote will be open for at least 72 hours or until necessary number of votes are reached.
Members please be sure to indicate "(Binding)" with your vote which will help in tallying the vote(s).
[ ] +1  approve
[ ] +0  no opinion
[ ] -1  disapprove (and reason why)
Here is my +1 (non-binding)
Thanks,
$RM
 

Upon receiving 3(binding) +1s from the IPMC, reply to the voting thread and prefixing [RESULT] to the subject line with the results. The binding votes from dev voting will be carried for general voting also. For example if we get 1 binding vote on dev listing and 2 binding votes on general listing, the RM can pass the release with 3 binding votes.

To: general@incubator.apache.org
CC: dev@fineract.incubator.apache.org Subject: [RESULT][VOTE] [APACHE FINERACT] 0.7.0-incubating for release
Voting is now closed and has passed with the following tally, Binding +1s: Justin McLean,Jim Jagielski,John D Ament Thanks to everyone who voted! I'll continue with the rest of the release process. $RM
 Rolling out the Release

Close JIRA version

You need to close the release in JIRA so that everyone knows that your version should not be used as "fixVersion" for new bugs. Go to JIRA "Administer project" page and follow "Versions" in left menu. Table with list of all releases should appear, click on additional menu on the right of your release and choose "Release" option. Submit release date and you're done.

Upload the artifacts

In order to release you have to checkout release repository located on https://dist.apache.org/repos/dist/release/incubator/fineract and add release artifacts there.

Code Block
languagebash
svn co https://dist.apache.org/repos/dist/release/incubator/fineract fineract-incubating-release
cd fineract-incubating-release
mkdir 0.7.0-incubating/
cp $source_to_your_artifacts 0.7.0-incubating/ svn add 0.7.0-incubating/
Announce the release

Send an email to announce@apache.org (the from: address must be @apache.org). For example,

...

Rolling out the Release

Close JIRA version

You need to close the release in JIRA so that everyone knows that your version should not be used as "fixVersion" for new bugs. Go to JIRA "Administer project" page and follow "Versions" in left menu. Table with list of all releases should appear, click on additional menu on the right of your release and choose "Release" option. Submit release date and you're done.

Upload the artifacts

In order to release you have to checkout release repository located on https://dist.apache.org/repos/dist/release/fineract and add release artifacts there.

Code Block
languagebash
svn co https://dist.apache.org/repos/dist/release/fineract fineract-release
cd fineract-release
mkdir 0.7.0/
cp $source_to_your_artifacts 0.7.0/ svn add 0.7.0/
Announce the release

Send an email to announce@apache.org (the from: address must be @apache.org). For example,

To: announce@apache.org
CC: dev@fineract.apache.org,user@fineract.apache.org
Subject: [ANNOUNCE] Apache Fineract 0.7.0 Release
Hi all,
The Apache Fineract team would like to announce the release of Apache Fineract 0.7.0 with source and binary artifacts.
Apache Fineract is an open source system for core banking as a platform. Fineract provides a reliable, robust, and affordable solution for entrepreneurs,
financial institutions, and service providers to offer financial services to the world’s 2 billion under banked and unbanked.
More details regarding Apache Fineract can be found at http://fineract.apache.org/
The release artifacts can be downloaded here: https://dist.apache.org/repos/dist/release/fineract/0.7.0/
The release notes can be found here: https://cwiki.apache.org/confluence/display/FINERACT/0.7.0+Release-+Apache+Fineract

Thanks!
The Apache Fineract Team

Update the website

Finally update the website with latest release details downloads. Code is available at Website Code. Apache Fineract website reflects the code present in asf-site branch of https://git-wip-us.apache.org/repos/asf/

...

fineract-site.git. Any change committed on master branch of https://git-wip-us.apache.org/repos/asf/

...

fineract-site.git should be merged with asf-site branch to reflect the change on Fineract website.