FINERACT-1608: Add introduction to Asciidoc
This commit is contained in:
Aleksandar Vidakovic
committed by
Aleksandar Vidakovic
Aleksandar Vidakovic
parent
a3ab06593f
commit
b0a261cbd5
@@ -34,5 +34,5 @@ Creating Apache Fineract releases was a very manual and tedious procedure before
|
||||
|
||||
[source,groovy]
|
||||
----
|
||||
include::{rootdir}/buildSrc/src/main/groovy/org.apache.fineract.release.gradle[lines=32..105]
|
||||
include::{rootdir}/buildSrc/src/main/groovy/org.apache.fineract.release.gradle[lines=23..89]
|
||||
----
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
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.
|
||||
|
||||
.Release Schedule
|
||||
[plantuml, format=svg]
|
||||
[plantuml, format=svg, width=100%]
|
||||
----
|
||||
include::{diagramsdir}/release-schedule.puml[]
|
||||
----
|
||||
|
||||
@@ -12,15 +12,15 @@ The RM should then inform users when the git branch is planned to be created, by
|
||||
|
||||
[source,text]
|
||||
----
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step01.headsup.subject.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step01.headsup.subject.ftl[lines=21..]
|
||||
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step01.headsup.message.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step01.headsup.message.ftl[lines=21..]
|
||||
----
|
||||
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep1 -Pfineract.release.issue=1234 -Pfineract.release.date="Monday, April 25, 2022" -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -10,13 +10,13 @@ project = FINERACT and resolution = fixed and fixVersion is empty
|
||||
----
|
||||
|
||||
Move all unresolved JIRA issues which have this release as Fix Version to the next release
|
||||
[source,text,subs="attributes"]
|
||||
[source,text,subs="attributes+,+macros"]
|
||||
----
|
||||
project = FINERACT and fixVersion = {revnumber} 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:
|
||||
[source,text,subs="attributes"]
|
||||
[source,text,subs="attributes+,+macros"]
|
||||
----
|
||||
project = FINERACT and fixVersion = {revnumber}
|
||||
----
|
||||
@@ -26,7 +26,7 @@ Finally, check out the output of the JIRA release note tool to see which tickets
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep2 -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -24,14 +24,14 @@ You do not need to ask committers to hold off any commits until you have branche
|
||||
|
||||
1. Create a new release branch with name "$Version"
|
||||
+
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% git checkout -b {revnumber}
|
||||
----
|
||||
|
||||
1. Push new branch to Apache Fineract repository
|
||||
+
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% git push origin {revnumber}
|
||||
----
|
||||
@@ -42,15 +42,15 @@ You do not need to ask committers to hold off any commits until you have branche
|
||||
+
|
||||
[source,text]
|
||||
----
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step03.branch.subject.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step03.branch.subject.ftl[lines=21..]
|
||||
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step03.branch.message.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step03.branch.message.ftl[lines=21..]
|
||||
----
|
||||
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep3 -Pfineract.release.date="Monday, May 10, 2022" -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
Next, you create a git tag from the HEAD of the release's git branch.
|
||||
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% git checkout {revnumber}
|
||||
% ./gradlew clean integrationTests <1>
|
||||
@@ -18,7 +18,7 @@ CAUTION: It is important to create so called annotated tags (vs. lightweight) fo
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep5 -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
Create source and binary artifacts. Make sure to do some sanity checks. The tar and the release branch should match.
|
||||
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% cd /fineract-release-preparations <1>
|
||||
% tar -xvf apache-fineract-{revnumber}-src.tar.gz
|
||||
@@ -18,7 +18,7 @@ Create source and binary artifacts. Make sure to do some sanity checks. The tar
|
||||
|
||||
Make sure code compiles and tests pass on the uncompressed source.
|
||||
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% cd apache-fineract-{revnumber}-src/fineract-provider <1>
|
||||
% gradlew clean integrationTest <2>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
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.
|
||||
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% gpg --armor --output apache-fineract-{revnumber}-src.tar.gz.asc --detach-sig apache-fineract-{revnumber}-src.tar.gz
|
||||
% gpg --print-md MD5 apache-fineract-{revnumber}-src.tar.gz > apache-fineract-{revnumber}-src.tar.gz.md5
|
||||
|
||||
@@ -15,7 +15,7 @@ Finally create a directory with release name ({revnumber} in this example) in ht
|
||||
|
||||
Upload binary and source archives to ASF's distribution dev (staging) area:
|
||||
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% svn co https://dist.apache.org/repos/dist/dev/fineract/ fineract-dist-dev
|
||||
% mkdir fineract-dist-dev/{revnumber}
|
||||
@@ -28,7 +28,7 @@ NOTE: You will need your ASF Committer credentials to be able to access the Subv
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep8 -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -18,7 +18,7 @@ Make sure release artifacts are hosted at https://dist.apache.org/repos/dist/dev
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep9 -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -6,15 +6,15 @@ Voting has to be done on dev@fineract.apache.org. You can close the vote after v
|
||||
|
||||
[source,text]
|
||||
----
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step10.vote.subject.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step10.vote.subject.ftl[lines=21..]
|
||||
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step10.vote.message.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step10.vote.message.ftl[lines=21..]
|
||||
----
|
||||
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep10 -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -6,15 +6,15 @@ Upon receiving 3 x +1 from the PMC, or after 72 hours (whichever one comes first
|
||||
|
||||
[source,text]
|
||||
----
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step11.vote.subject.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step11.vote.subject.ftl[lines=21..]
|
||||
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step11.vote.message.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step11.vote.message.ftl[lines=21..]
|
||||
----
|
||||
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,text,subs="attributes"]
|
||||
[source,text,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep11 -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
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.
|
||||
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% svn co https://dist.apache.org/repos/dist/release/fineract fineract-release
|
||||
% mkdir fineract-release/{revnumber}/
|
||||
@@ -18,7 +18,7 @@ You will now get an automated email from the Apache Reporter Service (no-reply@r
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep12 -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
As discussed in https://issues.apache.org/jira/browse/FINERACT-1154[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:
|
||||
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% git checkout develop
|
||||
% git branch -D {revnumber}
|
||||
@@ -21,7 +21,7 @@ As discussed in https://issues.apache.org/jira/browse/FINERACT-1154[FINERACT-115
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep13 -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
@@ -2,19 +2,19 @@
|
||||
|
||||
== Description
|
||||
|
||||
Send an email to announce@apache.org (sender address must be @apache.org):
|
||||
Send an email to `announce@apache.org` (sender address must be `@apache.org`):
|
||||
|
||||
[source,text]
|
||||
----
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step15.announce.subject.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step15.announce.subject.ftl[lines=21..]
|
||||
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step15.announce.message.ftl[]
|
||||
include::{rootdir}/buildSrc/src/main/resources/email/release.step15.announce.message.ftl[lines=21..]
|
||||
----
|
||||
|
||||
== Gradle Task
|
||||
|
||||
.Command
|
||||
[source,bash,subs="attributes"]
|
||||
[source,bash,subs="attributes+,+macros"]
|
||||
----
|
||||
% ./gradlew fineractReleaseStep15 -Pfineract.release.version={revnumber}
|
||||
----
|
||||
|
||||
Reference in New Issue
Block a user