4881: Comment on PR with API spec result

Author: turegjorup

.github/workflows/api-spec.yml

@@ -28,7 +28,7 @@ jobs:
           task --yes api:spec:export
 
       - name: Check for changes in specification
-        run: git diff --diff-filter=ACMRT --exit-code public/spec.yaml
+        run: git diff --diff-filter=ACMRT --exit-code public/spec.yaml --markdown api-spec-result.md
 
   detect-breaking-changes:
     runs-on: ubuntu-latest
@@ -46,24 +46,48 @@ jobs:
           ref: ${{ github.head_ref }}
           path: head
 
-      - name: Run OpenAPI Diff (from HEAD rev)
-        id: api-diff
+      - name: Run OpenAPI Changes (from HEAD rev)
+        id: api-changes
         continue-on-error: true
         uses: docker://openapitools/openapi-diff:latest
         with:
-          args: --fail-on-incompatible base/public/spec.yaml head/public/spec.yaml
+          args: --fail-on-changes base/public/spec.yaml head/public/spec.yaml  --markdown api-spec-changes.md
 
-      - name: Comment PR with API diff results
-        if: always()
+      - name: Run OpenAPI Incompatible (from HEAD rev)
+        id: api-incompatible
+        continue-on-error: true
+        uses: docker://openapitools/openapi-diff:latest
+        with:
+          args: --fail-on-incompatible base/public/spec.yaml head/public/spec.yaml --markdown api-spec-incompatible.md
+
+      - name: Comment PR with no changes
+        if: steps.api-changes.outcome == 'success' && steps.api-incompatible.outcome == 'success'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh pr comment ${{ github.event.pull_request.number }} --body "✅ **No changes detected in API specification**" --create-if-none --edit-last
+
+      - name: Comment PR with non-breaking changes
+        if: steps.api-.outcome == 'failure' && steps.api-incompatible.outcome == 'success'
         env:
           GH_TOKEN: ${{ github.token }}
         run: |
-          if [ -f result.md ]; then
-            gh pr comment ${{ github.event.pull_request.number }} --body-file result.md
-          else
-            if [ "${{ steps.api-diff.outcome }}" == "failure" ]; then
-              gh pr comment ${{ github.event.pull_request.number }} --body "⚠️ **Breaking changes detected in API specification**"
-            else
-              gh pr comment ${{ github.event.pull_request.number }} --body "✅ **No breaking changes detected in API specification**"
-            fi
-          fi
+          echo "## ⚠️ Non-Breaking changes detected in API specification" > ../comment.md
+          echo "" >> ../comment.md
+          cat api-spec-changes.md >> ../comment.md
+          gh pr comment ${{ github.event.pull_request.number }} --body-file ../comment.md --create-if-none --edit-last
+
+      - name: Comment PR with breaking changes
+        if: steps.api-incompatible.outcome == 'failure'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          echo "## 🛑 Breaking changes detected in API specification" > ../comment.md
+          echo "" >> ../comment.md
+          cat api-spec-changes.md >> ../comment.md
+          gh pr comment ${{ github.event.pull_request.number }} --body-file ../comment.md --create-if-none --edit-last
+
+      - name: Fail if breaking changes detected
+        if: steps.api-incompatible.outcome == 'failure'
+        run: |
+          exit 1