You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fineract.apache.org by ar...@apache.org on 2022/06/16 07:19:13 UTC
[fineract] branch develop updated: Fix for Gradle logging on asciidoc and swagger generation
This is an automated email from the ASF dual-hosted git repository.
arnold pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/fineract.git
The following commit(s) were added to refs/heads/develop by this push:
new 68fcddf7a Fix for Gradle logging on asciidoc and swagger generation
68fcddf7a is described below
commit 68fcddf7a7f082ba669bf3b4f7ea0632d569800f
Author: Arnold Galovics <ga...@gmail.com>
AuthorDate: Wed Jun 15 21:46:36 2022 +0200
Fix for Gradle logging on asciidoc and swagger generation
---
fineract-doc/build.gradle | 4 ++++
.../src/docs/en/chapters/architecture/modules.adoc | 22 ++++++++++----------
.../en/chapters/release/configuration-email.adoc | 18 ++++++++--------
.../en/chapters/release/configuration-gpg.adoc | 8 ++++----
.../docs/en/chapters/release/process-step03.adoc | 10 ++++-----
.../src/docs/en/chapters/security/oauth.adoc | 24 +++++++++++-----------
fineract-provider/build.gradle | 2 +-
7 files changed, 46 insertions(+), 42 deletions(-)
diff --git a/fineract-doc/build.gradle b/fineract-doc/build.gradle
index f33e7a7a6..ecbabc521 100644
--- a/fineract-doc/build.gradle
+++ b/fineract-doc/build.gradle
@@ -57,6 +57,8 @@ asciidoctor {
}
outputDir 'build/docs/html'
+ logging.captureStandardError LogLevel.INFO
+
dependsOn(':fineract-client:clean', ':fineract-client:buildAsciidoc')
}
@@ -84,6 +86,8 @@ asciidoctorPdf {
}
outputDir 'build/docs/pdf'
+ logging.captureStandardError LogLevel.INFO
+
// TODO: @vidakovic prepare a nicer theme
// theme 'fineract-default'
// pdfThemes {
diff --git a/fineract-doc/src/docs/en/chapters/architecture/modules.adoc b/fineract-doc/src/docs/en/chapters/architecture/modules.adoc
index d6fba1c28..9eb720043 100644
--- a/fineract-doc/src/docs/en/chapters/architecture/modules.adoc
+++ b/fineract-doc/src/docs/en/chapters/architecture/modules.adoc
@@ -7,11 +7,11 @@ Currently modules are a proof of concept feature in Fineract.
NOTE: At the moment the only module we have that follows these stricter guidelines is the example module we describe in detail in the next section. In the future we will try to split up Fineract's monolithic code base and move features (like loan product, accounts etc.) to separate modules as described here. Before that happens we need to do some code cleanups first.
1. Create a folder under `module` and name it _mymodule_.
-1. Create a folder named _core_ under `module/mymodule`.
-1. Create a folder named _service_ under `module/mymodule`.
-1. Create a folder named _starter_ under `module/mymodule`.
-1. Setup folders and Gradle build files for a Java project under `core`, `service` and `starter`.
-1. Create a text file called _spring.factories in folder `modules/mymodule/starter/src/main/resources/META-INF`.
+2. Create a folder named _core_ under `module/mymodule`.
+3. Create a folder named _service_ under `module/mymodule`.
+4. Create a folder named _starter_ under `module/mymodule`.
+5. Setup folders and Gradle build files for a Java project under `core`, `service` and `starter`.
+6. Create a text file called _spring.factories in folder `modules/mymodule/starter/src/main/resources/META-INF`.
+
The final folder and file structure should look somewhat like this:
+
@@ -20,7 +20,7 @@ The final folder and file structure should look somewhat like this:
include::{diagramsdir}/modules-folder-structure.puml[]
----
-1. Make sure that your new modules are present in settings.gradle:
+7. Make sure that your new modules are present in settings.gradle:
+
[source,groovy]
----
@@ -47,9 +47,9 @@ You can of course choose whatever folder/project structure you like for your cus
As soon as we can publish Fineract module JARs to Maven Central you'll have more freedom to setup your projects (including to setup separate Git repos).
1. Create a folder under `custom` and name it _mycustom_.
-1. Create a folder named _service_ under `custom/mycustom`.
-1. Setup folders and Gradle build files for a Java project under `service`.
-1. Create a text file called _spring.factories in folder `modules/mymodule/starter/src/main/resources/META-INF`:
+2. Create a folder named _service_ under `custom/mycustom`.
+3. Setup folders and Gradle build files for a Java project under `service`.
+4. Create a text file called _spring.factories in folder `modules/mymodule/starter/src/main/resources/META-INF`:
+
[source,properties]
----
@@ -77,7 +77,7 @@ apply from: 'dependencies.gradle'
+
<.> The best choice here is to name it like you would name your JAR artifact on Maven Central.
-1. Make sure that your custom modules are present in settings.gradle: :
+5. Make sure that your custom modules are present in settings.gradle: :
+
[source,groovy]
----
@@ -92,7 +92,7 @@ include ':fineract-client'
include ':fineract-doc'
----
<.> The `settings.gradle` file should contain something like this.
-1. The dependency.gradle file could look something like this:
+6. The dependency.gradle file could look something like this:
[source,groovy]
----
dependencies {
diff --git a/fineract-doc/src/docs/en/chapters/release/configuration-email.adoc b/fineract-doc/src/docs/en/chapters/release/configuration-email.adoc
index e00d3e335..36be555a7 100644
--- a/fineract-doc/src/docs/en/chapters/release/configuration-email.adoc
+++ b/fineract-doc/src/docs/en/chapters/release/configuration-email.adoc
@@ -15,14 +15,14 @@ See also: https://gmail.googleblog.com/2009/07/send-mail-from-another-address-wi
To be able to send emails via SMTP with your GMail account you probably need to create an app password. Please follow these instructions:
1. Go to your Google Account.
-1. Select Security.
-1. Under "Signing in to Google," select App Passwords. You may need to sign in. If you don't have this option, it might be because:
-1. 2-Step Verification is not set up for your account.
-1. 2-Step Verification is only set up for security keys.
-1. Your account is through work, school, or other organization.
-1. You turned on Advanced Protection.
-1. At the bottom, choose Select app and choose the app you using and then Select device and choose the device you're using and then Generate.
-1. Follow the instructions to enter the App Password. The App Password is the 16-character code in the yellow bar on your device.
-1. Tap Done.
+2. Select Security.
+3. Under "Signing in to Google," select App Passwords. You may need to sign in. If you don't have this option, it might be because:
+4. 2-Step Verification is not set up for your account.
+5. 2-Step Verification is only set up for security keys.
+6. Your account is through work, school, or other organization.
+7. You turned on Advanced Protection.
+8. At the bottom, choose Select app and choose the app you using and then Select device and choose the device you're using and then Generate.
+9. Follow the instructions to enter the App Password. The App Password is the 16-character code in the yellow bar on your device.
+10. Tap Done.
See also: https://support.google.com/accounts/answer/185833?p=InvalidSecondFactor&visit_id=637856439524128323-869822459&rd=1[Google Support: Sign in with App Passwords] for more details.
diff --git a/fineract-doc/src/docs/en/chapters/release/configuration-gpg.adoc b/fineract-doc/src/docs/en/chapters/release/configuration-gpg.adoc
index 830157bf6..3703301bf 100644
--- a/fineract-doc/src/docs/en/chapters/release/configuration-gpg.adoc
+++ b/fineract-doc/src/docs/en/chapters/release/configuration-gpg.adoc
@@ -34,7 +34,7 @@ Compression: Uncompressed, ZIP, ZLIB, BZIP2
+
CAUTION: The insecure hash algorithm SHA1 is still supported in version 2.2.27. SHA1 is obsolete and you don't want to use it to generate your signature.
-1. Generate your GPG key pair:
+2. Generate your GPG key pair:
+
.Input generate GPG key pair
[source,bash]
@@ -158,21 +158,21 @@ sub rsa2048/4FGHIJ56 2022-04-16 [] [expires: 2024-04-16]
+
Now you can find that there are two files created under ~/.gnupg/private-keys-v1.d/ directory. These two files are binary files with .key extension.
-1. Export your public key:
+3. Export your public key:
+
[source,bash]
----
gpg --armor --export aleks@apache.org > pubkey.asc
----
-1. Export Your Private Key:
+4. Export Your Private Key:
+
[source,bash]
----
gpg --export-secret-keys --armor aleks@apache.org > privkey.asc
----
-1. Protect Your Private Key and Revocation Certificate
+5. Protect Your Private Key and Revocation Certificate
+
Your private key should be kept in a safe place, like an encrypted flash drive. Treat it like your house key. Only you can have it and don't lose it. And you must remember your passphrase, otherwise you can't unlock your private key.
+
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 daee60517..2d9ead3d1 100644
--- a/fineract-doc/src/docs/en/chapters/release/process-step03.adoc
+++ b/fineract-doc/src/docs/en/chapters/release/process-step03.adoc
@@ -14,7 +14,7 @@ You do not need to ask committers to hold off any commits until you have branche
% cd fineract
----
-1. Check that current HEAD points to commit on which you want to base new release branch. Checkout a particular earlier commit if not.
+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]
----
@@ -22,23 +22,23 @@ You do not need to ask committers to hold off any commits until you have branche
----
<1> Check current branch history. HEAD should point to commit that you want to be base for your release branch
-1. Create a new release branch with name "$Version"
+3. Create a new release branch with name "$Version"
+
[source,bash,subs="attributes+,+macros"]
----
% git checkout -b {revnumber}
----
-1. Push new branch to Apache Fineract repository
+4. Push new branch to Apache Fineract repository
+
[source,bash,subs="attributes+,+macros"]
----
% git push origin {revnumber}
----
-1. 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.
+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.
-1. Send en email announcing the new release branch on the earlier email thread
+6. Send en email announcing the new release branch on the earlier email thread
+
[source,text]
----
diff --git a/fineract-doc/src/docs/en/chapters/security/oauth.adoc b/fineract-doc/src/docs/en/chapters/security/oauth.adoc
index 74a9e9c00..16b4def4e 100644
--- a/fineract-doc/src/docs/en/chapters/security/oauth.adoc
+++ b/fineract-doc/src/docs/en/chapters/security/oauth.adoc
@@ -19,22 +19,22 @@ This instruction describes how to get Fineract OAuth working with a Keycloak (ht
== Set up Keycloak
1. From terminal, run: 'docker run -p 9000:8080 -e KEYCLOAK_USER=admin -e KEYCLOAK_PASSWORD=admin quay.io/keycloak/keycloak:15.0.2'
-1. Go to URL 'http://localhost:9000/auth/admin' and login with admin/admin
-1. Hover your mouse over text "Master" and click on "Add realm"
-1. Enter name "fineract" for your realm
-1. Click on tab "Users" on the left, then "Add user" and create user with username "mifos"
-1. Click on tab "Credentials" at the top, and set password to "password", turning "temporary" setting to off
-1. Click on tab "Clients" on the left, and create client with ID 'community-app'
-1. In settings tab, set 'access-type' to 'confidential' and enter 'localhost' in the valid redirect URIs.
-1. In credentials tab, copy string in field 'secret' as this will be needed in the step to request the access token
+2. Go to URL 'http://localhost:9000/auth/admin' and login with admin/admin
+3. Hover your mouse over text "Master" and click on "Add realm"
+4. Enter name "fineract" for your realm
+5. Click on tab "Users" on the left, then "Add user" and create user with username "mifos"
+6. Click on tab "Credentials" at the top, and set password to "password", turning "temporary" setting to off
+7. Click on tab "Clients" on the left, and create client with ID 'community-app'
+8. In settings tab, set 'access-type' to 'confidential' and enter 'localhost' in the valid redirect URIs.
+9. In credentials tab, copy string in field 'secret' as this will be needed in the step to request the access token
Finally we need to change Keycloak configuration so that it uses the username as a subject of the token:
1. Choose client 'community-app' in the tab 'Clients'
-1. Go to tab 'Mappers' and click on 'Create'
-1. Enter 'usernameInSub' as 'Name'
-1. Choose mapper type 'User Property'
-1. Enter 'username' into the field 'Property' and 'sub' into the field 'Token Claim Name'. Choose 'String' as 'Claim JSON Type'
+2. Go to tab 'Mappers' and click on 'Create'
+3. Enter 'usernameInSub' as 'Name'
+4. Choose mapper type 'User Property'
+5. Enter 'username' into the field 'Property' and 'sub' into the field 'Token Claim Name'. Choose 'String' as 'Claim JSON Type'
You are now ready to test out OAuth:
diff --git a/fineract-provider/build.gradle b/fineract-provider/build.gradle
index 2172b7a32..dbef441d2 100644
--- a/fineract-provider/build.gradle
+++ b/fineract-provider/build.gradle
@@ -64,7 +64,7 @@ task prepareInputYaml {
}
resolve {
- logging.captureStandardOutput LogLevel.QUIET
+ logging.captureStandardOutput LogLevel.INFO
outputFileName = 'fineract'
outputFormat = 'JSONANDYAML'
prettyPrint = false