Merge pull request #41 from catenax-ng/main

Prepeare Release 2.3.0

.github/workflows/codeql.yml

@@ -22,6 +22,17 @@ on:
     paths-ignore:
       - '**/*.md'
       - '**/*.txt'
+      - 'api/**'
+      - 'api-tests/**'
+      - 'charts/**'
+      - 'ci/**'
+      - 'docs/**'
+      - 'dev/**'
+      - 'testdata-transform/**'
+      - 'testing/**'
+      - 'uml-diagrams/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
   schedule:
     - cron: '0 1 * * 1-5' # At 01:00 on every day-of-week from Monday through Friday.
 

.github/workflows/eclipse-dash.yml

@@ -12,6 +12,17 @@ on:
     paths-ignore:
       - '**/*.md'
       - '**/*.txt'
+      - 'api/**'
+      - 'api-tests/**'
+      - 'charts/**'
+      - 'ci/**'
+      - 'docs/**'
+      - 'dev/**'
+      - 'testdata-transform/**'
+      - 'testing/**'
+      - 'uml-diagrams/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
 
 jobs:
   build:

.github/workflows/irs-build.yml

@@ -6,6 +6,17 @@ on:
     paths-ignore:
       - '**/*.md'
       - '**/*.txt'
+      - 'api/**'
+      - 'api-tests/**'
+      - 'charts/**'
+      - 'ci/**'
+      - 'docs/**'
+      - 'dev/**'
+      - 'testdata-transform/**'
+      - 'testing/**'
+      - 'uml-diagrams/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
   push:
     branches:
       - main
@@ -15,6 +26,29 @@ on:
 
 jobs:
   build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Cache maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+
+      - name: Build with Maven
+        run: |
+          mvn clean verify --batch-mode
+
+  analyze_with_Sonar:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -41,13 +75,13 @@ jobs:
           key: ${{ runner.os }}-sonar
           restore-keys: ${{ runner.os }}-sonar
 
-      - name: Build with Maven and analyze with Sonar
+      - name: Analyze with Sonar
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         run: |
-          mvn --batch-mode --update-snapshots \
-          verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar \
+          mvn --batch-mode --update-snapshots verify \
+          org.sonarsource.scanner.maven:sonar-maven-plugin:sonar \
           -Dsonar.projectKey=${{ secrets.SONAR_PROJECT_KEY }} -Dsonar.organization=${{ secrets.SONAR_ORGANIZATION }}
 
   build_images:

.github/workflows/owasp.yml

@@ -11,6 +11,17 @@ on:
     paths-ignore:
       - '**/*.md'
       - '**/*.txt'
+      - 'api/**'
+      - 'api-tests/**'
+      - 'charts/**'
+      - 'ci/**'
+      - 'docs/**'
+      - 'dev/**'
+      - 'testdata-transform/**'
+      - 'testing/**'
+      - 'uml-diagrams/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
   schedule:
     - cron: '0 0 * * *' # Once a day
 

.github/workflows/spotbugs.yml

@@ -11,6 +11,17 @@ on:
     paths-ignore:
       - '**/*.md'
       - '**/*.txt'
+      - 'api/**'
+      - 'api-tests/**'
+      - 'charts/**'
+      - 'ci/**'
+      - 'docs/**'
+      - 'dev/**'
+      - 'testdata-transform/**'
+      - 'testing/**'
+      - 'uml-diagrams/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
   schedule:
     - cron: '0 0 * * *' # Once a day
 

.github/workflows/xray-cucumber.yaml

@@ -12,6 +12,17 @@ on:
     paths-ignore:
       - '**/*.md'
       - '**/*.txt'
+      - 'api/**'
+      - 'api-tests/**'
+      - 'charts/**'
+      - 'ci/**'
+      - 'docs/**'
+      - 'dev/**'
+      - 'testdata-transform/**'
+      - 'testing/**'
+      - 'uml-diagrams/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
 
 jobs:
   build:

AUTHORS.md

@@ -0,0 +1,18 @@
+# Authors
+
+The following people have contributed to this repository:
+
+- Jaro Hartmann, doubleSlash Net-Business GmbH, https://github.com/ds-jhartmann
+- Jan Kreutzfeld, doubleSlash Net-Business GmbH, https://github.com/ds-jkreutzfeld
+- Martin Kanal, doubleSlash Net-Business GmbH, https://github.com/mkanal
+- Johannes Zahn, BMW Group, https://github.com/jzbmw
+- Oladapo Oyeneye, doubleSlash Net-Business GmbH, https://github.com/ds-ext-ooyeneye
+- Krzysztof Massalski, doubleSlash Net-Business GmbH, https://github.com/ds-ext-kmassalski
+- Sebastian Scherer, Mercedes Benz AG, https://github.com/the-tatanka
+- Saber Dridi, ISTOS GmbH, https://github.com/SaberIstos
+- Andreas Genz, doubleSlash Net-Business GmbH, https://github.com/ds-agenz
+- Alexander Bulgakov, doubleSlash Net-Business GmbH, https://github.com/ds-alexander-bulgakov
+- Michael Schlacher, doubleSlash Net-Business GmbH, https://github.com/michaelschlacher2
+- Sebastian Bezold, Mercedes Benz AG, https://github.com/SebastianBezold
+- Zied Belkhiria, MHP, https://github.com/Zied-Belkhiria-Mhp
+- Adam Bugajewski, doubleSlash Net-Business GmbH, https://github.com/ds-ext-abugajewski

CHANGELOG.md

@@ -9,6 +9,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Known knowns
 - PLACEHOLDER REMOVE IF EMPTY: risks that were introduced or discovered in the release and are known but not resolved
 
+## [2.3.0] - 2023-02-21
+### Added
+- Introduced new endpoint ``/irs/aspectmodels`` which will list all available aspect models (from semantic hub or locally provided files if present)
+
+### Fixed
+- If Grafana is enabled - dashboards will be automatically imported on startup
+
+### Changed
+- Job creation validates ``aspects`` by using models available in semantic hub or locally provided.
+
+### Known knowns
+- PLACEHOLDER REMOVE IF EMPTY: risks that were introduced or discovered in the release and are known but not resolved
+
 ## [2.2.0] - 2023-01-20
 ### Added
 - Added new job parameter flag "lookupBPNs" which toggles lookup of BPN numbers using the configured BPN URL
@@ -145,7 +158,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Unresolved
 - **Select Aspects you need**  You are able to select the needed aspects for which you want to collect the correct endpoint information.
 
-[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.2.0...HEAD
+[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.3.0...HEAD
+[2.3.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.2.0...2.3.0
 [2.2.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/2.0.0...2.1.0
 [2.0.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/1.6.0...2.0.0

README.md

@@ -10,7 +10,7 @@
 [![OWASP Dependency Check](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/owasp.yml/badge.svg)](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/owasp.yml)
 [![Spotbugs](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/spotbugs.yml/badge.svg)](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/spotbugs.yml)
 [![Eclipse-dash](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/eclipse-dash.yml/badge.svg)](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/eclipse-dash.yml)
-[![Tavern IRS API test](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/tavern.yml/badge.svg)](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/tavern.yml)   
+[![Tavern IRS API test](https://github.com/catenax-ng/tx-item-relationship-service/actions/workflows/tavern.yml/badge.svg)](https://github.com/catenax-ng/tx-item-relationship-service/actions/workflows/tavern.yml)   
 
 ## What is the IRS?
 
@@ -33,9 +33,13 @@ The following subsection provides instructions for running the infrastructure on
 
 #### Docker-compose + IDE
 
-* Start the necessary infrastructure by running `docker-compose up`
+- Start the necessary infrastructure by running `docker-compose up`
 
-* Start the application from your favorite IDE. For IntelliJ, a run configuration is available in the .run folder.
+- Start the application from your favorite IDE. For IntelliJ, a run configuration is available in the .run folder.
+
+- **Hint**
+  Docker Image and Docker Compose that exist in root directory of application is only for local deployment.
+  It is not and should be not use in any test or production deployment.
 
 #### Local IRS API