Merge pull request #244 from com-pas/develop

Merge develop into main

Author: SaintierFr

.github/workflows/automate_javadoc.yml

@@ -1,27 +1,29 @@
-# SPDX-FileCopyrightText: 2022 RTE FRANCE
+# SPDX-FileCopyrightText: 2022 2023 RTE FRANCE
 #
 # SPDX-License-Identifier: Apache-2.0
 name: Continuous Deployment - JavaDocs
 
 on:
-  push:
-    branches:
-      - 'feat/javadoc'
+  pull_request_target:
+    types: [ labeled, closed ]
+
 jobs:
   build:
+    if: ${{  github.event.pull_request.base.ref == 'develop' && github.actor != 'dependabot[bot]' && github.event.pull_request.merged && contains(github.event.pull_request.labels.*.name, 'javadoc') }}
     name: Java Docs
     runs-on: ubuntu-latest
     env:
-      from_branch: feat/javadoc
-      target_branch: feat/117_Documentation_SCD_Generation_Process
+      DEPLOYMENT_BRANCH: gh-pages
+      DEPENDABOT_BRANCH: dependabot/javadoc-${{ github.head_ref || github.ref_name }}-${{ github.event.pull_request.number }}
     steps:
-      # Use develop as base branch to generate javadoc
-      - name: Setup Environment
+      - name: Checkout
         uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
         with:
           distribution: 'zulu'
           java-version: '17'
-          ref: ${{ env.target_branch }}
 
       - name: Create custom Maven Settings.xml
         uses: whelk-io/maven-settings-xml-action@v21
@@ -33,6 +35,8 @@ jobs:
         run: |
           git config --global user.name '${{ secrets.CONFIG_CI_USER_NAME }}'
           git config --global user.email '${{ secrets.CONFIG_CI_USER_EMAIL }}'
+          git config pull.rebase false
+          git fetch origin ${{ env.DEPLOYMENT_BRANCH }}
 
       - name: Import GPG key
         id: import_gpg
@@ -42,27 +46,25 @@ jobs:
           git_user_signingkey: true
           git_commit_gpgsign: true
 
-      - name: Prepare Pull Request branch
+      # Take note that your GitHub Pages site is currently being built from the /docs folder in the DEPLOYMENT_BRANCH branch.
+      - name: Prepare Pull Request branch & commit files
         run: |
           mvn -s custom_maven_settings.xml clean javadoc:aggregate -P javadoc
           mkdir -p docs/javadoc
           yes | cp -Rf target/site/apidocs/* docs/javadoc/
-          git checkout -b ${{ env.from_branch }}-pull-request
+          git checkout -b temp
+          git add docs/javadoc/
+          git commit -m "[dependabot/javadoc/temp]: update javadoc"
+          git checkout ${{ env.DEPLOYMENT_BRANCH }}
+          git clean -fdx
+          git checkout -b ${{ env.DEPENDABOT_BRANCH }}
+          git cherry-pick -n -X theirs temp
+          git commit -m "[dependabot/javadoc]: update javadoc"
+          git checkout ${{ env.DEPLOYMENT_BRANCH }}
+          git merge ${{ env.DEPENDABOT_BRANCH }}
 
-      # Note that will fail if branch already exists.
       - name: Push Git Branch
         uses: ad-m/[email protected]
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: ${{ env.from_branch }}-pull-request
-
-      # Note that will silently fail if PR already exists.
-      - name: Create Pull Request
-        uses: repo-sync/pull-request@v2
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          source_branch: ${{ env.from_branch }}-pull-request
-          destination_branch: ${{ env.target_branch }}
-          pr_title: "Docs: Update Java docs repository"
-          pr_body: "Automatically created from CI workflow"
-          pr_label: "documentation,javadoc"
+          branch: ${{ env.DEPLOYMENT_BRANCH }}

.github/workflows/automate_projects.yml

@@ -14,29 +14,29 @@ jobs:
     steps:
       - name: add-new-issues-to-repository-based-project-column
         if: github.event_name == 'issues' && github.event.action == 'opened'
-        uses: alex-page/[email protected].2
+        uses: alex-page/[email protected].3
         with:
           project: CoMPAS SCT Board
           column: To do
           repo-token: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
       - name: add-new-pull-request-to-repository-based-project-column
         if: (github.event_name == 'pull_request' || github.event_name == 'pull_request_target') && github.event.action == 'opened'
-        uses: alex-page/[email protected].2
+        uses: alex-page/[email protected].3
         with:
           project: CoMPAS SCT Board
           column: To do
           repo-token: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
 
       - name: add-new-issues-to-organization-based-project-column
         if: github.event_name == 'issues' && github.event.action == 'opened'
-        uses: alex-page/[email protected].2
+        uses: alex-page/[email protected].3
         with:
           project: CoMPAS Issues Overview Board
           column: To do
           repo-token: ${{ secrets.ORG_GITHUB_ACTION_SECRET }}
       - name: add-new-pull-request-to-organization-based-project-column
         if: (github.event_name == 'pull_request' || github.event_name == 'pull_request_target') && github.event.action == 'opened'
-        uses: alex-page/[email protected].2
+        uses: alex-page/[email protected].3
         with:
           project: CoMPAS Pull Request Overview Board
           column: To do

.github/workflows/sonarcloud-analysis.yml

@@ -26,24 +26,18 @@ jobs:
           key: ${{ runner.os }}-sonar
           restore-keys: ${{ runner.os }}-sonar
 
-      - name: Cache Maven packages
-        uses: actions/cache@v3
-        with:
-          path: ~/.m2
-          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
-          restore-keys: ${{ runner.os }}-m2
-
       - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
           distribution: 'zulu'
           java-version: '17'
+          cache: 'maven'
 
       - name: Set Common Sonar Variables
         id: sonar_env
         run: |
           echo "##[set-output name=sonar_opts;]$(echo -Dsonar.host.url=https://sonarcloud.io \
-            -Dsonar.projectKey=com-pas_compas-core \
+            -Dsonar.projectKey=com-pas_compas-sct \
             -Dsonar.organization=com-pas )"
       - name: Create custom Maven Settings.xml
         uses: whelk-io/maven-settings-xml-action@v21

docs/HOME.md

@@ -39,7 +39,7 @@ Technical Steering Committee [[email protected]](mailto:CoMPAS-tsc@l
 By contributing to the CoMPAS project, you accept and agree to the following terms and conditions for your present and future contributions submitted to CoMPAS.
 
 All contributions to this project are licensed under the license stipulated at the corresponding sub-repository. 
-Except where otherwise explicitely indicated, CoMPAS is an open source project licensed under the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0/).
+Except where otherwise explicitly indicated, CoMPAS is an open source project licensed under the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0/).
 
 The project requires the use of the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). 
 The DCO is a legally binding statement asserting that you are you have the right to submit your contribution and to license it under the project's applicable license.
@@ -64,21 +64,21 @@ Note that checks will be performed during the integration in order to require th
 
 ## Community refinements
 
-Every monday there is a CoMPAS Community Refinement at 10AM CET. The event is available at the CoMPAS mailing list [calendar](https://lists.lfenergy.org/g/CoMPAS/calendar) and can be subscribed to.
+Every Monday there is a CoMPAS Community Refinement at 10AM CET. The event is available at the CoMPAS mailing list [calendar](https://lists.lfenergy.org/g/CoMPAS/calendar) and can be subscribed to.
 
 ### Prepared topics
 
-Every friday before the refinement meeting on Monday, all topics are published on the #compas channel on our [LFEnergy Slack](https://lfenergy.slack.com/).
+Every Friday before the refinement meeting on Monday, all topics are published on the #compas channel on our [LFEnergy Slack](https://lfenergy.slack.com/).
 
 ### Add your own topics
 
-Everybody can suggest topics for the refinement. To do this, join the [LFEnergy Slack](https://lfenergy.slack.com/) if not already, and put your topics in the #compas channel. You can just do this by writing a message like "I want to add something to the refinement this monday, namely..." or add a comment to the already prepared topics if available (see [Prepared topics](#prepared-topics)).
+Everybody can suggest topics for the refinement. To do this, join the [LFEnergy Slack](https://lfenergy.slack.com/) if not already, and put your topics in the #compas channel. You can just do this by writing a message like "I want to add something to the refinement this Monday, namely..." or add a comment to the already prepared topics if available (see [Prepared topics](#prepared-topics)).
 
 ### Reporting Bugs and Suggesting Enhancements
 
 Bugs and enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue in the repository where it belongs (an issue about the CIM to IEC 61850 mapping belongs in the [CIM Mapping repository](https://github.com/com-pas/compas-cim-mapping) for example) and provide the following information by filling in the template, which is either an issue or a bug.
 
-When an issue is created, it is automatically being added to the `To do` column of the specific repository. This means it's added, but not yet refined. Every monday at 10AM CET, there is a Community Refinement (see our mailing list [calendar](https://lists.lfenergy.org/g/CoMPAS/calendar), everybody can join) where issues are being discussed that are not refined yet. Your issue is one of them.
+When an issue is created, it is automatically being added to the `To do` column of the specific repository. This means it's added, but not yet refined. Every Monday at 10AM CET, there is a Community Refinement (see our mailing list [calendar](https://lists.lfenergy.org/g/CoMPAS/calendar), everybody can join) where issues are being discussed that are not refined yet. Your issue is one of them.
 Once it's accepted and refined, it goes to the `Ready for development` column and it's ready to be implemented/fixed.
 
 Before creating bug reports or suggesting enhancement, please **perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Acom-pas)** 
@@ -118,8 +118,8 @@ Continuous integration is set up to run on all branches automatically and will o
 ### Tools to contribute
 
 Continuous integration is setup automatically on all contributions. However, it's faster to iterate locally to fix problems than waiting for the status checks to finish. 
-There are many tools that can be used to do the verifications that are enforced by all status checks. The most simple and universal tool is maven, but IDE integrations 
-can be used to get more immediate feedback. Most of the team uses IntelliJ IDEA, but others IDEs can be used, for exemple the Eclipse IDE.
+There are many tools that can be used to do the verifications that are enforced by all status checks. The most simple and universal tool is Maven, but IDE integrations 
+can be used to get more immediate feedback. Most of the team uses IntelliJ IDEA, but others IDEs can be used, for example the Eclipse IDE.
 
 ### Definition of Done
 
@@ -147,7 +147,7 @@ On the [developing](https://com-pas.github.io/contributing/DEVELOPING.html) page
 
 #### Open Community Calls
 
-It's good to know that every other monday, we are having a so called Open Community Call. Everyone participating in the CoMPAS project can join 
+It's good to know that every other Monday, we are having a so called Open Community Call. Everyone participating in the CoMPAS project can join 
 and talk about and ask question about the CoMPAS project.
 
 When the Open Community Calls are taking place, can be found at the [General CoMPAS mailing list calendar](https://lists.lfenergy.org/g/CoMPAS/calendar).
@@ -167,7 +167,7 @@ A good (open source) project requires documentation. We have two places for our
 
 ##### LF Energy Wiki
 
-LF Energy has it's own [CoMPAS specific Wiki](https://wiki.lfenergy.org/display/HOME/CoMPAS). This is the place for documenation 
+LF Energy has it's own [CoMPAS specific Wiki](https://wiki.lfenergy.org/display/HOME/CoMPAS). This is the place for documentation 
 about CoMPAS in general (like roadmap and the community call agendas).
 
 #### Architecture and technologies
@@ -178,7 +178,7 @@ please check the source code (duh!) and our [CoMPAS Architecture Github Pages](h
 ### Copyright and Licensing
 
 Copyright and license information is done on per-file basis. We use the specification of [REUSE](https://reuse.software/spec/)
-to ensure that copyright information of the project is clear and can be analuzed in an automated fashion.
+to ensure that copyright information of the project is clear and can be analyzed in an automated fashion.
 
 Every source code repository within CoMPAS has a Github Action for checking against the REUSE specification.
 

docs/compas-sct.md

@@ -170,7 +170,7 @@ import it in the temporary SCD file
 </SCL>
 ```
 Operations can now be realized and validated on this minimal file (which has the same structure as an ICD file). 
-Any validation on the minimal file guaranties a valid integration of those chunks into the large file.
+Any validation on the minimal file guarantees a valid integration of those chunks into the large file.
 
 > **WARNING:** This concern only update/creation operations on SCL file.
 

pom.xml

@@ -218,7 +218,6 @@
                         <configuration>
                             <doctitle>${javadoc.title}</doctitle>
                             <doclint>${javadoc.lint}</doclint>
-                            <additionalJOption>--no-module-directories</additionalJOption>
                         </configuration>
                     </plugin>
                 </plugins>

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;

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/ExtrefTarget.java

@@ -0,0 +1,9 @@
+// SPDX-FileCopyrightText: 2023 RTE FRANCE
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.lfenergy.compas.sct.commons.dto;
+
+public enum ExtrefTarget {
+    SRC_REF, SRC_CB
+}

sct-commons/src/main/java/org/lfenergy/compas/sct/commons/dto/SclReport.java

@@ -39,5 +39,4 @@ public class SclReport {
     public boolean isSuccess() {
         return sclReportItems.stream().noneMatch(SclReportItem::isFatal);
     }
-
 }

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;