Release version 0.6.0-rc1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,7 +2,7 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: bug
+labels: ["bug", "triage"]
 assignees: ''
 
 ---
@@ -28,9 +28,9 @@ _A clear and concise description of what you expected to happen._
 
 _If applicable, add screenshots and/or error messages to help explain your problem._
 
-## Context Informations
+## Context Information
 
-_Add any other context about the probleme here._
+_Add any other context or information about the problem here._
 
 - Used version: [e.g. Commit Hash]
 - OS: [e.g. Mac OS (M1), Windows, Linux]

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,23 +1,28 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
+name: Feature Request
+about: Request a new feature
 title: ''
-labels: enhancement
+labels: ['triage', '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)._
+## WHAT
 
-**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 [...]_
+// describes the desired functionality and how the feature should behave. This should include clear requirements, and a "definition-of-done", i.e. what the result of the issue should be. This is important for concept, documentation or ideation issues
 
-**Describe the solution you'd like**
-_A clear and concise description of what you want to happen._
+## WHY
+// outlines the motivation, why the feature is desired, and possibly what the impact is if the feature is _not_
+implemented. "Because we need it" is not a sufficient reason!
 
-**Describe alternatives you've considered**
-_A clear and concise description of any alternative solutions or features you've considered._
+## HOW
 
-**Additional context**
-_Add any other context or screenshots about the feature request here._
+// if possible, outlines a solution proposal
+
+## FURTHER NOTES
+
+// anything else you want to outline
+
+_Please be sure to take a look at
+our [contribution guidelines](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/CONTRIBUTING.md) and
+our [PR etiquette](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/pr_etiquette.md)._

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

@@ -25,8 +25,8 @@ runs:
   using: "composite"
   steps:
     - name: Setup JDK 17
-      uses: actions/setup-java@v3.11.0
+      uses: actions/setup-java@v3.13.0
       with:
         java-version: '17'
         distribution: 'temurin'
-        cache: 'gradle'
+        cache: 'gradle'

.github/release.yaml

@@ -0,0 +1,34 @@
+#
+#  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
+#
+
+---
+changelog:
+  exclude:
+    authors:
+      - dependabot[bot]
+  categories:
+    - title: Bugfixes
+      labels:
+        - bug
+    - title: New Features & Improvements
+      labels:
+        - "*"
+    - title: Documentation
+      labels:
+        - documentation

.github/workflows/deployment-test.yaml

@@ -56,7 +56,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: test-prepare
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/run-deployment-test
         name: "Run deployment test using KinD and Helm"
         with:
@@ -80,7 +80,7 @@ jobs:
     needs: test-prepare
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.5.2
+        uses: actions/checkout@v4
       - uses: ./.github/actions/run-deployment-test
         name: "Run deployment test using KinD and Helm"
         with:
@@ -107,7 +107,7 @@ jobs:
       needs.secret-presence.outputs.AZURE_KV_CREDS
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.3.0
+        uses: actions/checkout@v4
       - name: "Login to AZ CLI"
         run: |
           az login --service-principal -u="${{ secrets.AZURE_CLIENT_ID }}" --password="${{ secrets.AZURE_CLIENT_SECRET }}" --tenant="${{ secrets.AZURE_TENANT_ID }}"

.github/workflows/draft-new-release.yaml

@@ -37,7 +37,7 @@ jobs:
       pages: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
       - name: Create release branch
         run: git checkout -b release/${{ github.event.inputs.version }}
       - name: Initialize mandatory git config
@@ -53,7 +53,7 @@ jobs:
           GITHUB_PACKAGE_USERNAME: ${{ github.actor }}
           GITHUB_PACKAGE_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
       - name: Bump version in /charts
-        uses: mikefarah/[email protected].1
+        uses: mikefarah/[email protected].2
         with:
           cmd: |-
             find charts -name Chart.yaml -maxdepth 3 | xargs -n1 yq -i '.appVersion = "${{ github.event.inputs.version }}" | .version = "${{ github.event.inputs.version }}"'

.github/workflows/helm-lint.yaml

@@ -44,7 +44,7 @@ jobs:
       ##############
       ### Set-Up ###
       ##############
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: helm (setup)

.github/workflows/kics.yml

@@ -40,7 +40,7 @@ jobs:
       security-events: write
 
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
 
       - name: KICS scan
         uses: checkmarx/[email protected]

.github/workflows/publish-docker.yaml

@@ -54,7 +54,7 @@ jobs:
       contents: write
       packages: write
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/publish-docker-image
         name: Publish ${{ matrix.variant.img }}
         with:

.github/workflows/publish-docusaurus.yaml

@@ -0,0 +1,76 @@
+#
+#  Copyright (c) 2023 Mercedes Benz Tech Innovation 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: "Publish docusaurus documentation"
+
+on:
+  workflow_dispatch:
+    inputs:
+      downstream-version:
+        required: false
+        type: string
+  workflow_call:
+    inputs:
+      downstream-version:
+        required: false
+        type: string
+
+jobs:
+  publish-docusaurus:
+    permissions:
+      contents: write
+      packages: write
+    name: "Publish docusaurus documentation as zip file"
+    runs-on: ubuntu-latest
+    env:
+      SWAGGERHUB_API_KEY: ${{ secrets.SWAGGERHUB_API_KEY }}
+      SWAGGERHUB_USER: ${{ secrets.SWAGGERHUB_USER }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ./.github/actions/setup-java
+
+      - name: "Extract version"
+        id: extract_version
+        run: |
+          if [ -z ${{ inputs.downstream-version }} ]; then
+            echo "DOWNSTREAM_VERSION=$(grep "version" gradle.properties  | awk -F= '{print $2}')" >> "$GITHUB_OUTPUT"
+          else
+            echo "DOWNSTREAM_VERSION=${{ inputs.downstream-version }}" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: "Run autodoc"
+        run: |
+          ./gradlew autodoc
+          ./gradlew mergeManifests
+          ./gradlew doc2md
+
+      - name: "Gather documentation files"
+        run: |
+          chmod +x ./resources/create_kit_documentation.sh
+          ./resources/create_kit_documentation.sh ${{ runner.temp }} $(pwd) ${{ steps.extract_version.outputs.DOWNSTREAM_VERSION }}
+
+      - name: Publish zip to GitHub Release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: ${{ runner.temp }}/tractusx-edc-docusaurus-${{ steps.extract_version.outputs.DOWNSTREAM_VERSION }}.zip
+          tag: ${{ steps.extract_version.outputs.DOWNSTREAM_VERSION }}

.github/workflows/publish-maven.yaml

@@ -42,7 +42,7 @@ jobs:
       packages: write
     steps:
       # Set-Up
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-java
 
       # Import GPG Key

.github/workflows/publish-new-release.yml

@@ -70,7 +70,7 @@ jobs:
           echo "RELEASE_VERSION=${{ needs.release-version.outputs.RELEASE_VERSION }}" >> $GITHUB_ENV
 
       # Set-Up
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-java
 
       # Import GPG Key
@@ -107,7 +107,7 @@ jobs:
                    { dir: edc-dataplane,    img: edc-dataplane-hashicorp-vault } ]
 
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
       - name: Export RELEASE_VERSION env
         run: |
           echo "RELEASE_VERSION=${{ needs.release-version.outputs.RELEASE_VERSION }}" >> $GITHUB_ENV
@@ -136,7 +136,7 @@ jobs:
       - name: Export RELEASE_VERSION env
         run: |
           echo "RELEASE_VERSION=${{ needs.release-version.outputs.RELEASE_VERSION }}" >> $GITHUB_ENV
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Install Helm
@@ -179,7 +179,7 @@ jobs:
       - name: Export RELEASE_VERSION env
         run: |
           echo "RELEASE_VERSION=${{ needs.release-version.outputs.RELEASE_VERSION }}" >> $GITHUB_ENV
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
         with:
           # 0 to fetch the full history due to upcoming merge of releases into main branch
           fetch-depth: 0
@@ -249,3 +249,14 @@ jobs:
     with:
       downstream-version: ${{ needs.release-version.outputs.RELEASE_VERSION }}
     secrets: inherit
+
+  publish-docusaurus:
+    name: Publish docusaurus docs
+    permissions:
+      contents: write
+      packages: write
+    needs: [ secret-presence, publish-to-swaggerhub, github-release ]
+    with:
+      downstream-version: ${{ needs.release-version.outputs.RELEASE_VERSION }}
+    uses: ./.github/workflows/publish-docusaurus.yaml
+    secrets: inherit

.github/workflows/publish-swaggerhub.yaml

@@ -49,14 +49,9 @@ jobs:
       SWAGGERHUB_API_KEY: ${{ secrets.SWAGGERHUB_API_KEY }}
       SWAGGERHUB_USER: ${{ secrets.SWAGGERHUB_USER }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Setup JDK 17
-        uses: actions/[email protected]
-        with:
-          java-version: '17'
-          distribution: 'temurin'
-          cache: 'gradle'
+      - uses: ./.github/actions/setup-java
 
       - name: Setup node
         uses: actions/setup-node@v3
@@ -110,4 +105,4 @@ jobs:
           else
             echo "snapshot, will set the API to 'unpublished'";
             swaggerhub api:update ${{ env.SWAGGERHUB_USER }}/tractusx-edc/${{ env.DOWNSTREAM_VERSION }} -f ./resources/openapi/yaml/tractusx-edc-api.yaml --visibility=public --published=unpublish
-          fi
+          fi

.github/workflows/publish.yaml

@@ -82,7 +82,7 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/publish-docker-image
         name: Publish ${{ matrix.variant.img }}
         with:
@@ -106,7 +106,7 @@ jobs:
       needs.secret-presence.outputs.HAS_OSSRH && github.event_name != 'pull_request' && github.ref != 'refs/heads/releases'
     steps:
       # Set-Up
-      - uses: actions/checkout@v3.5.2
+      - uses: actions/checkout@v4
 
       # Import GPG Key
       - uses: ./.github/actions/import-gpg-key
@@ -137,4 +137,12 @@ jobs:
     needs: [ secret-presence ]
     if: needs.secret-presence.outputs.HAS_SWAGGER
     uses: ./.github/workflows/publish-swaggerhub.yaml
-    secrets: inherit
+
+  publish-docusaurus:
+    name: Publish docusaurus docs
+    permissions:
+      contents: write
+      packages: write
+    needs: [ secret-presence, publish-to-swaggerhub ]
+    if: needs.secret-presence.outputs.HAS_SWAGGER
+    uses: ./.github/workflows/publish-docusaurus.yaml