Updated/Added documentation and update of aggregate file.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

DEVELOPMENT.md

@@ -8,15 +8,17 @@ SPDX-License-Identifier: Apache-2.0
 
 ## Git
 
-If the project is already cloned and a submodule is added use the following commands, first `git submodule init` and
-next `git submodule update`.
+If the project is already cloned and a submodule is added use the following commands to retrieve the files from the
+RiseClipse Repository, first `git submodule init` and next `git submodule update`.
 
 More about Git Submodules can be found [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
 
 **Remark**: The URLs to the submodules are configured in the file `.gitmodules`, but these are using the SSH URLs. There
 is a way described [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules) that the URL can be overwritten locally
-with an HTTPS URL of the GIT Repository. Because of the subdirectory where the submodules are in, this doesn't work
-exactly that way. Use the following commands to update the URLs locally to HTTPS.
+with an HTTPS URL of the GIT Repository.
+
+Because of the subdirectory where the submodules are in, this doesn't work exactly that way. Use the following commands
+to update the URLs locally to HTTPS.
 
 ```
 git config submodule.riseclipse/riseclipse-developer.url https://github.com/riseclipse/riseclipse-developer.git
@@ -28,31 +30,28 @@ git submodule init
 git submodule update
 ```
 
-## IntelliJ
+### Git update Submodules
+
+A submodule in Git is fixed to a specific commit of the remote repository. To update the reference to the latest commit
+in the remote repository execute the following command from the root directory of the project.
 
-Importing the project is a bit harder for the SCL Validator then normal. It's caused because of the submodules that are
-needed from RiseClipse. These projects are Eclipse projects using Eclipse Tycho to build and Eclipse project structure.
+```
+git submodule update --remote
+```
 
-The first step to make it work in IntelliJ is that an Eclipse version needs to be available on your local machine. The
-version we know that's working can be found [here](https://www.eclipse.org/downloads/packages/release/2019-06/r)
-Download (and install/unzip) Eclipse.
+Next add the changes and commit/push these to the Git Repository of CoMPAS. The build now uses the latest commit of the
+main branch.
 
-Next a way to make everything work in IntelliJ is importing the project in the following way.
+## Eclipse
 
-- First step is to just import everything like it are Maven projects;
-- Next we need to add a Global Library in IntelliJ. Open the Module Settings and select "Global Libraries". And a new
-  libraries and name it "ECLIPSE". Point it to the directory "<ECLIPSE_INSTALL_DIR>/plugins";
-- Next step is to re-import the RiseClipse Submodule as Eclipse;
-  - In IntelliJ select "File" -> "New" -> "Module from Existing Sources...";
-  - Select one of the RiseClipse Submodules, for instance "riseclipse-metamodel-scl2003";
-  - Next select "Eclipse" by "Import module from External Model";
-  - Follow the rest of the wizard, only to remember to select all subprojects that are available in the directory;
+### Eclipse Dependencies
 
-Now the module should be correctly imported in IntelliJ to be used. Check the Module Settings of one of the subprojects
-to check if the directory "src" is a Java Source Directory, for instance the module
-"riseclipse/riseclipse-metamodel-scl2003/fr.centralesupelec.edf.riseclipse.iec61850.scl.utilities".
+To make everything build and run Eclipse Dependencies are needed, but unlike the RiseClipse Dependencies these can't be
+found in the Maven Central Repository, but in an Eclipse P2 Repository. In RiseClipse there is a p2-to-m2 project that
+creates a local Maven Repository from the needed dependencies from the Eclipse P2 Repository. A CoMPAS Version of this
+maven module is created here, see [README.md](riseclipse/riseclipse-p2-to-m2/README.md) for more info.
 
-## Eclipse
+### Eclipse OCL
 
 Example about how to use Eclipse OCL was found
 [here](https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.ocl.doc%2Fhelp%2FPivotStandalone.html).

README.md

@@ -28,19 +28,20 @@ automatically determine the URL to be used.
 
 ## Development
 
-For the RiseClipse implementation of the validator parts of the RiseClipse project are being used. Currently, these
-parts aren't distributed to any Maven Repository, so the Git Repositories need to be included. This is done using Git
-Submodules.
+Since version 1.2.x the JAR Files of RiseClipse are distributed on Maven Central Repository. This way the JAR Files can
+be retrieved from there and don't need to be build locally anymore. Only the OCL Files for the SCL validation still need
+to be downloaded from RiseClipse GIT Repository. This is still done using Git Submodules.
 
 To clone the project or update the project this means that the Git commands are sometimes a little different. To clone
 the project use the following command `git clone --recurse-submodules [email protected]:com-pas/compas-scl-validator.git`.
 This will also clone the submodules.
 
 Tip: The URL to the submodules are configured in the file `.gitmodules`, but these are using the SSH URL. There is a way
-described in the URL above that the URL can be overwritten locally with an HTTPS URL of the GIT Repository.
+described [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to overwrite the URL locally with an HTTPS URL of
+the GIT Repository.
 
-Check the [Development](DEVELOPMENT.md) page for more detail information how to work with this repository, because of
-the mixture with RiseClipse.
+Check the [Development](DEVELOPMENT.md) page for more detail information how to develop in this repository, because of
+the Git submodule and Eclipse Repository needed to make RiseClipse work.
 
 ## Custom OCL Files
 

riseclipse/pom.xml

@@ -28,6 +28,7 @@ SPDX-License-Identifier: Apache-2.0
         <eclipse.emf.common.version>2.24.0</eclipse.emf.common.version>
         <eclipse.ocl.version>1.17.0</eclipse.ocl.version>
         <antlr.runtime.version>3.2.0</antlr.runtime.version>
+
         <riseclipse.scl.version>1.2.3</riseclipse.scl.version>
         <riseclipse.main.version>1.2.5</riseclipse.main.version>
 

riseclipse/riseclipse-p2-to-m2/README.md

@@ -7,5 +7,16 @@ SPDX-License-Identifier: Apache-2.0
 This project is used to create maven artifacts from Eclipse plugins. This is needed for building the executable jar to
 run in a Docker Container.
 
-The `src/main/resources/riseclipse.aggr` file should be edited with the
-[CBI/aggregator](https://wiki.eclipse.org/CBI/aggregator) tool.
+The project is a copy of the p2_to_m2 project
+from [RiseClipse Developer](https://github.com/riseclipse/riseclipse-developer)
+of the directory 'fr.centralesupelec.edf.riseclipse.developer.p2_to_m2'.
+
+The file `src/main/resources/riseclipse.aggr` is also a copy of the file from RiseClipse and can be found
+[here](https://github.com/riseclipse/riseclipse-developer/blob/master/fr.centralesupelec.edf.riseclipse.developer.p2_to_m2/src/main/resources/riseclipse.aggr)
+. This file needs to be updated manually.
+
+**Remark RiseClipse**: The `src/main/resources/riseclipse.aggr` file should be edited with
+the [CBI/aggregator](https://wiki.eclipse.org/CBI/aggregator) tool.
+
+**Remark CoMPAS**: Because we only need this small part of the RiseClipse Developer GIT Repository and mainly 2 files
+(pom.xml (partially) and riseclipse.aggr) it didn't seem usefully to make a Git Submodule from it.

riseclipse/riseclipse-p2-to-m2/src/main/resources/riseclipse.aggr

@@ -1,9 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-SPDX-FileCopyrightText: 2022 Alliander N.V.
-
-SPDX-License-Identifier: Apache-2.0
--->
 <aggregator:Aggregation xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:aggregator="http://www.eclipse.org/cbi/p2repo/2011/aggregator/1.1.0" label="Eclipse Projects for RiseClipse" packedStrategy="UNPACK" mavenResult="true" versionFormat="MavenRelease">
   <validationSets label="Eclipse needed projects for RiseClipse">
     <contributions label="Eclipse Platform 2021-12">
@@ -51,6 +46,7 @@ SPDX-License-Identifier: Apache-2.0
         <bundles name="org.antlr.runtime" versionRange="[3.2.0,3.3.0)"/>
         <bundles name="org.apache.commons.lang3" versionRange="3.1.0"/>
         <bundles name="org.apache.log4j" versionRange="1.2.15"/>
+        <bundles name="org.apache.commons.cli" versionRange="1.4.0"/>
       </repositories>
     </contributions>
     <validationRepositories location="https://download.eclipse.org/releases/2021-12/202112081000/"/>
@@ -59,4 +55,4 @@ SPDX-License-Identifier: Apache-2.0
   <configurations architecture="x86_64"/>
   <configurations operatingSystem="linux" windowSystem="gtk" architecture="x86_64"/>
   <configurations operatingSystem="macosx" windowSystem="cocoa" architecture="x86_64"/>
-</aggregator:Aggregation>
+</aggregator:Aggregation>