4881: Update api spec action to comment on spec diff

Author: turegjorup

.github/workflows/api-spec.yml

@@ -9,7 +9,7 @@ env:
 jobs:
   api-spec:
     runs-on: ubuntu-latest
-    name: API specification validation
+    name: Ensure committed API specification is up to date
     steps:
       - name: Checkout
         uses: actions/checkout@v5
@@ -28,9 +28,28 @@ jobs:
           task --yes api:spec:export
 
       - name: Check for changes in specification
+        id: git-diff-spec
+        continue-on-error: true
         run: git diff --diff-filter=ACMRT --exit-code public/spec.yaml
 
+      - name: Comment PR
+        if: steps.git-diff-spec.outcome == 'failure'
+        working-directory: head
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          echo "## 🛑 Exported API specification file not up to date" > ../comment.md
+          echo "" >> ../comment.md
+          echo "Please run `task api:spec:export` to export the API specification. Then commit and push the changes." >> ../comment.md
+          gh pr comment ${{ github.event.pull_request.number }} --body-file ../comment.md --create-if-none --edit-last
+
+      - name: Fail job api spec is not up to date
+        if: steps.git-diff-spec.outcome == 'failure'
+        run: |
+          exit 1
+
   detect-breaking-changes:
+    name: Detect breaking changes in API specification
     runs-on: ubuntu-latest
     needs: [api-spec]
     steps:

public/spec.yaml

@@ -1,4 +1,5 @@
 openapi: 3.1.0
+# <debug>Force git diff to test github action</debug>
 info:
   title: 'Event Database'
   description: 'API for the Event Database'