Aligned jvm folder schema and reviewed workflows (#476)

* Update folder and class packages * Workflow review * Removed JCOBridge version * Indentation fix in POM.xml
masesgroup · Jun 3, 2024 · 1ca18a0 · 1ca18a0
1 parent 150622e
commit 1ca18a0
Show file tree

Hide file tree

Showing 41 changed files with 351 additions and 386 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -9,10 +9,6 @@ on:
     # only trigger on branches, not on tags
     branches: '**'
 
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
 # This workflow contains two jobs called "check_changes", "build_windows"
 jobs:
   # Verify if a build is needed
@@ -86,10 +82,6 @@ jobs:
           gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
 
-      - name: Install local file to be used within Javadoc plugin of generated POM
-        run: mvn install:install-file -DgroupId=JCOBridge -DartifactId=JCOBridge -Dversion=2.5.13 -Dpackaging=jar -Dfile=../../../bin/net8.0/JCOBridge.jar -f ./src/jvm/knet/pom.xml
-        shell: bash
-
       - name: Create Jars
         run: mvn --file ./src/jvm/knet/pom.xml --no-transfer-progress package
         env:
@@ -158,10 +150,6 @@ jobs:
           gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
 
-      - name: Install local file to be used within Javadoc plugin of generated POM
-        run: mvn install:install-file -DgroupId=JCOBridge -DartifactId=JCOBridge -Dversion=2.5.13 -Dpackaging=jar -Dfile=../../../bin/net8.0/JCOBridge.jar -f ./src/jvm/knet/pom.xml
-        shell: bash
-
       - name: Create Jars
         run: mvn --file ./src/jvm/knet/pom.xml --no-transfer-progress package
         env:

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -21,10 +21,6 @@ on:
 #  schedule:
 #    - cron: '26 23 * * 3'
 
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
 jobs:
   # Verify if a check is needed
   check_changes:
@@ -118,12 +114,7 @@ jobs:
 
     - name: Maven preparation (step 1)
       if: matrix.language == 'java' 
-      run: dotnet build --no-incremental --configuration Release --framework net8.0 /p:Platform="Any CPU" /p:NoWarn="0108%3B1030%3B0618" ./src/net/KNet.sln
-
-    - name: Maven preparation (step 2)
-      if: matrix.language == 'java' 
-      run: mvn install:install-file -DgroupId=JCOBridge -DartifactId=JCOBridge -Dversion=2.5.13 -Dpackaging=jar -Dfile=../../../bin/net8.0/JCOBridge.jar -f ./src/jvm/knet/pom.xml
-      shell: bash
+      run: dotnet build --no-incremental --configuration Release --framework net8.0 /p:Platform="Any CPU" /p:NoWarn="0108%3B1030%3B0618" ./src/net/KNet/KNet.csproj
 
     - if: matrix.language == 'java' 
       run: mvn --file ./src/jvm/knet/pom.xml --no-transfer-progress package

diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml
@@ -38,10 +38,6 @@ jobs:
           gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
 
-      - name: Install local file to be used within Javadoc plugin of generated POM
-        run: mvn install:install-file -DgroupId=JCOBridge -DartifactId=JCOBridge -Dversion=2.5.13 -Dpackaging=jar -Dfile=../../../bin/net8.0/JCOBridge.jar -f ./src/jvm/knet/pom.xml
-        shell: bash
-
       - name: Create Jars
         run: mvn --file ./src/jvm/knet/pom.xml --no-transfer-progress package
         env:
@@ -111,10 +107,6 @@ jobs:
           gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
 
-      - name: Install local file to be used within Javadoc plugin of generated POM
-        run: mvn install:install-file -DgroupId=JCOBridge -DartifactId=JCOBridge -Dversion=2.5.13 -Dpackaging=jar -Dfile=../../../bin/net8.0/JCOBridge.jar -f ./src/jvm/knet/pom.xml
-        shell: bash
-
       - name: Create Jars
         run: mvn --file ./src/jvm/knet/pom.xml --no-transfer-progress package
         env:

diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -13,10 +13,6 @@ on:
         default: false
         type: boolean
 
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
 # This workflow contains one job called "build_documentation"
 jobs:
   build_documentation:

diff --git a/.github/workflows/generateclasses.yaml b/.github/workflows/generateclasses.yaml
@@ -12,10 +12,11 @@ on:
         required: true
         default: false
         type: boolean
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
+      UseLatestJNetReflector:
+        description: 'Shall use latest unpublished version of JNetReflector'
+        required: true
+        default: false
+        type: boolean
 
 # This workflow contains one job called "build_documentation"
 jobs:
@@ -36,6 +37,12 @@ jobs:
           fetch-depth: '1'
           submodules: 'true'
 
+      - uses: actions/checkout@v4
+        if: ${{ inputs.UseLatestJNetReflector == true }}
+        with:
+          repository: masesgroup/JNet
+          path: JNet
+
       - name: Pre compile
         run: dotnet build --no-incremental --configuration Release /p:Platform="Any CPU" /p:NoWarn="0108%3B1030%3B0618" src\net\KNet\KNet.csproj
 
@@ -51,10 +58,6 @@ jobs:
           gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
 
-      - name: Install local file to be used within Javadoc plugin of generated POM
-        run: mvn install:install-file -DgroupId=JCOBridge -DartifactId=JCOBridge -Dversion=2.5.13 -Dpackaging=jar -Dfile=../../../bin/net8.0/JCOBridge.jar -f ./src/jvm/knet/pom.xml
-        shell: bash
-
       - name: Create Jars
         run: mvn --file ./src/jvm/knet/pom.xml --no-transfer-progress package
         env:
@@ -68,21 +71,60 @@ jobs:
       - name: Clear Java generated files
         run: Remove-Item .\src\jvm\knet\src\main\java\org\mases\knet\generated\* -Recurse -Force -Exclude README.md
 
-      - run: dotnet tool update --version 2.5.1 -g MASES.JNetReflector
+      - name: Prebuild JNetReflector
+        if: ${{ inputs.UseLatestJNetReflector == true }}
+        run: dotnet build --no-incremental --configuration Release JNet\src\net\JNetReflector\JNetReflector.csproj
+
+      - name: Create Jars of JNetReflector
+        if: ${{ inputs.UseLatestJNetReflector == true }}
+        run: mvn "-Djcobridgepath=../../../binReflector/net8.0/JCOBridge.jar" --file ./JNet/src/jvm/jnet/pom.xml --no-transfer-progress package
+        env:
+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+
+      - name: Download latest published version of JNetReflector
+        run: dotnet tool update --version 2.5.1 -g MASES.JNetReflector
+        if: ${{ inputs.UseLatestJNetReflector == false }}
+
+      - name: Build classes with unpublished JNetReflector
+        if: ${{ inputs.UseLatestJNetReflector == true }}
+        shell: cmd
+        run: |
+          cd JNet\binReflector\net8.0
+          MASES.JNetReflector.exe -TraceLevel 0 -OriginRootPath %GITHUB_WORKSPACE%\jars -DestinationRootPath %GITHUB_WORKSPACE%\src\ -ConfigurationFile %GITHUB_WORKSPACE%\src\configuration.json
+        env:
+          JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }}
 
-      - name: Build classes
+      - name: Build classes with latest published version of JNetReflector
+        if: ${{ inputs.UseLatestJNetReflector == false }}
         shell: cmd
-        run: jnetreflector -TraceLevel 0 -OriginRootPath .\jars -DestinationRootPath .\src\ -ConfigurationFile .\src\configuration.json
+        run: jnetreflector -TraceLevel 0 -OriginRootPath %GITHUB_WORKSPACE%\jars -DestinationRootPath %GITHUB_WORKSPACE%\src\ -ConfigurationFile %GITHUB_WORKSPACE%\src\configuration.json
         env:
           JCOBRIDGE_LicensePath: ${{ secrets.JCOBRIDGE_ONLINE }}
-
+
+      - name: Request a PR to commit changes made with unpublished version of JNetReflector
+        if: ${{ github.repository_owner == 'masesgroup' && inputs.GeneratePR == true && inputs.UseLatestJNetReflector == true }} #do not push any changes outside main repo or GeneratePR is false
+        uses: peter-evans/create-pull-request@v6
+        with:
+          branch-suffix: short-commit-hash
+          add-paths: src/*.*
+          commit-message: Update generated classes using last unpublished version of JNetReflector
+          title: Changes by GitHub action
+          body: |
+            Automated changes by GitHub action, fix #92
+          reviewers: masesdevelopers
+          assignees: masesdevelopers
+          labels: java, .NET, enhancement 
+
       - name: Extract commit SHA
+        if: ${{ github.repository_owner == 'masesgroup' && inputs.GeneratePR == true && inputs.UseLatestJNetReflector == false }}
         run: |
           echo "GITHUB_COMMIT_MESSAGE=$(echo $GITHUB_SHA | cut -c 1-7)" >> $GITHUB_ENV
         shell: bash
 
-      - name: Request a PR to commit changes
-        if: ${{ github.repository_owner == 'masesgroup' && inputs.GeneratePR == true }} #do not push any changes outside main repo or GeneratePR is false
+      - name: Request a PR to commit changes made with latest published version of JNetReflector
+        if: ${{ github.repository_owner == 'masesgroup' && inputs.GeneratePR == true && inputs.UseLatestJNetReflector == false }} #do not push any changes outside main repo or GeneratePR is false
         uses: peter-evans/create-pull-request@v6
         with:
           branch-suffix: short-commit-hash

diff --git a/.github/workflows/pullrequest.yaml b/.github/workflows/pullrequest.yaml
@@ -8,10 +8,6 @@ on:
   pull_request:
     branches: [ master ]
 
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
 jobs:
   # Verify if a build is needed
   check_changes:
@@ -84,10 +80,6 @@ jobs:
           gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
 
-      - name: Install local file to be used within Javadoc plugin of generated POM
-        run: mvn install:install-file -DgroupId=JCOBridge -DartifactId=JCOBridge -Dversion=2.5.13 -Dpackaging=jar -Dfile=../../../bin/net8.0/JCOBridge.jar -f ./src/jvm/knet/pom.xml
-        shell: bash
-
       - name: Create Jars
         run: mvn --file ./src/jvm/knet/pom.xml --no-transfer-progress package
         env:
@@ -138,10 +130,6 @@ jobs:
           gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
 
-      - name: Install local file to be used within Javadoc plugin of generated POM
-        run: mvn install:install-file -DgroupId=JCOBridge -DartifactId=JCOBridge -Dversion=2.5.13 -Dpackaging=jar -Dfile=../../../bin/net8.0/JCOBridge.jar -f ./src/jvm/knet/pom.xml
-        shell: bash
-
       - name: Create Jars
         run: mvn --file ./src/jvm/knet/pom.xml --no-transfer-progress package
         env:

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -44,10 +44,6 @@ jobs:
           gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
           gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
 
-      - name: Install local file to be used within Javadoc plugin of generated POM
-        run: mvn install:install-file -DgroupId=JCOBridge -DartifactId=JCOBridge -Dversion=2.5.13 -Dpackaging=jar -Dfile=../../../bin/net8.0/JCOBridge.jar -f ./src/jvm/knet/pom.xml
-        shell: bash
-
       - name: Create Jars
         run: mvn --file ./src/jvm/knet/pom.xml --no-transfer-progress package
         env:

diff --git a/src/documentation/api/index.md b/src/documentation/api/index.md
@@ -3,6 +3,6 @@ title: APIs of .NET suite for Apache Kafka
 _description: Describes the current available APIs of .NET suite for Apache Kafka
 ---
 
-# KNet: .NET gateway for Apache Kafka APIs
+# KNet: .NET suite for Apache Kafka
 
 Open left menu to browse API