How to Release Apache Fineract - Cutting a release branch (Draft)

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

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 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 send the pointer to the umbrella issue along with the tentative timeline for branch point to the developer lists. Any work identified as release related that needs to be completed should be added as a sub task of the umbrella issue to allow users to see the overall release progress in one place.

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

Sanitize JIRA

Before a release is done, make sure that any issues that are fixed have their fix version setup correctly.

project = fineract and resolution = fixed and fixVersion is empty

Move the unresolved jiras to the next release

project = fineract and fixVersion = 0.7.0-incubating and status not in( resolved, done, Accepted, Closed)

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.

Creating Release Artifacts

Communicate with the community

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.

Create a release branch

Clone fresh repository copy

% 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.

% git log # Check current branch history. HEAD should point to commit that you want to be base for your release branch

% git checkout -b 0.7.0-incubating

Push new branch to Apache Fineract repository

% git push origin 0.7.0-incubating

Add new release notes in Release Folders

(The change list can be swiped from the JIRA release note tool (use the "text" format for the change log). See JIRA Cleanup above to ensure that the release notes generated by this tool are what you are expecting)

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

Tag release branch

% 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

Sanity Check

Make sure the tar and the release branch match

Create signatures and check sums

All release artifacts must be signed. In order to sign a release you will need a PGP key. You should get your key signed by a few other people. You will also need to receive their keys from a public key server.   See the Apache release signing page for more details. Please follow the steps defined in Release Sign

Verifying a release candidate

Following are the typical things we need to verify before voting on a release candidate. And the release manager should verify them too before calling out a vote.

• 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

Running the vote

Voting has to be done on dev@fineract.incubator.apache.org. 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: issue details

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 

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.

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.

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,

To: announce@apache.org,general@incubator.apache.org
CC: dev@fineract.incubator.apache.org,user@fineract.incubator.apache.org
Subject: [ANNOUNCE] Apache Fineract 0.7.0-incubating Release
Hi all,
The Apache Fineract team would like to announce the release of Apache Fineract 0.6.0-incubating 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.incubator.apache.org/
The release artifacts can be downloaded here: https://dist.apache.org/repos/dist/release/incubator/fineract/0.7.0-incubating/
The release notes can be found here: https://cwiki.apache.org/confluence/display/FINERACT/0.7.0-incubating+Release-+Apache+Fineract

Thanks!
The Apache Fineract Team 
--- DISCLAIMER  Apache Fineract is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. 
Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, 
and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily 
a reflection of the completeness or stability of the code,it does indicate that the project has yet to be fully endorsed by the ASF. 
We would like to thank all contributors who made the release possible.

Finally update the website with latest release details downloads. Code is available at Website Code