add more attributes to the deployment payload

Author: GrantBirki

__tests__/main.test.js

@@ -16,6 +16,7 @@ import * as isDeprecated from '../src/functions/deprecated-checks'
 import * as nakedCommandCheck from '../src/functions/naked-command-check'
 import * as validDeploymentOrder from '../src/functions/valid-deployment-order'
 import * as commitSafetyChecks from '../src/functions/commit-safety-checks'
+import * as timestamp from '../src/functions/timestamp'
 import {COLORS} from '../src/functions/colors'
 
 const setOutputMock = jest.spyOn(core, 'setOutput')
@@ -113,7 +114,7 @@ beforeEach(() => {
       rest: {
         issues: {
           createComment: jest.fn().mockReturnValueOnce({
-            data: {}
+            data: {id: 123456}
           })
         },
         repos: {
@@ -153,7 +154,10 @@ beforeEach(() => {
     return true
   })
   jest.spyOn(reactEmote, 'reactEmote').mockImplementation(() => {
-    return {data: {id: '123'}}
+    return {data: {id: 123}}
+  })
+  jest.spyOn(timestamp, 'timestamp').mockImplementation(() => {
+    return '2025-01-01T00:00:00.000Z'
   })
   jest.spyOn(prechecks, 'prechecks').mockImplementation(() => {
     return {
@@ -175,7 +179,8 @@ beforeEach(() => {
     .mockImplementation(() => {
       return {
         status: true,
-        message: 'success'
+        message: 'success',
+        isVerified: true
       }
     })
   jest
@@ -964,7 +969,7 @@ test('detects an out of date branch and exits', async () => {
       rest: {
         issues: {
           createComment: jest.fn().mockReturnValueOnce({
-            data: {}
+            data: {id: 123123}
           })
         },
         repos: {
@@ -1063,7 +1068,8 @@ test('fails commitSafetyChecks', async () => {
       return {
         status: false,
         message:
-          '### ⚠️ Cannot proceed with deployment... a scary commit was found'
+          '### ⚠️ Cannot proceed with deployment... a scary commit was found',
+        isVerified: false
       }
     })
   jest.spyOn(actionStatus, 'actionStatus').mockImplementation(() => {
@@ -1266,7 +1272,14 @@ test('stores params and parsed params into context with complex params', async (
       parsed_params,
       sha: 'deadbeef',
       type: 'branch-deploy',
-      github_run_id: 12345
+      github_run_id: 12345,
+      initial_comment_id: 123,
+      initial_reaction_id: 123,
+      deployment_started_comment_id: 123456,
+      timestamp: '2025-01-01T00:00:00.000Z',
+      commit_verified: true,
+      actor: 'monalisa',
+      stable_branch_used: false
     })
   })
   expect(await run()).toBe('success')

dist/index.js

@@ -11,6 +11,14 @@ Here is the data that the branch-deploy Action will add to the deployment payloa
     "params": "<string>",
     "parsed_params": {},
     "github_run_id": 123,
+    "initial_comment_id": 123,
+    "initial_reaction_id": 123,
+    "deployment_started_comment_id": 123456,
+    "deployment_started_comment_id": 123123,
+    "timestamp": "2025-01-01T00:00:00.000Z",
+    "commit_verified": true,
+    "actor": "<string>",
+    "stable_branch_used": false
 }
 ```
 
@@ -19,3 +27,10 @@ Here is the data that the branch-deploy Action will add to the deployment payloa
 - `params` - This is the raw string of parameters that were passed to the branch-deploy Action. You can read more about parameters [here](./parameters.md).
 - `parsed_params` - This is the parsed version of the `params` string. This is a JSON object that is created by parsing the `params` string. You can read more about parameters [here](./parameters.md).
 - `github_run_id` - This is the ID of the GitHub Action run that created the deployment. This can be useful if you need to access the logs of the deployment.
+- `initial_comment_id` - This is the ID of the initial (trigger) comment that kicked off the branch-deploy Action. Example: `.deploy` would be the comment that triggered the deployment and this would be the ID of that comment.
+- `initial_reaction_id` - This is the ID of the initial reaction that was left on the trigger comment by the branch-deploy Action. This is usually a pair of eyes (👀) to indicate that the branch-deploy Action has detected the trigger comment and it is running logic.
+- `deployment_started_comment_id` - This is the ID of the comment that the branch-deploy Action leaves below the trigger comment. It usually contains information about the deployment that is about to take place. Example: `Deployment Triggered 🚀... GrantBirki, started a branch deployment to production`
+- `timestamp` - This is the timestamp of when the deployment was created from the perspective of the branch-deploy Action.
+- `commit_verified` - This is a boolean that indicates whether the commit that is being deployed is verified.
+- `actor` - This is the username of the user that triggered the deployment.
+- `stable_branch_used` - This is a boolean that indicates whether the stable branch was used for the deployment. This will be `true` if the stable branch was used and `false` if the stable branch was not used.

dist/index.js.map

@@ -730,7 +730,14 @@ export async function run() {
       sha: precheckResults.sha,
       params: params,
       parsed_params: parsed_params,
-      github_run_id: github_run_id
+      github_run_id: github_run_id,
+      initial_comment_id: context.payload.comment.id,
+      initial_reaction_id: reactRes.data.id,
+      deployment_started_comment_id: deploymentStartedComment.data.id,
+      timestamp: deployment_start_time,
+      commit_verified: commitSafetyCheckResults.isVerified,
+      actor: context.actor,
+      stable_branch_used: stableBranchUsed
     }
 
     // Create a new deployment