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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
% 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 | ||
---|---|---|
| ||
% git checkout -b 0.7.0-incubating |
Push new branch to Apache Fineract repository
Code Block | ||
---|---|---|
| ||
% 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 |
...
Code Block | ||
---|---|---|
| ||
% 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
|
#Make sure prerequisites are met before running these commands
% 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 |
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 |
Call for voting on dev list (IPMC)
To: general@incubator.apache.org |
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 |
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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.