Merge branch 'main' into feature/improve_wordsim

.github/workflows/deploy-nightly.yml

@@ -33,12 +33,12 @@ jobs:
       with:
         submodules: true
     - name: Set up JDK
-      uses: actions/setup-java@v2
+      uses: actions/setup-java@v3
       with:
-        distribution: 'zulu'
+        distribution: 'temurin'
         java-version: 17
     - name: Cache Maven packages
-      uses: actions/cache@v2.1.7
+      uses: actions/cache@v3
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

.github/workflows/deploy.yml

@@ -16,12 +16,12 @@ jobs:
       with:
         submodules: true
     - name: Set up JDK
-      uses: actions/setup-java@v2
+      uses: actions/setup-java@v3
       with:
-        distribution: 'zulu'
+        distribution: 'temurin'
         java-version: 17
     - name: Cache Maven packages
-      uses: actions/cache@v2.1.7
+      uses: actions/cache@v3
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Fix Deployment for GH Pages
+        run: mkdir -p docs/_build/dirhtml/ && touch docs/_build/dirhtml/.nojekyll
+
+      - uses: ammaraskar/sphinx-action@master
+        with:
+          pre-build-command: "mkdir -p /usr/share/man/man1 && apt-get update --allow-releaseinfo-change -y && apt-get install -y openjdk-11-jre"
+          docs-folder: "docs/"
+          build-command: make html dirhtml
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: docs/_build/dirhtml/
+          clean: true
+
+

.github/workflows/format.yml

@@ -17,13 +17,13 @@ jobs:
         submodules: true
         fetch-depth: 0
     - name: Set up JDK
-      uses: actions/setup-java@v2
+      uses: actions/setup-java@v3
       with:
-        distribution: 'zulu'
+        distribution: 'temurin'
         java-version: 17
 
     - name: Cache Maven packages
-      uses: actions/cache@v2.1.7
+      uses: actions/cache@v3
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

.github/workflows/sonarcloud.yml

@@ -21,19 +21,19 @@ jobs:
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
       - name: Set up JDK
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
-          distribution: 'zulu'
+          distribution: 'temurin'
           java-version: 17
 
       - name: Cache SonarCloud packages
-        uses: actions/cache@v2.1.7
+        uses: actions/cache@v3
         with:
           path: ~/.sonar/cache
           key: ${{ runner.os }}-sonar
           restore-keys: ${{ runner.os }}-sonar
       - name: Cache Maven packages
-        uses: actions/cache@v2.1.7
+        uses: actions/cache@v3
         with:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

.github/workflows/verify.yml

@@ -17,12 +17,12 @@ jobs:
       with:
         submodules: true
     - name: Set up JDK
-      uses: actions/setup-java@v2
+      uses: actions/setup-java@v3
       with:
-        distribution: 'zulu'
+        distribution: 'temurin'
         java-version: 17
     - name: Cache Maven packages
-      uses: actions/cache@v2.1.7
+      uses: actions/cache@v3
       with:
         path: ~/.m2
         key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

.gitignore

@@ -1,3 +1,5 @@
+.flattened-pom.xml
+
 tests/src/test/resources/testout/*
 
 tests/src/test/resources/config.properties

.mvn/maven.config

@@ -1,2 +1,2 @@
--Drevision=0.3-SNAPSHOT
+-Drevision=0.4-SNAPSHOT
 -DskipTests=false

README.md

@@ -18,20 +18,20 @@ The model can also contain a (java) code model that you can insert using the [Co
 ### Usage
 ```
 usage: java -jar ardoco-core-pipeline.jar
--c,--conf <arg>           path to the additional config file
--h,--help                 show this message
--i,--withimplementation   indicate that the model contains the code model
--m,--model <arg>          path to the owl model
--n,--name <arg>           name of the run
--o,--out <arg>            path to the output directory
--p,--provided             flag to show that ontology has text already
-						provided
--t,--text <arg>           path to the text file
+-c,--conf <arg>                  path to the additional config file
+-h,--help                        show this message
+-ma,--model-architecture <arg>   path to the architecture model
+-mc,--model-code <arg>           path to the java code model
+-n,--name <arg>                  name of the run
+-o,--out <arg>                   path to the output directory
+-p,--provided <arg>              path to a JSON Text (already
+								preprocessed)
+-t,--text <arg>                  path to the text file
 ```
 
-### Wiki
-For more information about the setup or the architecture have a look on the [wiki](https://github.com/ArDoCo/Core/wiki/Overview).
-The wiki is at some points deprecated, the general overview and setup should still hold.
+### Documentation
+For more information about the setup or the architecture have a look on the [docs](https://ardoco.github.io/Core).
+The docs are at some points deprecated, the general overview and setup should still hold.
 
 ### Case Studies / Benchmarks
 To test the Core, you could use case studies and benchmarks provided in ..

cli/pom.xml

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>edu.kit.kastel.mcse.ardoco</groupId>
+    <artifactId>core</artifactId>
+    <version>${revision}</version>
+  </parent>
+  <artifactId>cli</artifactId>
+  <properties>
+    <maven.deploy.skip>true</maven.deploy.skip>
+  </properties>
+  <dependencies>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-simple</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>commons-cli</groupId>
+      <artifactId>commons-cli</artifactId>
+      <version>1.5.0</version>
+    </dependency>
+    <dependency>
+      <groupId>edu.kit.kastel.mcse.ardoco</groupId>
+      <artifactId>pipeline</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <configuration>
+          <archive>
+            <manifest>
+              <mainClass>edu.kit.kastel.mcse.ardoco.core.pipeline.ArDoCoCLI</mainClass>
+            </manifest>
+          </archive>
+          <descriptorRefs>
+            <descriptorRef>jar-with-dependencies</descriptorRef>
+          </descriptorRefs>
+          <finalName>ardoco-core-pipeline</finalName>
+          <appendAssemblyId>false</appendAssemblyId>
+        </configuration>
+        <executions>
+          <execution>
+            <id>make-assembly</id>
+            <goals>
+              <goal>single</goal>
+            </goals>
+            <phase>package</phase>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>