Merge pull request #227 from uniqueg/develop

Uploads error log for OpenAPI Diff output if it fails and all diff outputs as artifacts

Author: vsmalladi

.github/workflows/ci.yml

@@ -12,10 +12,22 @@ jobs:
         uses: mhiew/redoc-lint-github-action@v4
         with:
           args: 'openapi/task_execution_service.openapi.yaml'
+  validate:
+    name: Validate OpenAPI definition
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out head branch
+        uses: actions/checkout@v4
+      - name: Run OpenAPI Validate Action
+        uses: swaggerexpert/swagger-editor-validate@v1
+        with:
+          definition-file: openapi/task_execution_service.openapi.yaml
+
   diff:
     name: Show OpenAPI differences relative to target branch
     runs-on: ubuntu-latest
-    if: ${{ github.event_name == 'pull_request' }}
+    outputs:
+      diff_generated: ${{ steps.upload-log.outputs.artifact_id }}
     steps:
       - name: Check out head branch
         uses: actions/checkout@v4
@@ -27,19 +39,39 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.base.ref }}
           path: base
-      - name: Run OpenAPI Diff Action
-        uses: mvegter/openapi-diff-action@v0.23.5
+      - name: Create output directory
+        run: mkdir -p diff-artifacts/
+      - name: Pull Docker Image
+        run: docker pull openapitools/openapi-diff:2.0.1
+      - name: Run openapi-diff tool
+        run: |
+          docker run --rm \
+          -v $(pwd)/head:/head:ro \
+          -v $(pwd)/base:/base:ro \
+          -v $(pwd)/diff-artifacts:/local \
+          openapitools/openapi-diff:2.0.1 \
+          /head/openapi/task_execution_service.openapi.yaml \
+          /base/openapi/task_execution_service.openapi.yaml \
+          --markdown /local/diff.md 2> diff-artifacts/error.log
+      - name: Get PR number
+        id: get-pr-number
+        run: |
+          echo "${{ github.event.pull_request.number }}" > diff-artifacts/pr_number
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
         with:
-          head-spec: head/openapi/task_execution_service.openapi.yaml
-          base-spec: base/openapi/task_execution_service.openapi.yaml
+          name: diff-artifacts
+          path: diff-artifacts/
+          if-no-files-found: ignore
+      - name: Check if OpenAPI Diff failed
+        id: check-diff
+        run: |
+          if [ -s diff-artifacts/error.log  ]; then
+            echo "The diff failed. Please see artifact error.log."
+            exit 1
+          fi
 
-  validate:
-    name: Validate OpenAPI definition
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out head branch
-        uses: actions/checkout@v4
-      - name: Run OpenAPI Validate Action
-        uses: char0n/swagger-editor-validate@v1
-        with:
-          definition-file: openapi/task_execution_service.openapi.yaml
+permissions:
+  contents: read
+  pull-requests: write
+  issues: write

.github/workflows/diff_comment.yml

@@ -0,0 +1,30 @@
+name: OpenAPI diff comment
+on:
+  workflow_run:
+    workflows: ["Lint and validate OpenAPI specs"]
+    types: [completed]
+jobs:
+  comment:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:       
+      - name: Download diff
+        uses: actions/download-artifact@v4
+        with:
+          name: diff-artifacts
+          path: diff-artifacts/
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create PR comment
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const diff = require('fs').readFileSync('diff-artifacts/diff.md', 'utf8');
+            const pr_number = require('fs').readFileSync('diff-artifacts/pr_number', 'utf8').trim();
+            github.rest.issues.createComment({
+              issue_number: pr_number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: '## OpenAPI diff:\n\n' + diff
+            })