Reimplement commenting

Signed-off-by: Thomas Farr <[email protected]>

.github/pr-comment-templates/pr-change-analysis.template.md

@@ -0,0 +1,23 @@
+## Changes Analysis
+
+**Commit SHA:** {{.after_sha}}
+**Comparing To SHA:** {{.before_sha}}
+
+### API Changes
+
+#### Summary
+{{.api_changes_summary}}
+
+#### Report
+The full API changes report is available at: {{.api_changes_report_url}}
+
+### API Coverage
+{{with .api_coverage}}
+
+|               | Before                                              | After                                             | Δ                                                 |
+|--------------:|-----------------------------------------------------|---------------------------------------------------|---------------------------------------------------|
+|   Covered (%) | {{.before.covered}} ({{.before.covered_pct}} %)     | {{.after.covered}} ({{.after.covered_pct}} %)     | {{.covered_delta}} ({{.covered_pct_delta}} %)     |
+| Uncovered (%) | {{.before.uncovered}} ({{.before.uncovered_pct}} %) | {{.after.uncovered}} ({{.after.uncovered_pct}} %) | {{.uncovered_delta}} ({{.uncovered_pct_delta}} %) |
+|       Unknown | {{.before.specified_but_not_provided}}              | {{.after.specified_but_not_provided}}             | {{.specified_but_not_provided_delta}}             |
+
+{{end}}

.github/workflows/analyze-pr-changes.yml

@@ -19,9 +19,24 @@ jobs:
           CLUSTER_SPEC=/tmp/opensearch-openapi-CLUSTER.yaml
           BEFORE_SPEC=/tmp/opensearch-openapi-${BEFORE_SHA}.yaml
           AFTER_SPEC=/tmp/opensearch-openapi-${AFTER_SHA}.yaml
+          BEFORE_COVERAGE=/tmp/coverage-api-${BEFORE_SHA}.json
+          AFTER_COVERAGE=/tmp/coverage-api-${AFTER_SHA}.json
+          COVERAGE_DIFF=/tmp/coverage-api-${BEFORE_SHA}-${AFTER_SHA}-DIFF.json
+          
+          vars=(
+            BEFORE_SHA
+            AFTER_SHA
+            CLUSTER_SPEC
+            BEFORE_SPEC
+            AFTER_SPEC
+            BEFORE_COVERAGE
+            AFTER_COVERAGE
+            COVERAGE_DIFF
+          )
           
           { 
-            for var in BEFORE_SHA AFTER_SHA CLUSTER_SPEC BEFORE_SPEC AFTER_SPEC ; do
+            for var in "${vars[@]}"
+            do
               echo "${var}=${!var}"
             done
           } | tee "$GITHUB_ENV"
@@ -73,31 +88,33 @@ jobs:
       - name: Calculate Coverage
         shell: bash -eo pipefail {0}
         run: |
-          for sha in ${BEFORE_SHA} ${AFTER_SHA} ; do
-            echo "Calculating coverage of ${sha}"
-            npm run coverage:spec -- \
+          npm run coverage:spec -- \
+              --cluster $CLUSTER_SPEC \
+              --specification $BEFORE_SPEC \
+              --output $BEFORE_COVERAGE
+          
+          npm run coverage:spec -- \
               --cluster $CLUSTER_SPEC \
-              --specification /tmp/opensearch-openapi-${sha}.yaml \
-              --output /tmp/coverage-api-${sha}.json
-          done
+              --specification $AFTER_SPEC \
+              --output $AFTER_COVERAGE
           
-          jq . /tmp/coverage-api-${AFTER_SHA}.json
+          jq . $AFTER_COVERAGE
           
           jq --slurp '
             [ .[].counts ]
             | {
-              "covered_before": (.[0].covered),
-              "covered_before_pct": (.[0].covered_pct),
-              "covered_after": (.[1].covered),
-              "covered_after_pct": (.[1].covered_pct),
-              "total_to_cover": (.[1].covered + .[1].uncovered),
+              "before": (.[0]),
+              "after": (.[1]),
               "covered_delta": (.[1].covered - .[0].covered),
-              "covered_pct_delta": ((.[1].covered_pct - .[0].covered_pct) * 100 | round / 100)
+              "covered_pct_delta": ((.[1].covered_pct - .[0].covered_pct) * 100 | round / 100),
+              "uncovered_delta": (.[1].uncovered - .[0].uncovered),
+              "uncovered_pct_delta": ((.[1].uncovered_pct - .[0].uncovered_pct) * 100 | round / 100),
+              "specified_but_not_provided_delta": (.[1].specified_but_not_provided - .[0].specified_but_not_provided)
             }
             ' \
-            /tmp/coverage-api-${BEFORE_SHA}.json \
-            /tmp/coverage-api-${AFTER_SHA}.json \
-            | tee ./coverage-api-${BEFORE_SHA}-${AFTER_SHA}-DIFF.json
+            $BEFORE_COVERAGE \
+            $AFTER_COVERAGE \
+            | tee $COVERAGE_DIFF
 
       - name: Upload Coverage Data
         id: upload-coverage
@@ -116,7 +133,7 @@ jobs:
         run: openapi-changes html-report --no-logo --no-color $BEFORE_SPEC $AFTER_SPEC
 
       - name: Upload API Changes HTML Report
-        id: upload-report
+        id: upload-api-changes-report
         uses: actions/upload-artifact@v4
         with:
           name: api-changes-report
@@ -167,8 +184,36 @@ jobs:
             }
           ' output.md | tee changes-summary.md
 
-      - name: Upload Summary
+      - name: Construct Comment Data Payload
+        shell: bash -eo pipefail {0}
+        run: |
+          jq \
+            --arg pr_number ${PR_NUMBER} \
+            --arg before_sha ${BEFORE_SHA} \
+            --arg after_sha ${AFTER_SHA} \
+            --arg api_changes_report_url "${API_CHANGES_REPORT_URL}" \
+            --rawfile api_changes_summary ./changes-summary.md \
+            --slurpfile api_coverage $COVERAGE_DIFF \
+            --null-input '
+            {
+              "pr_number": ($pr_number),
+              "comment_identifier": "## Changes Analysis",
+              "template_name": "pr-change-analysis",
+              "template_data": {
+                "before_sha": ($before_sha),
+                "after_sha": ($after_sha),
+                "api_changes_report_url": ($api_changes_report_url),
+                "api_changes_summary": ($api_changes_summary),
+                "api_coverage": ($api_coverage[0])
+              }
+            }
+            ' | tee pr-comment.json
+        env:
+          PR_NUMBER: ${{ github.event.pull_request.number }}
+          API_CHANGES_REPORT_URL: ${{ steps.upload-api-changes-report.outputs.artifact-url }}
+
+      - name: Upload PR Comment Payload
         uses: actions/upload-artifact@v4
         with:
-          name: changes-summary
-          path: changes-summary.md
+          name: pr-comment
+          path: pr-comment.json

.github/workflows/pr-comment.yml

@@ -0,0 +1,74 @@
+name: Comment with PR Analysis
+
+on:
+  workflow_run:
+    workflows:
+      - Analyze PR Changes
+    types:
+      - completed
+
+jobs:
+  comment:
+    runs-on: ubuntu-latest
+    if: >
+      github.event.workflow_run.event == 'pull_request' &&
+      github.event.workflow_run.conclusion == 'success'
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          ref: refs/heads/main
+          sparse-checkout: |
+            .github
+
+      - name: Download PR Comment Payload
+        uses: actions/download-artifact@v4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          name: pr-comment
+          run-id: ${{ github.event.workflow_run.id }}
+
+      - name: Parse Payload
+        shell: bash -eo pipefail {0}
+        run:
+          PR_NUMBER=$(jq -r '.pr_number' ./pr-comment.json)
+          COMMENT_IDENTIFIER=$(jq -r '.comment_identifier' ./pr-comment.json)
+          TEMPLATE_NAME=$(jq -r '.template_name' ./pr-comment.json)
+          TEMPLATE_DATA=$(jq -c '.template_data' ./pr-comment.json)
+
+          vars=(
+            PR_NUMBER
+            COMMENT_IDENTIFIER
+            TEMPLATE_NAME
+            TEMPLATE_DATA
+          )
+
+          {
+            for var in "${vars[@]}"
+            do
+              echo "${var}=${!var}"
+            done
+          } | tee "$GITHUB_ENV"
+
+      - name: Render Comment Template
+        uses: chuhlomin/render-template
+        id: render
+        with:
+          template: .github/pr-comment-templates/${{ env.TEMPLATE_NAME }}.template.md
+          vars: ${{ env.TEMPLATE_DATA }}
+
+      - name: Find Existing Comment
+        uses: peter-evans/find-comment@v3
+        id: fc
+        with:
+          issue-number: ${{ env.PR_NUMBER }}
+          comment-author: 'github-actions[bot]'
+          body-includes: ${{ env.COMMENT_IDENTIFIER }}
+
+      - name: Create or Update Comment
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          comment-id: ${{ steps.fc.outputs.comment-id }}
+          issue-number: ${{ env.PR_NUMBER }}
+          body: ${{ steps.render.outputs.result }}
+          edit-mode: replace