This is an automated email from the ASF dual-hosted git repository. meonkeys pushed a commit to branch release-doc-fixes in repository https://gitbox.apache.org/repos/asf/fineract.git
commit e84e25c12998382ec5125c004ee694a975eb4316 Author: Adam Monsen <[email protected]> AuthorDate: Sun Jul 27 20:08:59 2025 -0700 remove prompt character from Bash shell examples * it isn't properly syntax-highlighted and it looks confusing with line numbers (which we might want to add) * it isn't necessary * the prompt character ("%" in this case) is not typically included in shell code examples * $ is more common than % it isn't consistently one character over another --- .../src/docs/en/chapters/release/process-step02.adoc | 2 +- .../src/docs/en/chapters/release/process-step03.adoc | 12 ++++++------ .../src/docs/en/chapters/release/process-step04.adoc | 2 +- .../src/docs/en/chapters/release/process-step05.adoc | 10 +++++----- .../src/docs/en/chapters/release/process-step06.adoc | 20 ++++++++++---------- .../src/docs/en/chapters/release/process-step07.adoc | 10 +++++----- .../src/docs/en/chapters/release/process-step08.adoc | 12 ++++++------ .../src/docs/en/chapters/release/process-step09.adoc | 2 +- .../src/docs/en/chapters/release/process-step10.adoc | 2 +- .../src/docs/en/chapters/release/process-step11.adoc | 2 +- .../src/docs/en/chapters/release/process-step12.adoc | 4 ++-- .../src/docs/en/chapters/release/process-step13.adoc | 12 ++++++------ .../src/docs/en/chapters/release/process-step14.adoc | 2 +- .../src/docs/en/chapters/release/process-step15.adoc | 2 +- 14 files changed, 47 insertions(+), 47 deletions(-) diff --git a/fineract-doc/src/docs/en/chapters/release/process-step02.adoc b/fineract-doc/src/docs/en/chapters/release/process-step02.adoc index b126d0fa12..22056cd878 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step02.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step02.adoc @@ -28,7 +28,7 @@ Finally, check out the output of the JIRA release note tool to see which tickets .Command [source,bash,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep2 -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep2 -Pfineract.release.version={revnumber} ---- CAUTION: This task is not yet automated! diff --git a/fineract-doc/src/docs/en/chapters/release/process-step03.adoc b/fineract-doc/src/docs/en/chapters/release/process-step03.adoc index c0b19ffb66..d71dab1a4e 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step03.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step03.adoc @@ -12,15 +12,15 @@ You do not need to ask committers to hold off any commits until you have branche + [source,bash] ---- -% git clone [email protected]:apache/fineract.git -% cd fineract +git clone [email protected]:apache/fineract.git +cd fineract ---- 2. Check that current HEAD points to commit on which you want to base new release branch. Checkout a particular earlier commit if not. + [source,bash] ---- -% git log <1> +git log <1> ---- <1> Check current branch history. HEAD should point to commit that you want to be base for your release branch @@ -28,7 +28,7 @@ You do not need to ask committers to hold off any commits until you have branche + [source,bash,subs="attributes+,+macros"] ---- -% git checkout -b {revnumber} <1> +git checkout -b {revnumber} <1> ---- <1> Omit `-SNAPSHOT` if it appears here. @@ -36,7 +36,7 @@ You do not need to ask committers to hold off any commits until you have branche + [source,bash,subs="attributes+,+macros"] ---- -% git push origin {revnumber} +git push origin {revnumber} ---- 5. 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. @@ -55,5 +55,5 @@ include::{rootdir}/buildSrc/src/main/resources/email/release.step03.branch.messa .Command [source,bash,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep3 -Pfineract.release.date="Monday, May 10, 2022" -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep3 -Pfineract.release.date="Monday, May 10, 2022" -Pfineract.release.version={revnumber} ---- diff --git a/fineract-doc/src/docs/en/chapters/release/process-step04.adoc b/fineract-doc/src/docs/en/chapters/release/process-step04.adoc index 41dc3cf893..eeb8f47bc9 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step04.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step04.adoc @@ -9,7 +9,7 @@ You first need to close the release in JIRA so that the about to be released ver .Command [source,bash] ---- -% ./gradlew fineractReleaseStep4 +./gradlew fineractReleaseStep4 ---- CAUTION: This task is not yet automated! diff --git a/fineract-doc/src/docs/en/chapters/release/process-step05.adoc b/fineract-doc/src/docs/en/chapters/release/process-step05.adoc index 8cfeec3b29..94b5a71a95 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step05.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step05.adoc @@ -9,10 +9,10 @@ Next, you create a git tag from the HEAD of the release's git branch. [source,bash,subs="attributes+,+macros"] ---- -% git checkout {revnumber} -% ./gradlew clean integrationTests <1> -% git tag -a {revnumber} -m "Fineract {revnumber} release" -% git push origin tag {revnumber} +git checkout {revnumber} +./gradlew clean integrationTests <1> +git tag -a {revnumber} -m "Fineract {revnumber} release" +git push origin tag {revnumber} ---- <1> Run additonally manual tests with the community app. @@ -23,5 +23,5 @@ CAUTION: It is important to create so called annotated tags (vs. lightweight) fo .Command [source,bash,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep5 -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep5 -Pfineract.release.version={revnumber} ---- diff --git a/fineract-doc/src/docs/en/chapters/release/process-step06.adoc b/fineract-doc/src/docs/en/chapters/release/process-step06.adoc index d692ace94b..6a8413c124 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step06.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step06.adoc @@ -8,7 +8,7 @@ Create source and binary tarballs. [source,bash,subs="attributes+"] ---- -% ./gradlew --rerun-tasks srcDistTar binaryDistTar <1> +./gradlew --rerun-tasks srcDistTar binaryDistTar <1> ---- <1> The source tarball might not be created if `--rerun-tasks` is omitted. @@ -18,13 +18,13 @@ Make sure to do some sanity checks. The source tarball and the code in the relea [source,bash,subs="attributes+"] ---- -% cd /fineract-release-preparations -% tar -xvf path/to/apache-fineract-{revnumber}-src.tar.gz -% git clone [email protected]:apache/fineract.git -% cd fineract/ -% git checkout tags/{revnumber} -% cd .. -% diff -r fineract apache-fineract-{revnumber} +cd /fineract-release-preparations +tar -xvf path/to/apache-fineract-{revnumber}-src.tar.gz +git clone [email protected]:apache/fineract.git +cd fineract/ +git checkout tags/{revnumber} +cd .. +diff -r fineract apache-fineract-{revnumber} ---- // FIXME - add output example @@ -33,7 +33,7 @@ Make sure the code compiles and tests pass on the uncompressed source. Do as muc [source,bash,subs="attributes+"] ---- -% ./gradlew build -x test -x doc +./gradlew build -x test -x doc ---- Ideally you'd build code and docs and run every possible test and check, but https://github.com/apache/fineract/actions[running everything has complex dependencies, caches, and takes many hours]. It is rarely done in practice offline / local / on developer machines. But please, go ahead and run the test and doc tasks, and more! Grab a cup of coffee and run everything you can. See the various builds in `.github/workflows/` and try the same things on your own. We should all hammer on a rel [...] @@ -45,7 +45,7 @@ Finally, inspect `apache-fineract-{revnumber}-binary.tar.gz`. Make sure the `fin .Command [source,bash] ---- -% ./gradlew fineractReleaseStep6 +./gradlew fineractReleaseStep6 ---- CAUTION: This task doesn't work. Build release artifacts manually as indicated above. diff --git a/fineract-doc/src/docs/en/chapters/release/process-step07.adoc b/fineract-doc/src/docs/en/chapters/release/process-step07.adoc index dd7005616d..5c6ad96446 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step07.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step07.adoc @@ -6,10 +6,10 @@ Release source and binary tarballs must be checksummed and signed. In order to s [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 SHA512 apache-fineract-{revnumber}-src.tar.gz > apache-fineract-{revnumber}-src.tar.gz.sha512 -% gpg --armor --output apache-fineract-{revnumber}-binary.tar.gz.asc --detach-sig apache-fineract-{revnumber}-binary.tar.gz -% gpg --print-md SHA512 apache-fineract-{revnumber}-binary.tar.gz > apache-fineract-{revnumber}-binary.tar.gz.sha512 +gpg --armor --output apache-fineract-{revnumber}-src.tar.gz.asc --detach-sig apache-fineract-{revnumber}-src.tar.gz +gpg --print-md SHA512 apache-fineract-{revnumber}-src.tar.gz > apache-fineract-{revnumber}-src.tar.gz.sha512 +gpg --armor --output apache-fineract-{revnumber}-binary.tar.gz.asc --detach-sig apache-fineract-{revnumber}-binary.tar.gz +gpg --print-md SHA512 apache-fineract-{revnumber}-binary.tar.gz > apache-fineract-{revnumber}-binary.tar.gz.sha512 ---- == Gradle Task @@ -17,5 +17,5 @@ Release source and binary tarballs must be checksummed and signed. In order to s .Command [source,bash] ---- -% ./gradlew fineractReleaseStep7 +./gradlew fineractReleaseStep7 ---- diff --git a/fineract-doc/src/docs/en/chapters/release/process-step08.adoc b/fineract-doc/src/docs/en/chapters/release/process-step08.adoc index 8416f9aa0d..e551d6110b 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step08.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step08.adoc @@ -17,11 +17,11 @@ Upload these files to ASF's distribution dev (staging) area: [source,bash,subs="attributes+"] ---- -% svn co https://dist.apache.org/repos/dist/dev/fineract/ fineract-dist-dev -% mkdir fineract-dist-dev/{revnumber} -% cp path/to/files/* fineract-dist-dev/{revnumber}/ -% cd fineract-dist-dev -% svn commit +svn co https://dist.apache.org/repos/dist/dev/fineract/ fineract-dist-dev +mkdir fineract-dist-dev/{revnumber} +cp path/to/files/* fineract-dist-dev/{revnumber}/ +cd fineract-dist-dev +svn commit ---- NOTE: You will need your ASF Committer credentials to be able to access the Subversion host at `dist.apache.org`. @@ -31,7 +31,7 @@ NOTE: You will need your ASF Committer credentials to be able to access the Subv .Command [source,bash,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep8 -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep8 -Pfineract.release.version={revnumber} ---- CAUTION: This task is inefficient. Follow `svn mkdir` and other manual steps above. diff --git a/fineract-doc/src/docs/en/chapters/release/process-step09.adoc b/fineract-doc/src/docs/en/chapters/release/process-step09.adoc index 877396f899..bef6703dc1 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step09.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step09.adoc @@ -43,7 +43,7 @@ gpg --print-md SHA512 $bin | diff - $bin.sha512 .Command [source,bash,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep9 -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep9 -Pfineract.release.version={revnumber} ---- CAUTION: This task is not yet automated! diff --git a/fineract-doc/src/docs/en/chapters/release/process-step10.adoc b/fineract-doc/src/docs/en/chapters/release/process-step10.adoc index eb36cdc237..5a1a82a70d 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step10.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step10.adoc @@ -16,5 +16,5 @@ include::{rootdir}/buildSrc/src/main/resources/email/release.step10.vote.message .Command [source,bash,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep10 -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep10 -Pfineract.release.version={revnumber} ---- diff --git a/fineract-doc/src/docs/en/chapters/release/process-step11.adoc b/fineract-doc/src/docs/en/chapters/release/process-step11.adoc index 01134f86b1..62aab040ed 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step11.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step11.adoc @@ -16,5 +16,5 @@ include::{rootdir}/buildSrc/src/main/resources/email/release.step11.vote.message .Command [source,text,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep11 -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep11 -Pfineract.release.version={revnumber} ---- diff --git a/fineract-doc/src/docs/en/chapters/release/process-step12.adoc b/fineract-doc/src/docs/en/chapters/release/process-step12.adoc index 23b812ba11..0bcc44bddd 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step12.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step12.adoc @@ -6,7 +6,7 @@ Move the release candidate from the dev area to the release area using a Subvers [source,bash,subs="attributes+"] ---- -% svn mv https://dist.apache.org/repos/dist/dev/fineract/{revnumber} https://dist.apache.org/repos/dist/release/fineract/ +svn mv https://dist.apache.org/repos/dist/dev/fineract/{revnumber} https://dist.apache.org/repos/dist/release/fineract/ ---- NOTE: https://www.apache.org/legal/release-policy.html#upload-ci[This must be done by a Fineract PMC member]. @@ -18,7 +18,7 @@ You will now get an automated email from the Apache Reporter Service (no-reply@r .Command [source,bash,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep12 -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep12 -Pfineract.release.version={revnumber} ---- CAUTION: This task is not yet automated! diff --git a/fineract-doc/src/docs/en/chapters/release/process-step13.adoc b/fineract-doc/src/docs/en/chapters/release/process-step13.adoc index e565d444b1..19760c24cc 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step13.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step13.adoc @@ -6,11 +6,11 @@ As discussed in https://issues.apache.org/jira/browse/FINERACT-1154[FINERACT-115 [source,bash,subs="attributes+,+macros"] ---- -% git checkout develop -% git merge release/{revnumber} -% git push origin develop -% git branch -D release/{revnumber} -% git push origin :release/{revnumber} +git checkout develop +git merge release/{revnumber} +git push origin develop +git branch -D release/{revnumber} +git push origin :release/{revnumber} ---- == Gradle Task @@ -18,7 +18,7 @@ As discussed in https://issues.apache.org/jira/browse/FINERACT-1154[FINERACT-115 .Command [source,bash,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep13 -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep13 -Pfineract.release.version={revnumber} ---- CAUTION: This task is not yet automated! diff --git a/fineract-doc/src/docs/en/chapters/release/process-step14.adoc b/fineract-doc/src/docs/en/chapters/release/process-step14.adoc index eccf776024..a3b444507d 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step14.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step14.adoc @@ -11,7 +11,7 @@ CAUTION: This step is not yet automated. We are working on a static site generat .Command [source,bash] ---- -% ./gradlew fineractReleaseStep14 <1> +./gradlew fineractReleaseStep14 <1> ---- <1> Currently doing nothing. Will trigger in the future the static site generator and publish on Github. diff --git a/fineract-doc/src/docs/en/chapters/release/process-step15.adoc b/fineract-doc/src/docs/en/chapters/release/process-step15.adoc index 8ccc7d1e8f..4f199a9b03 100644 --- a/fineract-doc/src/docs/en/chapters/release/process-step15.adoc +++ b/fineract-doc/src/docs/en/chapters/release/process-step15.adoc @@ -16,5 +16,5 @@ include::{rootdir}/buildSrc/src/main/resources/email/release.step15.announce.mes .Command [source,bash,subs="attributes+,+macros"] ---- -% ./gradlew fineractReleaseStep15 -Pfineract.release.version={revnumber} +./gradlew fineractReleaseStep15 -Pfineract.release.version={revnumber} ----
