feat: comment on pull requests with the next version of the software,…

… if it deploys commit-id:08b4d420
levibostian · Nov 25, 2024 · 5611a75 · 5611a75
1 parent f3b3681
commit 5611a75
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 0 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -45,6 +45,7 @@ jobs:
     if: github.event_name == 'pull_request' # Only run on PRs, otherwise we will trigger a deployment by accident. 
     permissions:    
       contents: read # only offer read permissions for dry-run to prevent accidental deployments
+      pull-requests: write # allow commenting on PRs
     steps:
     - uses: actions/checkout@v4
     - name: Run deployment tool in dry-run mode

diff --git a/action.yml b/action.yml
@@ -18,6 +18,12 @@ inputs:
   simulated_merge_type:
     description: 'When running in a pull request, what type of merge to simulate to run the tool in test mode. Note: This input option is planned to go away in favor of reading github repo settings. Options: merge, squash, rebase.'
     default: 'merge' # options: merge, squash, rebase
+  pull_request_comment_body: 
+    description: 'The comment body to use when creating a pull request comment. This content is in markdown and can contain some variables. See: https://github.com/peter-evans/create-or-update-comment?tab=readme-ov-file#using-a-markdown-template'
+    default: ''
+  make_pull_request_comment:
+    description: 'If a pull request comment should be made. Value is string values "true" or "false".'
+    default: 'true'
 
 outputs:
   new_release_version:
@@ -39,6 +45,28 @@ runs:
       run: git fetch
       shell: bash 
 
+    - name: Find pull request comment previously created, if there is one. 
+      if: ${{ github.event_name == 'pull_request' }}
+      uses: peter-evans/find-comment@v3
+      id: find-comment
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        comment-author: 'github-actions[bot]'
+        body-includes: '<!-- new-deployment-tool-deploy-run-output -->'
+        token: ${{ inputs.github_token }}  
+
+    - name: Create or update pull request comment with new deployment tool output
+      uses: peter-evans/create-or-update-comment@v4
+      if: ${{ github.event_name == 'pull_request' && inputs.make_pull_request_comment == 'true' }}
+      with:
+        comment-id: ${{ steps.find-comment.outputs.comment-id }}
+        issue-number: ${{ github.event.pull_request.number }}
+        body: |
+          <!-- new-deployment-tool-deploy-run-output -->
+          ## New deployment tool results
+          Running deployment...refresh webpage to see results when done. 
+        edit-mode: replace
+
     - name: Run deployment tool 
       # Deno's runtime permissions are a great feature. It would be nice to take advantage of it, however, it may not be possible with future features like running plugins. 
       #
@@ -50,3 +78,40 @@ runs:
         INPUT_GITHUB_TOKEN: ${{ inputs.github_token }}
         INPUT_DEPLOY_COMMANDS: ${{ inputs.deploy_commands }}
         INPUT_ANALYZE_COMMITS_CONFIG: ${{ inputs.analyze_commits_config }}
+
+    - name: Pull request comment if the deployment failed 
+      uses: peter-evans/create-or-update-comment@v4
+      if: ${{ inputs.make_pull_request_comment == 'true' && steps.deployment.outputs.test_mode_on == 'true' && steps.deployment.outcome != 'success' }}
+      with:
+        comment-id: ${{ steps.find-comment.outputs.comment-id }}
+        issue-number: ${{ github.event.pull_request.number }}
+        body: |
+          <!-- new-deployment-tool-deploy-run-output -->
+          ## New deployment tool results 
+          There was a failure when running the deployment. Check [the logs](https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}) to see what went wrong.
+        edit-mode: replace
+
+    - name: Pull request comment if there will be a release
+      uses: peter-evans/create-or-update-comment@v4
+      if: ${{ inputs.make_pull_request_comment == 'true' && steps.deployment.outputs.test_mode_on == 'true' && steps.deployment.outcome == 'success' && steps.deployment.outputs.new_release_version != '' }}
+      with:
+        comment-id: ${{ steps.find-comment.outputs.comment-id }}
+        issue-number: ${{ github.event.pull_request.number }}
+        body: |
+          <!-- new-deployment-tool-deploy-run-output -->
+          ## New deployment tool results
+          If this pull request is merged, the next version of the project will be: ${{ steps.deployment.outputs.new_release_version }}          
+        edit-mode: replace
+
+    - name: Pull request comment if there will not be a release
+      uses: peter-evans/create-or-update-comment@v4
+      if: ${{ inputs.make_pull_request_comment == 'true' && steps.deployment.outputs.test_mode_on == 'true' && steps.deployment.outcome == 'success' && steps.deployment.outputs.new_release_version == '' }}
+      with:
+        comment-id: ${{ steps.find-comment.outputs.comment-id }}
+        issue-number: ${{ github.event.pull_request.number }}
+        body: |
+          <!-- new-deployment-tool-deploy-run-output -->
+          ## New deployment tool results
+          If this pull request is merged, there will not be a new release. 
+        edit-mode: replace        
+