Merge pull request #377 from github/deployment-confirmation-commit-metadata

Committer metadata on confirmation comments

Author: GrantBirki

__tests__/functions/deployment-confirmation.test.js

@@ -80,6 +80,8 @@ beforeEach(() => {
     log_url: 'https://github.com/corp/test/actions/runs/12345',
     ref: 'cool-branch',
     sha: 'abc123',
+    committer: 'monalisa',
+    commit_html_url: 'https://github.com/corp/test/commit/abc123',
     isVerified: true,
     noopMode: false,
     isFork: false,
@@ -143,6 +145,7 @@ test('successfully prompts for deployment confirmation and gets confirmed by the
   data.params = null
   data.parsed_params = null
   data.environmentUrl = null
+  data.isVerified = false
 
   // Mock that the user adds a +1 reaction
   octokit.rest.reactions.listForIssueComment.mockResolvedValueOnce({

__tests__/main.test.js

@@ -130,11 +130,15 @@ beforeEach(() => {
             return {
               data: {
                 sha: mock_sha,
+                html_url: `https://github.com/corp/test/commit/${mock_sha}`,
                 commit: {
                   author: {
                     date: '2024-10-15T12:00:00Z'
                   },
                   verification: no_verification
+                },
+                committer: {
+                  login: 'monalisa'
                 }
               }
             }
@@ -1083,11 +1087,15 @@ test('detects an out of date branch and exits', async () => {
             return {
               data: {
                 sha: mock_sha,
+                html_url: `https://github.com/corp/test/commit/${mock_sha}`,
                 commit: {
                   author: {
                     date: '2024-10-15T12:00:00Z'
                   },
                   verification: no_verification
+                },
+                committer: {
+                  login: 'monalisa'
                 }
               }
             }

dist/index.js

@@ -2,6 +2,7 @@ import * as core from '@actions/core'
 import dedent from 'dedent-js'
 import {COLORS} from './colors'
 import {API_HEADERS} from './api-headers'
+import {timestamp} from './timestamp'
 
 const thumbsUp = '+1'
 const thumbsDown = '-1'
@@ -16,7 +17,8 @@ export async function deploymentConfirmation(context, octokit, data) {
 
     In order to proceed with this deployment, __${context.actor}__ must react to this comment with either a 👍 or a 👎.
 
-    - Commit: \`${data.sha}\`
+    - Commit: [\`${data.sha}\`](${data.commit_html_url})
+    - Committer: \`${data.committer}\` - **${data.isVerified ? 'verified' : 'unverified'}**
     - Environment: \`${data.environment}\`
     - Branch: \`${data.ref}\`
     - Deployment Type: \`${data.deploymentType}\`
@@ -40,7 +42,9 @@ export async function deploymentConfirmation(context, octokit, data) {
       "git": {
         "branch": "${data.ref}",
         "commit": "${data.sha}",
-        "verified": ${data.isVerified}
+        "verified": ${data.isVerified},
+        "committer": "${data.committer}",
+        "html_url": "${data.commit_html_url}"
       },
       "context": {
         "actor": "${context.actor}",
@@ -102,7 +106,7 @@ export async function deploymentConfirmation(context, octokit, data) {
             await octokit.rest.issues.updateComment({
               ...context.repo,
               comment_id: commentId,
-              body: `${message}\n\n✅ Deployment confirmed by __${context.actor}__.`,
+              body: `${message}\n\n✅ Deployment confirmed by __${context.actor}__ at \`${timestamp()}\` UTC.`,
               headers: API_HEADERS
             })
 
@@ -116,7 +120,7 @@ export async function deploymentConfirmation(context, octokit, data) {
             await octokit.rest.issues.updateComment({
               ...context.repo,
               comment_id: commentId,
-              body: `${message}\n\n❌ Deployment rejected by __${context.actor}__.`,
+              body: `${message}\n\n❌ Deployment rejected by __${context.actor}__ at \`${timestamp()}\` UTC.`,
               headers: API_HEADERS
             })
 
@@ -149,7 +153,7 @@ export async function deploymentConfirmation(context, octokit, data) {
   await octokit.rest.issues.updateComment({
     ...context.repo,
     comment_id: commentId,
-    body: `${message}\n\n⏱️ Deployment confirmation timed out after \`${data.deployment_confirmation_timeout}\` seconds. The deployment request has been rejected.`,
+    body: `${message}\n\n⏱️ Deployment confirmation timed out after \`${data.deployment_confirmation_timeout}\` seconds. The deployment request has been rejected at \`${timestamp()}\` UTC.`,
     headers: API_HEADERS
   })
 

dist/index.js.map

@@ -1,4 +1,4 @@
-// Helper function to generate an ISO 8601 formatted timestamp string
+// Helper function to generate an ISO 8601 formatted timestamp string in UTC
 // :returns: An ISO 8601 formatted timestamp string (ex: 2025-01-01T00:00:00.000Z)
 export function timestamp() {
   const now = new Date()

src/functions/deployment-confirmation.js

@@ -466,6 +466,9 @@ export async function run() {
       headers: API_HEADERS
     })
 
+    const committer = commitData.data.committer.login
+    const commit_html_url = commitData.data.html_url
+
     // Run commit safety checks
     const commitSafetyCheckResults = await commitSafetyChecks(context, {
       commit: commitData.data.commit,
@@ -627,7 +630,9 @@ export async function run() {
           parsed_params: parsed_params,
           github_run_id: github_run_id,
           noopMode: precheckResults.noopMode,
-          isFork: precheckResults.isFork
+          isFork: precheckResults.isFork,
+          committer: committer,
+          commit_html_url: commit_html_url
         }
       )
       if (deploymentConfirmed === true) {
@@ -675,7 +680,9 @@ export async function run() {
         "git": {
           "branch": "${precheckResults.ref}",
           "commit": "${precheckResults.sha}",
-          "verified": ${commitSafetyCheckResults.isVerified}
+          "verified": ${commitSafetyCheckResults.isVerified},
+          "committer": "${committer}",
+          "html_url": "${commit_html_url}"
         },
         "context": {
           "actor": "${context.actor}",