feat/javadoc : [AUTOMATE JAVADOC]

Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com> feat/javadoc manifest test fixes#jdk17 Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com> fixes : microprofile/microprofile-fault-tolerance#512 , NationalSecurityAgency/ghidra#1284 Signed-off-by: Samir Romdhani <samir.romdhani@rte-france.com>
samirromdhani · Jan 26, 2023 · 50ab010 · 50ab010
1 parent 29aa5fa
commit 50ab010
Show file tree

Hide file tree

Showing 13 changed files with 31 additions and 20 deletions.
diff --git a/.github/dependabot.yml → .github/dependabot.txt b/.github/dependabot.yml → .github/dependabot.txt
diff --git a/.github/workflows/automate_javadoc.yml b/.github/workflows/automate_javadoc.yml
@@ -13,15 +13,22 @@ jobs:
     runs-on: ubuntu-latest
     env:
       from_branch: feat/javadoc
-      target_branch: feat/117_Documentation_SCD_Generation_Process
+      target_branch: develop
     steps:
-      # Use develop as base branch to generate javadoc
-      - name: Setup Environment
+      - name: Checkout
         uses: actions/checkout@v3
+      # Use develop as base branch to generate javadoc
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
         with:
           distribution: 'zulu'
           java-version: '17'
-          ref: ${{ env.target_branch }}
+#      - name: Setup Environment
+#        uses: actions/checkout@v3
+#        with:
+#          distribution: 'zulu'
+#          java-version: '17'
+#          ref: ${{ env.from_branch }}
 
       - name: Create custom Maven Settings.xml
         uses: whelk-io/maven-settings-xml-action@v21
@@ -49,6 +56,10 @@ jobs:
           yes | cp -Rf target/site/apidocs/* docs/javadoc/
           git checkout -b ${{ env.from_branch }}-pull-request
 
+      - name: Commit files
+        run: |
+          git commit -a -m "[feat/javadoc]: update javadoc"
+          
       # Note that will fail if branch already exists.
       - name: Push Git Branch
         uses: ad-m/github-push-action@v0.6.0

diff --git a/.github/workflows/automate_projects.yml → .github/workflows/automate_projects.txt b/.github/workflows/automate_projects.yml → .github/workflows/automate_projects.txt
diff --git a/.github/workflows/sonarcloud-analysis.yml → .github/workflows/sonarcloud-analysis.txt b/.github/workflows/sonarcloud-analysis.yml → .github/workflows/sonarcloud-analysis.txt
diff --git a/pom.xml b/pom.xml
@@ -218,7 +218,7 @@
                         <configuration>
                             <doctitle>${javadoc.title}</doctitle>
                             <doclint>${javadoc.lint}</doclint>
-                            <additionalJOption>--no-module-directories</additionalJOption>
+<!--                            <additionalJOption>&#45;&#45;no-module-directories</additionalJOption>-->
                         </configuration>
                     </plugin>
                 </plugins>

diff --git a/sct-app/src/main/java/org/lfenergy/compas/sct/app/package-info.java b/sct-app/src/main/java/org/lfenergy/compas/sct/app/package-info.java
@@ -3,6 +3,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /**
- * <h3>sct-app is a group of automation services</h3>
+ * <h2>sct-app is a group of automation services</h2>
  */
 package org.lfenergy.compas.sct.app;
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/package-info.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/package-info.java
@@ -3,8 +3,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /**
- *  <h3>sct.commons.dto is a group of DTO utils for operating on
+ *  <h2>sct.commons.dto is a group of DTO utils for operating on
  *      {@link org.lfenergy.compas.scl2007b4.model.SCL SCL} services
- *  </h3>
+ *  </h2>
  */
 package org.lfenergy.compas.sct.commons.dto;
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/com/package-info.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/com/package-info.java
@@ -3,9 +3,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /**
- * <h3>scl.com is a group of services for operating on
+ * <h2>scl.com is a group of services for operating on
  *  {@link org.lfenergy.compas.scl2007b4.model.TCommunication Communication} object
- * </h3>
+ * </h2>
  * @see org.lfenergy.compas.scl2007b4.model.TCommunication
  * @see org.lfenergy.compas.scl2007b4.model.TSubNetwork
  * @see org.lfenergy.compas.scl2007b4.model.TConnectedAP

diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/dtt/package-info.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/dtt/package-info.java
@@ -3,9 +3,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /**
- * <h3>scl.dtt is a group of services for operating on
+ * <h2>scl.dtt is a group of services for operating on
  *  {@link org.lfenergy.compas.scl2007b4.model.TDataTypeTemplates DataTypeTemplates} object
- *  </h3>
+ *  </h2>
  * @see org.lfenergy.compas.scl2007b4.model.TLNodeType
  * @see org.lfenergy.compas.scl2007b4.model.TDOType
  * @see org.lfenergy.compas.scl2007b4.model.TDAType

diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/header/package-info.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/header/package-info.java
@@ -3,9 +3,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /**
- * <h3>scl.header is a group of services for operating on
+ * <h2>scl.header is a group of services for operating on
  *  {@link org.lfenergy.compas.scl2007b4.model.THeader Header} object
- *  </h3>
+ *  </h2>
  * @see org.lfenergy.compas.scl2007b4.model.THeader
  * @see org.lfenergy.compas.scl2007b4.model.THitem
  * @see <a href="https://github.com/com-pas/compas-sct/issues/6" target="_blank">Issue !6</a>

diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/ied/package-info.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/ied/package-info.java
@@ -3,9 +3,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /**
- * <h3>scl.ied is a group of services for operating on
+ * <h2>scl.ied is a group of services for operating on
  *  {@link org.lfenergy.compas.scl2007b4.model.TIED IED} object
- *  </h3>
+ *  </h2>
  * @see org.lfenergy.compas.scl2007b4.model.TAccessPoint
  * @see org.lfenergy.compas.scl2007b4.model.TServices
  * @see org.lfenergy.compas.scl2007b4.model.TLDevice

diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/package-info.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/package-info.java
@@ -3,13 +3,13 @@
 // SPDX-License-Identifier: Apache-2.0
 
 /**
- * <h3>commons.scl is a group of services for operating on
+ * <h2>commons.scl is a group of services for operating on
  *      {@link org.lfenergy.compas.scl2007b4.model.THeader Header} ,
  *      {@link org.lfenergy.compas.scl2007b4.model.TSubstation Substation} ,
  *      {@link org.lfenergy.compas.scl2007b4.model.TCommunication Communication} ,
  *      {@link org.lfenergy.compas.scl2007b4.model.TIED IED} ,
  *      {@link org.lfenergy.compas.scl2007b4.model.TDataTypeTemplates DataTypeTemplates} objects
- *  </h3>
+ *  </h2>
  * @see org.lfenergy.compas.scl2007b4.model.SCL
  */
 package org.lfenergy.compas.sct.commons.scl;
diff --git a/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/sstation/package-info.java b/sct-commons/src/main/java/org/lfenergy/compas/sct/commons/scl/sstation/package-info.java
@@ -2,9 +2,9 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 /**
- * <h3>scl.sstation is a group of services for operating on
+ * <h2>scl.sstation is a group of services for operating on
  *  {@link org.lfenergy.compas.scl2007b4.model.TSubstation Substation} object
- *  </h3>
+ *  </h2>
  * @see org.lfenergy.compas.scl2007b4.model.TVoltageLevel
  * @see org.lfenergy.compas.scl2007b4.model.TFunction
  * @see org.lfenergy.compas.scl2007b4.model.TBay