fix: add a comment when pr documentation is removed (#1064)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: moe-ad

doc-deploy-dev/action.yml

@@ -388,6 +388,7 @@ runs:
       shell: bash
       env:
         GITHUB_TOKEN: ${{ inputs.token }} # For gh CLI authentication
+        CNAME: ${{ inputs.cname }}
       run: |
         if [[ -d "pull/" ]]; then
             for pr_number in $(ls pull/); do
@@ -403,6 +404,8 @@ runs:
 
               # Remove pr directory if it is closed
               if [[ ${closed} == "true" ]]; then
+                message="This PR has been closed. Documentation for this pull request will shortly be removed from its [former deployment address](https://${CNAME}/pull/${pr_number})."
+                gh pr comment "${pr_number}" --body "${message}"
                 echo "Removing directory ${pr_number}..."
                 rm -rf "pull/${pr_number}"
               fi

doc/source/changelog/1064.fixed.md

@@ -0,0 +1 @@
+Add a comment when pr documentation is removed