chore: when diffing, update existing comments

LW-10047

Author: michalrus

.github/workflows/std.yml

@@ -44,7 +44,55 @@ concurrency:
   group: std-${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:
+
+  tmp-comment:
+    name: Diff & Comment
+    if: github.event_name == 'pull_request' && (github.base_ref == 'master')
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Stub the Diff
+        run: |
+          echo "Hello, world! take 3" >pr-comment.md
+      - name: Post Comment on the PR
+        env:
+          GH_TOKEN: ${{ github.token }}
+          COMMENT_MARKER: "nix-helm-diff-777f3796-c80d-4d68-bf4f-8faad564f03f"
+        run: |
+          set -x
+          prNumber=$(cut -d/ -f1 <<<'${{ github.ref_name }}')
+          # The `gh` command doesn’t return numeric comment ids, but instead node_ids, which don’t work with the regular API
+          # Why the regular API? Because the `gh` command doesn’t support editing comments:
+          existingCommentId=$(
+            curl --fail-with-body -sSL \
+              -X GET \
+              -H "Authorization: Bearer $GH_TOKEN" \
+              -H "Accept: application/vnd.github+json" \
+              -H "X-GitHub-Api-Version: 2022-11-28" \
+              "https://api.github.com/repos/${GITHUB_REPOSITORY}/issues/${prNumber}/comments" \
+            | jq -r --arg commentMarker "$COMMENT_MARKER" 'first(.[] | select(.body | contains($commentMarker)) | .id)'
+          )
+          if [ -z "$existingCommentId" ]; then
+            gh pr comment "$prNumber" --body "$(cat pr-comment.md) <!-- $COMMENT_MARKER -->"
+          else
+            curl --fail-with-body -sSL \
+              -X PATCH \
+              -H "Authorization: Bearer $GH_TOKEN" \
+              -H "Accept: application/vnd.github+json" \
+              -H "X-GitHub-Api-Version: 2022-11-28" \
+              "https://api.github.com/repos/${GITHUB_REPOSITORY}/issues/comments/${existingCommentId}" \
+              -d "$(jq --null-input --arg body "$(cat pr-comment.md) <!-- $COMMENT_MARKER -->" '{body: $body}')"
+          fi
+      - name: Fail
+        run: |
+          exit 77
+
+
   discover:
+    needs: tmp-comment
     outputs:
       hits: ${{ steps.discovery.outputs.hits }}
       deployment-matrix: ${{ steps.deployment-matrix.outputs.deployment-matrix }}
@@ -218,9 +266,29 @@ jobs:
       - name: Post Comment on the PR
         env:
           GH_TOKEN: ${{ github.token }}
+          COMMENT_MARKER: "nix-helm-diff-777f3796-c80d-4d68-bf4f-8faad564f03f"
         run: |
           prNumber=$(cut -d/ -f1 <<<'${{ github.ref_name }}')
-          gh pr comment "$prNumber" --body "$(cat pr-comment.md)"
+
+          echo ==================================================================
+          gh pr view "$prNumber" --json comments | tee comments.json
+          echo ==================================================================
+
+          existingCommentId=$(cat comments.json \
+            | jq -r --arg commentMarker "$COMMENT_MARKER" 'first(.comments[] | select(.body | contains($commentMarker)) | .id)')
+          if [ -z "$existingCommentId" ]; then
+            echo "; new comment needed"
+            gh pr comment "$prNumber" --body "$(cat pr-comment.md) <!-- $COMMENT_MARKER -->"
+          else
+            # The `gh` command doesn’t have anything like `edit-comment`…
+            curl --fail-with-body -sSL \
+              -X PATCH \
+              -H "Authorization: Bearer $GH_TOKEN" \
+              -H "Accept: application/vnd.github+json" \
+              -H "X-GitHub-Api-Version: 2022-11-28" \
+              "https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls/comments/${existingCommentId}" \
+              -d "$(jq --null-input --arg body "$(cat pr-comment.md) <!-- $COMMENT_MARKER -->" '{body: $body}')"
+          fi
 
 
   deploy: