Merge branch 'develop' into feature/camera-component

Author: leandrumartin

.github/workflows/asciidoc-build.yml

@@ -3,25 +3,26 @@ name: build adocs
 on:
   push:
     branches:
-    - main
-    - develop
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+  workflow_call:
 
 jobs:
   adoc_build:
     runs-on: ubuntu-latest
     name: ASCII DOC build
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v2
-    - name: Get build container
-      id: adocbuild
-      uses: tonynv/asciidoctor-action@master
-      with:
-          program: "./gradlew asciidoctor"
-    - name: Deploy docs to ghpages
-      uses: peaceiris/actions-gh-pages@v3
-      with: 
-        deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        publish_branch: gh-pages
-        publish_dir: ./pi4micronaut-utils/build/docs/asciidoc/
-
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Get build container
+        uses: tonynv/asciidoctor-action@v2
+        with:
+            program: "./gradlew asciidoctor"
+      - name: Upload AsciiDoc output
+        uses: actions/upload-artifact@v4
+        with:
+          name: asciidoc-output
+          path: pi4micronaut-utils/build/docs/asciidoc/

.github/workflows/asciidoc-publish.yml

@@ -0,0 +1,31 @@
+name: Publish AsciiDoc
+permissions:
+  contents: read
+on:
+  workflow_call:
+    secrets:
+      ACTIONS_DEPLOY_KEY:
+        required: true
+
+jobs:
+  build:
+    uses: ./.github/workflows/asciidoc-build.yml
+  adoc_publish:
+    needs: build
+    runs-on: ubuntu-latest
+    name: ASCII DOC publish
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Download AsciiDoc output
+        uses: actions/download-artifact@v4
+        with:
+          name: asciidoc-output
+          path: pi4micronaut-utils/build/docs/asciidoc/
+      - name: Deploy docs to ghpages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_branch: gh-pages
+          publish_dir: ./pi4micronaut-utils/build/docs/asciidoc/
+          keep_files: true

.github/workflows/build-reusable.yml

@@ -5,7 +5,7 @@ on:
 
 permissions:
   attestations: write
-  contents: read
+  contents: write
   id-token: write
   packages: write
 
@@ -24,6 +24,10 @@ jobs:
         uses: gradle/actions/setup-gradle@v4
         with:
           cache-read-only: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/develop' }}
+      - name: Configure Git user
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
       - name: Bump version (nebula final)
         if: github.ref == 'refs/heads/main'
         working-directory: .
@@ -72,6 +76,7 @@ jobs:
       - uses: actions/attest-build-provenance@v1
         with:
           subject-path: 'pi4micronaut-utils/build/libs/**/*.jar'
+
   create-release:
     runs-on: ubuntu-latest
     needs: [build-library, publish-jar]
@@ -111,4 +116,4 @@ jobs:
           gh release create "${{ steps.read_version.outputs.version }}" \
             --verify-tag \
             --generate-notes \
-            "pi4micronaut-utils/build/libs/pi4micronaut-utils-${{ steps.read_version.outputs.version }}-all.jar"
+            "pi4micronaut-utils/build/libs/pi4micronaut-utils-${{ steps.read_version.outputs.version }}-all.jar"

.github/workflows/javadoc-gh-pages.yml

@@ -4,10 +4,7 @@ permissions:
   pages: write
   id-token: write
 on:
-  push:
-    branches:
-      - main
-      - develop
+  workflow_call:
 
 jobs:
   build:
@@ -43,14 +40,10 @@ jobs:
         with:
           name: javadoc
           path: ./javadoc
-          retention-days: 1
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v4
-        if: github.ref == 'refs/heads/develop'
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
           publish_dir: ./javadoc
           destination_dir: javadoc
           keep_files: true
-          user_name: 'github-actions[bot]'
-          user_email: 'github-actions[bot]@users.noreply.github.com'

.github/workflows/publish-docs.yml

@@ -0,0 +1,17 @@
+name: Publish Documentation
+permissions:
+  contents: write
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish-asciidoc:
+    uses: ./.github/workflows/asciidoc-publish.yml
+    secrets:
+      ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+
+  publish-javadoc:
+    needs: publish-asciidoc
+    uses: ./.github/workflows/javadoc-gh-pages.yml

codemeta.json

@@ -220,6 +220,7 @@
   "description": " A Java library combining Micronaut and Pi4j to streamline hardware connectivity to Raspberry Pis",
   "developmentStatus": "active",
   "downloadUrl": "https://central.sonatype.com/artifact/io.github.oss-slu/pi4micronaut-utils",
+  "issueTracker": "https://github.com/oss-slu/Pi4Micronaut/issues",
   "keywords": [
     "Raspberry Pi",
     "Java",
@@ -230,6 +231,10 @@
   "programmingLanguage": [
     "Java"
   ],
+  "relatedLink": [
+    "https://oss-slu.github.io/Pi4Micronaut/",
+    "https://oss-slu.github.io/projects/pi4micronaut/about"
+  ],
   "runtimePlatform": [
     "JVM"
   ],

components/src/main/java/com/opensourcewithslu/components/controllers/PassiveBuzzerController.java

@@ -5,10 +5,13 @@
 import io.micronaut.http.annotation.*;
 import jakarta.inject.Named;
 import java.io.File;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 //tag::ex[]
 @Controller("/passive-buzzer")
 public class PassiveBuzzerController {
+    private static final Logger log = LoggerFactory.getLogger(PassiveBuzzerController.class);
     private final PassiveBuzzerHelper passiveBuzzerHelper;
 
     protected int passBuzzFreq = 440;
@@ -44,9 +47,7 @@ public void disablePassiveBuzzer(){
      */
     @Get("/showFreq")
     public void passiveBuzzerFreq(){
-
-        passiveBuzzerHelper.getFrequency();
-
+        log.info(String.valueOf(passiveBuzzerHelper.getFrequency()));
     }
 
     /**

pi4micronaut-utils/build.gradle

@@ -41,11 +41,11 @@ dependencies {
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.5.1'
     testImplementation 'org.junit.jupiter:junit-jupiter'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
-    testImplementation("org.mockito:mockito-core:5.+")
+    testImplementation("org.mockito:mockito-core:5.18.0")
     testImplementation(platform("org.junit:junit-bom:5.11.0"))
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine")
     testRuntimeOnly("org.junit.vintage:junit-vintage-engine")
-
+    testImplementation("org.mockito:mockito-junit-jupiter:5.18.0")
 }
 
 application {

pi4micronaut-utils/src/docs/asciidoc/components/outputComponents/fan.adoc

@@ -36,7 +36,7 @@ image::fanCircuit.png[]
 
 ===== Schematic Diagram
 
-image::fanSchmetic.png[]
+image::fanSchematic.png[]
 
 ===== YAML Configuration