feat(cleanup): add PR comment update feature (#4)

Add ability to update the deploy PR comment when cleaning up, showing
that the deployment was removed. This completes the deployment lifecycle
in the PR conversation.

New inputs:
- update-pr-comment: Enable PR comment updating (default: false)
- comment-header: Header to find the original comment

New output:
- pr-comment-updated: Whether the comment was updated

The comment changes from:
  "## 🚀 Preview Deployment" → "## 🧹 Preview Deployment (Cleaned Up)"

And shows the URL as strikethrough to indicate it's no longer available.

Author: anneschuth

CHANGELOG.md

@@ -12,6 +12,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Automatically post/update a comment on PRs with the deployment URL
   - New inputs: `comment-on-pr`, `github-token`, `comment-header`
   - Upsert behavior: updates existing comment instead of creating duplicates
+- **cleanup** action: PR comment update feature
+  - Update the deploy PR comment to show cleanup status when PR is closed
+  - New inputs: `update-pr-comment`, `comment-header`
+  - New output: `pr-comment-updated`
+  - Changes comment header from "🚀 Preview Deployment" to "🧹 Preview Deployment (Cleaned Up)"
 - CI/CD pipeline with ShellCheck, actionlint, and yamllint
 - Branch protection and governance files (CODEOWNERS, issue templates, PR template)
 - CONTRIBUTING.md with development guidelines

cleanup/README.md

@@ -18,6 +18,8 @@ Removes a ZAD deployment and optionally cleans up associated GitHub resources (e
 | `github-token` | No | `''` | GitHub token for deployment and container deletion (`deployments: write`, `packages: delete`) |
 | `github-admin-token` | No | `''` | GitHub token for environment deletion (needs repo admin permission) |
 | `api-base-url` | No | `https://operations-manager.rig.prd1.gn2.quattro.rijksapps.nl/api` | ZAD Operations Manager API base URL |
+| `update-pr-comment` | No | `false` | Update the deploy PR comment to show cleanup status |
+| `comment-header` | No | `## 🚀 Preview Deployment` | Header of the deploy comment to find and update |
 
 ## Outputs
 
@@ -27,6 +29,7 @@ Removes a ZAD deployment and optionally cleans up associated GitHub resources (e
 | `github-env-deleted` | Whether the GitHub environment was deleted (`true`/`false`) |
 | `github-deployments-deleted` | Whether GitHub deployments were deleted (`true`/`false`) |
 | `container-deleted` | Whether the container image was deleted (`true`/`false`) |
+| `pr-comment-updated` | Whether the PR comment was updated (`true`/`false`) |
 
 ## Example Usage
 
@@ -69,6 +72,7 @@ cleanup-preview:
   permissions:
     deployments: write
     packages: write
+    pull-requests: write  # For update-pr-comment
   steps:
     - name: Cleanup PR preview
       uses: RijksICTGilde/zad-actions/cleanup@v1
@@ -84,16 +88,40 @@ cleanup-preview:
         container-tag: pr-${{ github.event.number }}
         github-token: ${{ secrets.GITHUB_TOKEN }}
         github-admin-token: ${{ secrets.GITHUB_ADMIN_TOKEN }}
+        update-pr-comment: true
 ```
 
+### PR Comment Update
+
+When used with the deploy action's `comment-on-pr` feature, the cleanup action can update the PR comment to show that the deployment was cleaned up:
+
+**Before cleanup:**
+> ## 🚀 Preview Deployment
+>
+> Your changes have been deployed to a preview environment:
+>
+> **URL:** https://web-pr123-my-project.rig...
+>
+> This deployment will be automatically cleaned up when the PR is closed.
+
+**After cleanup:**
+> ## 🧹 Preview Deployment (Cleaned Up)
+>
+> ~~https://editor-pr123-my-project.rig...~~
+>
+> This deployment was automatically cleaned up when the PR was closed.
+
+To enable this, add `update-pr-comment: true` to your cleanup step. The action will find the existing deploy comment by its header and update it.
+
 ## Permissions
 
 ### Required Workflow Permissions
 
 ```yaml
 permissions:
-  deployments: write  # For delete-github-deployments
-  packages: write     # For delete-container
+  deployments: write   # For delete-github-deployments
+  packages: write      # For delete-container
+  pull-requests: write # For update-pr-comment
 ```
 
 ### Token Requirements
@@ -104,6 +132,7 @@ permissions:
 | Delete GitHub deployments | `github-token` | `deployments: write` |
 | Delete GitHub environment | `github-admin-token` | Repository admin access |
 | Delete container image | `github-token` | `packages: delete` |
+| Update PR comment | `github-token` | `pull-requests: write` |
 
 **Note:** The default `GITHUB_TOKEN` cannot delete GitHub environments. You need a Personal Access Token (PAT) or GitHub App token with admin permissions for the repository.
 
@@ -186,6 +215,7 @@ Check cleanup results and take action:
 2. **Delete GitHub Deployments** (optional): Marks all deployments for the environment as inactive, then deletes them
 3. **Delete GitHub Environment** (optional): Deletes the GitHub environment
 4. **Delete Container Image** (optional): Finds and deletes the container version with the specified tag
+5. **Update PR Comment** (optional): Updates the deploy comment to show cleanup status
 
 Each step runs independently and won't fail the action if it fails (cleanup is best-effort). Check the outputs to see what was actually deleted.
 

cleanup/action.yml

@@ -53,6 +53,14 @@ inputs:
     description: 'ZAD Operations Manager API base URL'
     required: false
     default: 'https://operations-manager.rig.prd1.gn2.quattro.rijksapps.nl/api'
+  update-pr-comment:
+    description: 'Update the deploy PR comment to show cleanup status (requires github-token with pull-requests:write)'
+    required: false
+    default: 'false'
+  comment-header:
+    description: 'Header of the deploy comment to find and update (default: "## 🚀 Preview Deployment")'
+    required: false
+    default: '## 🚀 Preview Deployment'
 
 outputs:
   zad-deleted:
@@ -67,6 +75,9 @@ outputs:
   container-deleted:
     description: 'Whether the container image was deleted'
     value: ${{ steps.delete-container.outputs.deleted }}
+  pr-comment-updated:
+    description: 'Whether the PR comment was updated'
+    value: ${{ steps.update-pr-comment.outputs.updated }}
 
 runs:
   using: 'composite'
@@ -261,3 +272,48 @@ runs:
         done
 
         echo "deleted=$DELETED" >> "$GITHUB_OUTPUT"
+
+    - name: Update PR Comment
+      id: update-pr-comment
+      if: inputs.update-pr-comment == 'true' && inputs.github-token != '' && github.event_name == 'pull_request'
+      shell: bash
+      env:
+        GH_TOKEN: ${{ inputs.github-token }}
+        COMMENT_HEADER: ${{ inputs.comment-header }}
+        PR_NUMBER: ${{ github.event.pull_request.number }}
+        GITHUB_REPOSITORY: ${{ github.repository }}
+        DEPLOYMENT_NAME: ${{ inputs.deployment-name }}
+        PROJECT_ID: ${{ inputs.project-id }}
+      run: |
+        # Build the updated comment body
+        COMMENT_BODY="## 🧹 Preview Deployment (Cleaned Up)
+
+        ~~https://editor-${DEPLOYMENT_NAME}-${PROJECT_ID}.rig.prd1.gn2.quattro.rijksapps.nl~~
+
+        This deployment was automatically cleaned up when the PR was closed."
+
+        # Find existing comment by header
+        EXISTING_COMMENT=$(gh api "repos/${GITHUB_REPOSITORY}/issues/${PR_NUMBER}/comments" \
+          --jq ".[] | select(.body | startswith(\"${COMMENT_HEADER}\")) | {id: .id, body: .body}" \
+          2>/dev/null | head -n1 || echo "")
+
+        if [ -z "$EXISTING_COMMENT" ]; then
+          echo "No existing deploy comment found with header: ${COMMENT_HEADER}"
+          echo "updated=false" >> "$GITHUB_OUTPUT"
+          exit 0
+        fi
+
+        COMMENT_ID=$(echo "$EXISTING_COMMENT" | jq -r '.id')
+
+        if [ -n "$COMMENT_ID" ] && [ "$COMMENT_ID" != "null" ]; then
+          echo "Updating PR comment (ID: $COMMENT_ID)"
+          gh api "repos/${GITHUB_REPOSITORY}/issues/comments/${COMMENT_ID}" \
+            -X PATCH \
+            -f body="$COMMENT_BODY" \
+            --silent
+          echo "PR comment updated to show cleanup status"
+          echo "updated=true" >> "$GITHUB_OUTPUT"
+        else
+          echo "Could not find comment ID"
+          echo "updated=false" >> "$GITHUB_OUTPUT"
+        fi