...
- dev@fineract.apache.org mailing list membership (and past activity, for credibility..)
- Apache Confluence Wiki Edit permission (for contributing to e.g. improving this page and creating the release notes overview page)
- Apache JIRA full permission (for moving issues to the next release)
- git committer privileges (for creating tags)
- familiarity with locally building the Fineract code (for creating the release ZIP)
- PMC membership (for uploading the release ZIP) - this can of course be delegated
- familiarity with PGP/GPG (for digitally signing the release ZIP)
TODO FINERACT-874 what about the release.sh script? Either clarify its role and when to use it here, or remove it from git.
1. Chose Release Manager (RM)
...
To: dev@fineract.apache.org |
5. Freeze JIRA, create release tag, build distribution, digitally sign it, upload it, call for PMC vote
Approx. 3 days after having sent the email above, if there are no objections, start the final step of actually releasing.
Close JIRA version
You first need to close the release in JIRA so that the about to be released version cannot be used as "fixVersion" for new bugs anymore. 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.
Tag release branch
Next, you create a git tag from the HEAD of the release's git branch.
Code Block | ||
---|---|---|
| ||
% git checkout $RELEASE
% git tag -a release-$RELEASE -m "Fineract $RELEASE release"
#Make sure compiles/tests run fine and rat check is fine (% cd fineract-provider, % gradlew clean integrationTest); run additonally manual tests with the community app
% git push origin release-$RELEASE |
Create source and binary artifacts. The steps are defined in Release Sign
Sanity Check
Make sure the tar and the release branch match
...
% cd /fineract-release-preparations
% tar -xvf apache-fineract-
$RELEASE
-src.tar.gz
#Do a fresh clone of the tag
% git clone
https://git-wip-us.apache.org/repos/asf/fineract.git
% cd fineract/
% git checkout tags/
release-$RELEASE% cd ..
% diff -r fineract
apache-fineract-
$RELEASE-src
...
#Make sure prerequisites are met before running these commands
% cd
apache-fineract-
$RELEASE-src/fineract-provider
% gradlew clean integrationTest (For running integration tests)
% gradlew clean build (For building deploy able war)
% gradlew rat (For RAT checks)
With the release branch we draw a line in the side, but development on the develop branch will usually continue after the release branch is created. If changes on develop need to be included in the still open release branch then do so by cherry picking selectively.
Cherry picking should only happen from the develop branch, i. e. do not pick changes from PRs that are not yet merged. That way we ensure that we don't pick up anything too experimental or just plain not working.
5. Freeze JIRA, create release tag, build distribution, digitally sign it, upload it to dist/dev (staging), call for PMC vote
Approx. 3 days after having sent the email above, if there are no objections, start the final step of actually releasing.
Close JIRA version
You first need to close the release in JIRA so that the about to be released version cannot be used as "fixVersion" for new bugs anymore. 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.
Tag release branch
Next, you create a git tag from the HEAD of the release's git branch.
Code Block | ||
---|---|---|
| ||
% git checkout $RELEASE
% git tag -a $RELEASE -m "Fineract $RELEASE release"
#Make sure compiles/tests run fine and rat check is fine (% cd fineract-provider, % gradlew clean integrationTest); run additonally manual tests with the community app
% git push origin $RELEASE |
Create source and binary artifacts. The steps are defined in Release Sign
Sanity Check
Make sure the tar and the release branch match
% cd /fineract-release-preparations % tar -xvf apache-fineract- $RELEASE -src.tar.gz #Do a fresh clone of the tag % git clone https://git-wip-us.apache.org/repos/asf/fineract.git % cd fineract/ % git checkout tags/ $RELEASE% 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) |
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.
Upload binary and source archives to ASF's distribution dev (staging) area
% svn co https://dist.apache.org/repos/dist/dev/fineract/ fineract-dist-dev
% mkdir fineract-dist-dev/$RELEASE
% cp fineract/build/distributions/* fineract-dist-dev/$RELEASE/
% svn commit
The password for the Authentication realm: <https://dist.apache.org:443> ASF Committers which svn commit
will require is your regular ASF Authentication credential.
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/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.apache.org. You can close the vote after voting period expires and you accumulate sufficient votes.
Call for voting on dev list (PMC)
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.
...
To: dev@fineract.apache.org Subject: [VOTE] [APACHE FINERACT] $RELEASE for release |
https://dist.apache.org/repos/dist/dev/fineract/ |
...
KEYS |
6. Finish the release
Upon receiving 3 +1s from the PMC, or after 72 hours (whichever one comes first), reply to the voting thread and pref [RESULT] to the subject line with the results, as follows:
Running the vote
Voting has to be done on dev@fineract.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.apache.org Subject: [RESULT][VOTE] [APACHE FINERACT] $RELEASE for release |
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 |
...
6. Finish the release
Upon receiving 3 +1s from the PMC, or after 72 hours (whichever one comes first), reply to the voting thread and pref [RESULT] to the subject line with the results, as follows:
...
/repos/dist/release/fineract fineract-release
mkdir fineract-release/$RELEASE/
cp fineract-dist-dev/$RELEASE/* fineract-release/$RELEASE/
svn add fineract-release/$RELEASE/
svn commit -m "Fineract Release $RELEASE" fineract-release/$RELEASE/ |
You will now get an automated email from the Apache Reporter Service (no-reply@reporter.apache.org), subject "Please add your release data for 'fineract'" to add the release data (version and date) to the database on https://reporter.apache.org/addrelease.html?fineract (requires PMC membership).
Remove git release branch & merge release tag into develop branch
As discussed in FINERACT-1154, now that everything is final, please do the following to remove the release branch (and just keep the tag), and make sure that everything on the release tag is merged to develop and that e.g. git describe
works:
git checkout develop
git branch -D $RELEASE
git push origin :$RELEASE
git checkout develop
git checkout -b merge-$RELEASE
git merge -s recursive -Xignore-all-space $RELEASE
# Manually resolve merge conflicts, if any
git commit
git push $USER
hub pull-request
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.
...
language | bash |
---|
...
Update the website
Finally update the https://fineract.apache.org website with the latest release details. The website's HTML source code is available at https://github.com/apache/fineract-site.
...
To: announce@apache.org
CC: dev@fineract.apache.org,user@fineract.apache.org
Subject: [ANNOUNCE] Apache Fineract $RELEASE Release
Hi all,
The
...
Apache
...
Fineract project is pleased to announce
the release of Apache Fineract $RELEASE.
The release is available for download from
https://fineract.apache.org/#downloads
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 underbanked and unbanked. Fineract is aimed at innovative mobile
and cloud-based solutions, and enables digital transaction accounts for all.
This release addressed 250 issues.
Readme: https://github.com/apache/fineract/blob/$RELEASE/README.md
Release page: https://cwiki.apache.org/confluence/display/FINERACT/$RELEASE+-+Apache+Fineract
...
List of fixed issues:
https://
...
...
secure/ReleaseNote.jspa?version=12344606&styleName=Html&projectId=12319420
For more information on Apache Fineract please visit
project home page: https://fineract.apache.org
The Apache Fineract Team