Merge branch 'main' into fix-owner-feature-kafkasql

Apicurio · Jan 14, 2025 · c3464b9 · c3464b9
2 parents a9deb03 + 1104621
commit c3464b9
Show file tree

Hide file tree

Showing 95 changed files with 1,251 additions and 1,106 deletions.
diff --git a/.github/workflows/integration-tests.yaml b/.github/workflows/integration-tests.yaml
@@ -303,7 +303,7 @@ jobs:
           npm run test
 
       - name: Upload Test Report
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4.0.0
         if: always()
         with:
           name: playwright-report

diff --git a/.github/workflows/release-sboms.yaml b/.github/workflows/release-sboms.yaml
@@ -0,0 +1,98 @@
+name: Release SBOMs
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Release tag name'
+        required: true
+  release:
+    types: [released, prereleased]
+
+
+env:
+  # The values are extracted from the github.event context,
+  # which is only available when the workflow gets triggered by a release event.
+  RELEASE_VERSION: ${{ github.event.release.name }}
+  BRANCH: ${{ github.event.release.target_commitish }}
+
+
+jobs:
+  release-sboms:
+    if: github.repository_owner == 'Apicurio' && (github.event_name == 'workflow_dispatch' || startsWith(github.event.release.tag_name, '3.'))
+    runs-on: ubuntu-22.04
+    timeout-minutes: 30
+    env:
+      RELEASE_TYPE: release
+    steps:
+      - name: Fetch Release Details
+        if: github.event_name == 'workflow_dispatch'
+        run: |
+          touch release.json && curl https://api.github.com/repos/${GITHUB_REPOSITORY}/releases/tags/${{ github.event.inputs.tag }} > release.json
+          echo "RELEASE_VERSION=$(cat release.json | jq -r '.name')" >> $GITHUB_ENV
+          echo "BRANCH=$(cat release.json | jq -r '.target_commitish')" >> $GITHUB_ENV
+
+      - name: Download Source Code
+        run: |
+          git config --global user.name "apicurio-ci"
+          git config --global user.email "[email protected]"
+          git clone --branch $RELEASE_VERSION --single-branch https://apicurio-ci:${{ secrets.ACCESS_TOKEN }}@github.com/Apicurio/apicurio-registry.git registry
+
+      - name: Checkout SBOMs Repo
+        run: |
+          git config --global user.name "apicurio-ci"
+          git config --global user.email "[email protected]"
+          git clone --branch main --single-branch https://apicurio-ci:${{ secrets.ACCESS_TOKEN }}@github.com/Apicurio/apicurio-sboms.git sboms
+          cd sboms
+          echo "SBOM_OUTPUT_DIR=$(pwd)/apicurio-registry/$RELEASE_VERSION" >> $GITHUB_ENV
+          echo "Generating SBOMs into: $SBOM_OUTPUT_DIR"
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: 'npm'
+          cache-dependency-path: 'registry/ui/**/package-lock.json'
+
+      - name: Maven Install
+        run: |
+          cd registry
+          mvn install -Pprod -DskipTests -Dspotless.check.skip=true
+
+      - name: Generate Maven SBOMs
+        run: |
+          mkdir -p $SBOM_OUTPUT_DIR
+          cd registry
+          echo "Generating Maven SBOM output to: $SBOM_OUTPUT_DIR/apicurio-registry-app-$RELEASE_VERSION.runtime.sbom.dot"
+          mvn -f app/pom.xml dependency:tree -DoutputType=dot -Dscope=runtime -DoutputFile=$SBOM_OUTPUT_DIR/apicurio-registry-app-$RELEASE_VERSION.runtime.sbom.dot
+
+      - name: Generate npm SBOMs
+        run: |
+          cd registry/ui
+          npm install
+          cd ui-app
+          echo "Generating npm SBOM output to: $SBOM_OUTPUT_DIR/apicurio-registry-ui-app-$RELEASE_VERSION.sbom.npm"
+          npm list -prod -depth 10 --json > $SBOM_OUTPUT_DIR/apicurio-registry-ui-app-$RELEASE_VERSION.sbom.npm
+          cd ../ui-docs
+          echo "Generating npm SBOM output to: $SBOM_OUTPUT_DIR/apicurio-registry-ui-docs-$RELEASE_VERSION.sbom.npm"
+          npm list -prod -depth 10 --json > $SBOM_OUTPUT_DIR/apicurio-registry-ui-docs-$RELEASE_VERSION.sbom.npm
+
+      - name: Commit SBOMs to Repo
+        run: |
+          cd sboms
+          git add .
+          git commit -m 'Generated SBOMs for release $RELEASE_VERSION'
+          git push origin main
+
+      - name: Google Chat Notification
+        if: ${{ failure() }}
+        uses: Co-qn/google-chat-notification@b9227d9daa4638c9782a5bd16c4abb86268127a1
+        with:
+          name: ${{ github.job }}
+          url: ${{ secrets.GOOGLE_CHAT_WEBHOOK }}
+          status: ${{ job.status }}
diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml
@@ -89,21 +89,23 @@ jobs:
         run: |
           docker images
 
-      - name: Google Chat Notification (Always)
-        if: github.event_name == 'push' && always()
-        uses: Co-qn/google-chat-notification@b9227d9daa4638c9782a5bd16c4abb86268127a1
-        with:
-          name: ${{ github.job }}
-          url: ${{ secrets.GOOGLE_CHAT_WEBHOOK }}
-          status: ${{ job.status }}
+      - name: Slack Notification (Always)
+        if: always()
+        run: |
+          MESSAGE="Registry 'build-verify' job completed with status: ${{ job.status }}"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_NOTIFICATION_WEBHOOK }}
 
-      - name: Google Chat Notification (Error)
-        if: github.event_name == 'push' && failure()
-        uses: Co-qn/google-chat-notification@b9227d9daa4638c9782a5bd16c4abb86268127a1
-        with:
-          name: ${{ github.job }}
-          url: ${{ secrets.GOOGLE_CHAT_WEBHOOK_ERRORS }}
-          status: ${{ job.status }}
+      - name: Slack Notification (Error)
+        if: failure()
+        run: |
+          MESSAGE="Registry 'build-verify' job FAILED"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_ERROR_WEBHOOK }}
 
 
   build-verify-ui:
@@ -178,22 +180,23 @@ jobs:
         working-directory: ui
         run: docker buildx build --push -f ./Dockerfile -t quay.io/apicurio/apicurio-registry-ui:latest-snapshot -t docker.io/apicurio/apicurio-registry-ui:latest-snapshot --platform linux/amd64,linux/arm64,linux/s390x,linux/ppc64le .
 
-      - name: Google Chat Notification (Always)
-        if: github.event_name == 'push' && always()
-        uses: Co-qn/google-chat-notification@b9227d9daa4638c9782a5bd16c4abb86268127a1
-        with:
-          name: ${{ github.job }}
-          url: ${{ secrets.GOOGLE_CHAT_WEBHOOK }}
-          status: ${{ job.status }}
-
-      - name: Google Chat Notification (Error)
-        if: github.event_name == 'push' && failure()
-        uses: Co-qn/google-chat-notification@b9227d9daa4638c9782a5bd16c4abb86268127a1
-        with:
-          name: ${{ github.job }}
-          url: ${{ secrets.GOOGLE_CHAT_WEBHOOK_ERRORS }}
-          status: ${{ job.status }}
+      - name: Slack Notification (Always)
+        if: always()
+        run: |
+          MESSAGE="Registry 'build-verify-ui' job completed with status: ${{ job.status }}"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_NOTIFICATION_WEBHOOK }}
 
+      - name: Slack Notification (Error)
+        if: failure()
+        run: |
+          MESSAGE="Registry 'build-verify-ui' job FAILED"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_ERROR_WEBHOOK }}
 
   build-native-images:
     name: Build and Test Native images
@@ -283,21 +286,23 @@ jobs:
       - name: List All The Images
         run: docker images
 
-      - name: Google Chat Notification (Always)
-        if: github.event_name == 'push' && always()
-        uses: Co-qn/google-chat-notification@b9227d9daa4638c9782a5bd16c4abb86268127a1
-        with:
-          name: ${{ github.job }}
-          url: ${{ secrets.GOOGLE_CHAT_WEBHOOK }}
-          status: ${{ job.status }}
+      - name: Slack Notification (Always)
+        if: always()
+        run: |
+          MESSAGE="Registry 'build-native-images' job completed with status: ${{ job.status }}"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_NOTIFICATION_WEBHOOK }}
 
-      - name: Google Chat Notification (Error)
-        if: github.event_name == 'push' && failure()
-        uses: Co-qn/google-chat-notification@b9227d9daa4638c9782a5bd16c4abb86268127a1
-        with:
-          name: ${{ github.job }}
-          url: ${{ secrets.GOOGLE_CHAT_WEBHOOK_ERRORS }}
-          status: ${{ job.status }}
+      - name: Slack Notification (Error)
+        if: failure()
+        run: |
+          MESSAGE="Registry 'build-native-images' job FAILED"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_ERROR_WEBHOOK }}
 
   build-verify-python-sdk:
     name: Verify Python SDK
@@ -336,6 +341,24 @@ jobs:
         working-directory: python-sdk
         run: make test
 
+      - name: Slack Notification (Always)
+        if: always()
+        run: |
+          MESSAGE="Registry 'build-verify-python-sdk' job completed with status: ${{ job.status }}"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_NOTIFICATION_WEBHOOK }}
+
+      - name: Slack Notification (Error)
+        if: failure()
+        run: |
+          MESSAGE="Registry 'build-verify-python-sdk' job FAILED"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_ERROR_WEBHOOK }}
+
   build-verify-go-sdk:
     name: Verify Go SDK
     runs-on: ubuntu-22.04
@@ -363,31 +386,23 @@ jobs:
         working-directory: go-sdk
         run: make test
 
-  notify-sdk:
-    if: github.repository_owner == 'Apicurio' && github.event_name == 'push' && github.ref == 'refs/heads/main' && !contains(github.event.*.labels.*.name, 'DO NOT MERGE')
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        language: [ js ]
-    steps:
-      - uses: actions/checkout@v3
+      - name: Slack Notification (Always)
+        if: always()
+        run: |
+          MESSAGE="Registry 'build-verify-go-sdk' job completed with status: ${{ job.status }}"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_NOTIFICATION_WEBHOOK }}
 
-      - uses: dorny/paths-filter@b2feaf19c27470162a626bd6fa8438ae5b263721
-        id: changes
-        with:
-          base: main
-          filters: |
-            openapi:
-              - 'app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json'
-
-      - name: Repository Dispatch
-        if: steps.changes.outputs.openapi == 'true'
-        uses: peter-evans/repository-dispatch@ce5485de42c9b2622d2ed064be479e8ed65e76f4
-        with:
-          token: ${{ secrets.ACCESS_TOKEN }}
-          repository: Apicurio/apicurio-registry-client-sdk-${{ matrix.language }}
-          event-type: on-oas-updated
-          client-payload: '{"openapi_file_path": "app/src/main/resources-unfiltered/META-INF/resources/api-specifications/registry/v3/openapi.json"}'
+      - name: Slack Notification (Error)
+        if: failure()
+        run: |
+          MESSAGE="Registry 'build-verify-go-sdk' job FAILED"
+          REPO="${{ github.repository }}"
+          LINK="https://github.com/$REPO/actions/runs/${{ github.run_id }}"
+          PAYLOAD="{\"workflow\": \"${{ github.workflow }}\", \"status\": \"${{ job.status }}\", \"message\": \"$MESSAGE\", \"link\": \"$LINK\", \"repository\": \"$REPO\"}"
+          curl -X POST -H "Content-Type: application/json" -d "$PAYLOAD" ${{ secrets.SLACK_ERROR_WEBHOOK }}
 
   # Trigger a deployment workflow in the apicurio-operate-first repository, which will
   # deploy the `latest-snapshot` version of registry into the 3scale OpenShift cluster

diff --git a/app/pom.xml b/app/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry</artifactId>
-    <version>3.0.6-SNAPSHOT</version>
+    <version>3.0.7-SNAPSHOT</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

diff --git a/common/pom.xml b/common/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry</artifactId>
-    <version>3.0.6-SNAPSHOT</version>
+    <version>3.0.7-SNAPSHOT</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

diff --git a/config-index/definitions/pom.xml b/config-index/definitions/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry</artifactId>
-    <version>3.0.6-SNAPSHOT</version>
+    <version>3.0.7-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/config-index/deployment/pom.xml b/config-index/deployment/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry</artifactId>
-    <version>3.0.6-SNAPSHOT</version>
+    <version>3.0.7-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/config-index/runtime/pom.xml b/config-index/runtime/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry</artifactId>
-    <version>3.0.6-SNAPSHOT</version>
+    <version>3.0.7-SNAPSHOT</version>
     <relativePath>../../pom.xml</relativePath>
   </parent>
 

diff --git a/distro/connect-converter/pom.xml b/distro/connect-converter/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry-distro</artifactId>
-    <version>3.0.6-SNAPSHOT</version>
+    <version>3.0.7-SNAPSHOT</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

diff --git a/distro/docker/pom.xml b/distro/docker/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry-distro</artifactId>
-    <version>3.0.6-SNAPSHOT</version>
+    <version>3.0.7-SNAPSHOT</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

diff --git a/distro/pom.xml b/distro/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.apicurio</groupId>
     <artifactId>apicurio-registry</artifactId>
-    <version>3.0.6-SNAPSHOT</version>
+    <version>3.0.7-SNAPSHOT</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
   <artifactId>apicurio-registry-distro</artifactId>

diff --git a/docs/modules/ROOT/partials/getting-started/proc-configuring-kafka-oauth.adoc b/docs/modules/ROOT/partials/getting-started/proc-configuring-kafka-oauth.adoc
@@ -28,13 +28,13 @@ When you set these environment variables, the Kafka producer and consumer applic
 | `APICURIO_KAFKASQL_SECURITY_SASL_ENABLED`
 | Enables SASL OAuth authentication for {registry} storage in Kafka. You must set this variable to `true` for the other variables to have effect.
 | `false`
-| `APICURIO_KAFKASQL_SECURITY_SASL_CLIENT_IDapicurio.kafkasql.security.sasl.client-id`
+| `APICURIO_KAFKASQL_SECURITY_SASL_CLIENT-ID`
 | The client ID used to authenticate to Kafka. 
 | `-`
-| `APICURIO_KAFKASQL_SECURITY_SASL_CLIENT_SECRET`
+| `APICURIO_KAFKASQL_SECURITY_SASL_CLIENT-SECRET`
 | The client secret used to authenticate to Kafka. 
 | `-`
-| `APICURIO_KAFKASQL_SECURITY_SASL_TOKEN_ENDPOINT`
+| `APICURIO_KAFKASQL_SECURITY_SASL_TOKEN-ENDPOINT`
 | The URL of the OAuth identity server.
 | `\http://localhost:8090`
 |===