Merge pull request #208 from ruromero/external-api-spec

build: use the openapi data model from a dedicated repository

Author: ruromero

.github/workflows/ci.yaml

@@ -16,35 +16,15 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Set up graalVM
-        uses: graalvm/setup-graalvm@v1
+      - name: Setup JDK
+        uses: actions/setup-java@v3
         with:
-          version: 'latest'
+          distribution: 'temurin'
           java-version: '17'
-          components: 'native-image'
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cache: 'maven'
       - name: Run integration tests
         run: |
-          ./mvnw verify -Pnative
-  openapi-lint-checks:
-    runs-on: ubuntu-latest
-    name: OpenAPI Linter
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-      - name: v3 Lint
-        run: npx @redocly/cli lint api-spec/v3/openapi.yaml
-      - name: v4 Lint
-        run: npx @redocly/cli lint api-spec/v4/openapi.yaml
-  openapi-validation:
-    runs-on: ubuntu-latest
-    name: Validate OpenAPI Spec
-    steps:
-      - uses: actions/checkout@v3
-      - name: Validate OpenAPI definition
-        uses: char0n/swagger-editor-validate@v1
-        with:
-          definition-file: api-spec/v3/openapi.yaml
+          ./mvnw -B verify -Pnative
+        env:
+          GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/cicd.yaml

@@ -102,7 +102,11 @@ jobs:
           cache: 'maven'
 
       - name: Build Package with Maven
-        run: mvn verify -Pnative
+        run: |
+          ./mvnw -B verify -Pnative
+        env:
+          GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build Image With buildah
         id: build-image

.github/workflows/inform-cli.yml

@@ -206,6 +206,22 @@ spec:
       workspaces:
       - name: source
         workspace: workspace
+    - name: copy-settings
+      runAfter:
+      - clone-repository
+      taskSpec:
+        steps:
+        - name: copy
+          image: registry.access.redhat.com/ubi9/ubi-minimal:9.3
+          script: |
+            #!/bin/sh
+            set -x
+            cp $(workspaces.settings.path)/settings.xml $(workspaces.workspace.path)/source/settings.xml
+      workspaces:
+      - name: settings
+        workspace: mvn-settings
+      - name: workspace
+        workspace: workspace
     - name: build-container
       params:
       - name: IMAGE
@@ -224,6 +240,7 @@ spec:
         value: $(tasks.clone-repository.results.commit)
       runAfter:
       - prefetch-dependencies
+      - copy-settings
       taskRef:
         params:
         - name: name
@@ -374,6 +391,7 @@ spec:
     - name: workspace
     - name: git-auth
       optional: true
+    - name: mvn-settings
   workspaces:
   - name: workspace
     volumeClaimTemplate:
@@ -389,4 +407,7 @@ spec:
   - name: git-auth
     secret:
       secretName: '{{ git_auth_secret }}'
+  - name: mvn-settings
+    secret:
+      secretName: exhort-mvn-settings
 status: {}

.tekton/exhort-pull-request.yaml

@@ -200,6 +200,22 @@ spec:
       workspaces:
       - name: source
         workspace: workspace
+    - name: copy-settings
+      runAfter:
+      - clone-repository
+      taskSpec:
+        steps:
+        - name: copy
+          image: registry.access.redhat.com/ubi9/ubi-minimal:9.3
+          script: |
+            #!/bin/sh
+            set -x
+            cp $(workspaces.settings.path)/settings.xml $(workspaces.workspace.path)/source/settings.xml
+      workspaces:
+      - name: settings
+        workspace: mvn-settings
+      - name: workspace
+        workspace: workspace
     - name: build-container
       params:
       - name: IMAGE
@@ -218,6 +234,7 @@ spec:
         value: $(tasks.clone-repository.results.commit)
       runAfter:
       - prefetch-dependencies
+      - copy-settings
       taskRef:
         params:
         - name: name
@@ -368,6 +385,7 @@ spec:
     - name: workspace
     - name: git-auth
       optional: true
+    - name: mvn-settings
   workspaces:
   - name: workspace
     volumeClaimTemplate:
@@ -383,4 +401,7 @@ spec:
   - name: git-auth
     secret:
       secretName: '{{ git_auth_secret }}'
+  - name: mvn-settings
+    secret:
+      secretName: exhort-mvn-settings
 status: {}

.tekton/exhort-push.yaml

@@ -3,11 +3,6 @@
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![CI](https://github.com/RHEcosystemAppEng/exhort/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/RHEcosystemAppEng/exhort/actions/workflows/ci.yaml)
 
-### Third party dependencies
-
-- Snyk API
-- OSS Index
-
 ## Required parameters
 
 - `api.snyk.token` Snyk API token for default authentication
@@ -38,6 +33,11 @@ The following Package Managers are currently supported:
 - Go Modules (`gomodules`)
 - Pip (`pip`)
 
+## Exhort API
+
+Here you can find the [Exhort API Specification](https://github.com/RHEcosystemAppEng/exhort-api-spec) together with
+the Java and Javascript generated data model.
+
 ## Dependency Analysis `/api/v4/analysis`
 
 The expected input data format is a Software Bill of Materials (SBOM) containing the aggregate of all direct and transitive