Merge pull request #1 from catenax-ng/feature/CXAR-948-carve-out

feat: Initial Contribution

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,63 @@
+<!--
+ * Copyright (c) 2023 SAP SE 
+ * Copyright (c) 2023 T-Systems International GmbH 
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+-->
+
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Describe the bug
+
+_A clear and concise description of what the bug is._
+
+### To Reproduce
+
+_Steps to reproduce the behavior:_
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected behavior
+
+_A clear and concise description of what you expected to happen._
+
+### Screenshots/Error Messages
+
+_If applicable, add screenshots and/or error messages to help explain your problem._
+
+## Context Informations
+
+_Add any other context about the probleme here._
+
+- Used version: [e.g. Commit Hash]
+- OS: [e.g. Mac OS (M1), Windows, Linux]
+- Docker Version: [e.g. 20.10.12]
+- `java --version`:
+
+## Possible Implementation
+
+_You already know the root cause of the erroneous state and how to fix it? Feel free to share your thoughts._

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,44 @@
+<!--
+ * Copyright (c) 2023 SAP SE 
+ * Copyright (c) 2023 T-Systems International GmbH 
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+-->
+
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+_If you are missing a feature or have an idea how to improve this project that should first be
+discussed, please feel free to open up a [discussion](https://github.com/eclipse-tractusx/tractusx-edc/discussions/categories/ideas)._
+
+**Is your feature request related to a problem? Please describe.**
+_A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]_
+
+**Describe the solution you'd like**
+_A clear and concise description of what you want to happen._
+
+**Describe alternatives you've considered**
+_A clear and concise description of any alternative solutions or features you've considered._
+
+**Additional context**
+_Add any other context or screenshots about the feature request here._

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+<!--
+ * Copyright (c) 2023 SAP SE 
+ * Copyright (c) 2023 T-Systems International GmbH 
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+-->
+
+## WHAT
+
+_Briefly describe what your PR changes, which features it adds/modifies._
+
+## WHY
+
+_Briefly state why the change was necessary._
+
+## FURTHER NOTES
+
+_List other areas of code that have changed but are not necessarily linked to the main feature. This could be method signature changes, package declarations, bugs that were encountered and were fixed inline, etc._
+
+Closes # <-- _insert Issue number if one exists_

.github/actions/setup-java/action.yml

@@ -0,0 +1,32 @@
+#
+# Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+# Copyright (c) 2023 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License, Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+---
+name: "Setup JDK 17"
+description: "Setup JDK 17"
+runs:
+ using: "composite"
+ steps:
+ - name: Setup JDK 17
+ uses: actions/setup-java@v3.11.0
+ with:
+ java-version: '17'
+ distribution: 'temurin'
+ cache: 'maven'

.github/dependabot.yml

@@ -0,0 +1,56 @@
+#
+# Copyright (c) 2023 SAP SE 
+# Copyright (c) 2023 T-Systems International GmbH 
+# Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License, Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+---
+version: 2
+updates:
+ # Maven
+ -
+ package-ecosystem: "maven"
+ target-branch: main
+ directory: /
+ labels:
+ - "dependabot"
+ - "dependencies"
+ schedule:
+ interval: "daily"
+
+ # Github Actions
+ -
+ package-ecosystem: "github-actions"
+ target-branch: main
+ directory: /
+ labels:
+ - "dependabot"
+ - "github-actions"
+ schedule:
+ interval: "daily"
+
+ # Docker
+ -
+ package-ecosystem: "docker"
+ target-branch: main
+ directory: ./sparql-aas/src/main/docker/
+ labels:
+ - "dependabot"
+ - "docker"
+ schedule:
+ interval: "daily"

.github/workflows/build.yml

@@ -0,0 +1,164 @@
+---
+#
+# Copyright (c) 2023 SAP SE 
+# Copyright (c) 2023 T-Systems International GmbH 
+# Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License, Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+name: "Build"
+
+on:
+ # Runs automatically on main and release branches
+ push:
+ branches:
+ - main
+ - 'release/*'
+ # Can be scheduled on all branches and version tags
+ tags:
+ - 'v*.*.*'
+ - 'v*.*.*-*'
+ # Runs automatically on all code-related PRs to main and release branches
+ pull_request:
+ branches:
+ - main
+ - 'release/*'
+ paths-ignore:
+ - 'charts/**'
+ - 'docs/**'
+ - '**/*.md'
+ # Manual workflow trigger
+ workflow_dispatch:
+ inputs:
+ deploy_maven:
+ description: 'whether maven packages should be deployed (default: false)'
+ default: 'false'
+ required: false
+ type: string
+ deploy_docker:
+ description: 'whether docker images should be deployed (default: true)'
+ default: 'true'
+ required: false
+ type: string
+
+# If build is triggered several times, e.g., through subsequent pushes
+# into the same PR, cancel the previous runs, see below
+concurrency:
+ # cancel only running jobs on pull requests
+ group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+ cancel-in-progress: true
+
+# Actual build/deploy logic
+jobs:
+ # Build maven and docker stuff
+ build:
+ name: Build/Deploy Maven & Docker Artifacts
+ runs-on: ubuntu-latest
+ permissions: write-all
+ strategy:
+ fail-fast: false
+ steps:
+
+ # Determine the right target docker repo
+ - name: Check github repository and set docker repo
+ id: set-docker-repo
+ run: |
+ echo "REGISTRY=docker.io" >> $GITHUB_OUTPUT;
+ echo "REPO=tractusx" >> $GITHUB_OUTPUT;
+ if [ "${{ github.repository }}" != "eclipse-tractusx/knowledge-agents-aas-bridge" ];
+ then
+ echo "REGISTRY=ghcr.io" >> $GITHUB_OUTPUT
+ echo "REPO=ghcr.io/${{ github.repository }}" >> $GITHUB_OUTPUT
+ fi
+ exit 0
+
+ # Get the Code
+ - name: Checkout repository
+ uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+ with:
+ submodules: recursive
+
+ # Setup build environment
+ - uses: ./.github/actions/setup-java
+
+ # Enable deployment access (on demand or main branch and version tags only)
+ - name: Login to GitHub Container Registry
+ if: ${{ ( github.event.inputs.deploy_docker == 'true' || github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v') ) }}
+ uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+ with:
+ registry: ${{ steps.set-docker-repo.outputs.REGISTRY }}
+ # Use existing DockerHub credentials present as secrets
+ username: ${{ secrets.DOCKER_HUB_USER || github.actor }}
+ password: ${{ secrets.DOCKER_HUB_TOKEN || secrets.GITHUB_TOKEN }}
+
+ # Run Maven Deploy (on demand or if either running on main or a version tag)
+ - name: Deploy Java via Maven
+ if: ${{ ( github.event.inputs.deploy_maven == 'true' || github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v') ) }}
+ run: |
+ ./mvnw -s settings.xml deploy -DaltDeploymentRepository=github::default::https://maven.pkg.github.com/${{ github.repository }}
+ env:
+ GITHUB_ACTOR: ${{ github.actor }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+ # Run Maven Install (otherwise)
+ - name: Build Java via Maven
+ if: ${{ ( github.event.inputs.deploy_maven != 'true' && github.ref != 'refs/heads/main' && !startsWith(github.ref, 'refs/tags/v') ) }}
+ run: |
+ ./mvnw -s settings.xml install
+ env:
+ GITHUB_ACTOR: ${{ github.actor }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+ # Create SemVer or ref tags dependent of trigger event
+ - name: Docker Meta AAS Bridge
+ id: meta-aas
+ uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
+ with:
+ images: |
+ ${{ steps.set-docker-repo.outputs.REPO }}/aas-bridge
+ # Automatically prepare image tags; See action docs for more examples. 
+ # semver patter will generate tags like these for example :1 :1.2 :1.2.3
+ tags: |
+ type=sha,event=branch
+ type=sha,event=pr
+ type=semver,pattern={{version}}
+ type=semver,pattern={{major}}
+ type=semver,pattern={{major}}.{{minor}}
+ type=raw,value=0.10.5-SNAPSHOT,enable=${{ github.event.inputs.deploy_docker == 'true' || github.ref == format('refs/heads/{0}', 'main') }}
+ type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', 'main') }}
+
+ # build in any case, but push only main and version tag settings
+ - name: AAS Bridge Container Build and Push
+ uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+ with:
+ context: sparql-aas/.
+ file: sparql-aas/src/main/docker/Dockerfile
+ # Build image for verification purposes on every trigger event. Only push if event is not a PR
+ push: ${{ ( github.event.inputs.deploy_docker == 'true' || github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v') ) }}
+ tags: ${{ steps.meta-aas.outputs.tags }}
+ labels: ${{ steps.meta-aas.outputs.labels }}
+
+ # Important step to push image description to DockerHub - since this is version independent, we always take it from main
+ - name: Update Docker Hub description for AAS Bridge
+ if: ${{ steps.set-docker-repo.outputs.REPO == 'docker.io' && github.ref == 'refs/heads/main' }}
+ uses: peter-evans/dockerhub-description@dc67fad7001ef9e8e3c124cb7a64e16d0a63d864 # v3.4.2
+ with:
+ readme-filepath: sparql-aas/README.md
+ username: ${{ secrets.DOCKER_HUB_USER }}
+ password: ${{ secrets.DOCKER_HUB_TOKEN }}
+ repository: ${{ steps.set-docker-repo.outputs.REPO }}/aas-bridge
+