Merge pull request #343 from github/improvements

General Cleanup + SHA outputs for merge deploy mode

__tests__/functions/identical-commit-check.test.js

@@ -2,6 +2,7 @@ import * as core from '@actions/core'
 import {identicalCommitCheck} from '../../src/functions/identical-commit-check'
 import {COLORS} from '../../src/functions/colors'
 
+const saveStateMock = jest.spyOn(core, 'saveState')
 const setOutputMock = jest.spyOn(core, 'setOutput')
 const infoMock = jest.spyOn(core, 'info')
 
@@ -13,6 +14,7 @@ beforeEach(() => {
   jest.spyOn(core, 'setOutput').mockImplementation(() => {})
   jest.spyOn(core, 'info').mockImplementation(() => {})
   jest.spyOn(core, 'debug').mockImplementation(() => {})
+  jest.spyOn(core, 'saveState').mockImplementation(() => {})
 
   context = {
     repo: {
@@ -37,7 +39,7 @@ beforeEach(() => {
         getBranch: jest.fn().mockReturnValue({
           data: {
             commit: {
-              sha: 'deadbeef',
+              sha: 'abcdef',
               commit: {
                 tree: {
                   sha: 'deadbeef'
@@ -89,6 +91,8 @@ test('checks if the default branch sha and deployment sha are identical, and the
   )
   expect(setOutputMock).toHaveBeenCalledWith('continue', 'false')
   expect(setOutputMock).toHaveBeenCalledWith('environment', 'production')
+  expect(setOutputMock).not.toHaveBeenCalledWith('sha', 'abcdef')
+  expect(saveStateMock).not.toHaveBeenCalledWith('sha', 'abcdef')
 })
 
 test('checks if the default branch sha and deployment sha are identical, and they are not', async () => {
@@ -105,9 +109,20 @@ test('checks if the default branch sha and deployment sha are identical, and the
   expect(
     await identicalCommitCheck(octokit, context, 'production')
   ).toStrictEqual(false)
+  expect(infoMock).toHaveBeenCalledWith(
+    `📍 latest commit sha on ${COLORS.highlight}main${COLORS.reset}: ${COLORS.info}abcdef${COLORS.reset}`
+  )
+  expect(infoMock).toHaveBeenCalledWith(
+    `🌲 latest default ${COLORS.info}branch${COLORS.reset} tree sha: ${COLORS.info}deadbeef${COLORS.reset}`
+  )
+  expect(infoMock).toHaveBeenCalledWith(
+    `🌲 latest ${COLORS.info}deployment${COLORS.reset} tree sha:     ${COLORS.info}beefdead${COLORS.reset}`
+  )
   expect(infoMock).toHaveBeenCalledWith(
     `🚀 a ${COLORS.success}new deployment${COLORS.reset} will be created based on your configuration`
   )
   expect(setOutputMock).toHaveBeenCalledWith('continue', 'true')
   expect(setOutputMock).toHaveBeenCalledWith('environment', 'production')
+  expect(setOutputMock).toHaveBeenCalledWith('sha', 'abcdef')
+  expect(saveStateMock).toHaveBeenCalledWith('sha', 'abcdef')
 })

__tests__/functions/trigger-check.test.js

@@ -3,6 +3,7 @@ import * as core from '@actions/core'
 import {COLORS} from '../../src/functions/colors'
 
 const color = COLORS.highlight
+const colorReset = COLORS.reset
 const infoMock = jest.spyOn(core, 'info')
 const debugMock = jest.spyOn(core, 'debug')
 
@@ -18,7 +19,7 @@ test('checks a message and finds a standard trigger', async () => {
   const trigger = '.deploy'
   expect(await triggerCheck(body, trigger)).toBe(true)
   expect(infoMock).toHaveBeenCalledWith(
-    `✅ comment body starts with trigger: ${color}.deploy`
+    `✅ comment body starts with trigger: ${color}.deploy${colorReset}`
   )
 })
 
@@ -27,7 +28,7 @@ test('checks a message and does not find trigger', async () => {
   const trigger = '.deploy'
   expect(await triggerCheck(body, trigger)).toBe(false)
   expect(debugMock).toHaveBeenCalledWith(
-    `comment body does not start with trigger: ${color}.deploy`
+    `comment body does not start with trigger: ${color}.deploy${colorReset}`
   )
 })
 
@@ -50,6 +51,6 @@ test('checks a message and does not find global trigger', async () => {
   const trigger = '.deploy'
   expect(await triggerCheck(body, trigger)).toBe(false)
   expect(debugMock).toHaveBeenCalledWith(
-    `comment body does not start with trigger: ${color}.deploy`
+    `comment body does not start with trigger: ${color}.deploy${colorReset}`
   )
 })

docs/merge-commit-strategy.md

@@ -65,6 +65,8 @@ jobs:
       # Check out the repository
       - uses: actions/checkout@v4
         if: ${{ steps.deployment-check.outputs.continue == 'true' }} # only run if the Action returned 'true' for the 'continue' output
+        with:
+          ref: ${{ steps.deployment-check.outputs.sha }} # checkout the EXACT sha of the default branch for deployment (latest commit on the default branch)
 
       # Do your deployment here! (However you want to do it)
       # This could be deployment logic via SSH, Terraform, AWS, Heroku, etc.

src/functions/action-status.js

@@ -50,19 +50,19 @@ export async function actionStatus(
     reaction = thumbsDown
   }
 
-  // add a reaction to the issue_comment to indicate success or failure
-  await octokit.rest.reactions.createForIssueComment({
+  // remove the initial reaction on the IssueOp comment that triggered this action
+  await octokit.rest.reactions.deleteForIssueComment({
     ...context.repo,
     comment_id: context.payload.comment.id,
-    content: reaction,
+    reaction_id: reactionId,
     headers: API_HEADERS
   })
 
-  // remove the initial reaction on the IssueOp comment that triggered this action
-  await octokit.rest.reactions.deleteForIssueComment({
+  // add a reaction to the issue_comment to indicate success or failure
+  await octokit.rest.reactions.createForIssueComment({
     ...context.repo,
     comment_id: context.payload.comment.id,
-    reaction_id: reactionId,
+    content: reaction,
     headers: API_HEADERS
   })
 }