Merge pull request #272 from github/post-deploy-features

Post Deploy Feature Improvements

Author: GrantBirki

README.md

@@ -289,6 +289,10 @@ As seen above, we have two steps. One for a noop deploy, and one for a regular d
 | `sticky_locks_for_noop` | `false` | `"false"` | If set to `"true"`, then sticky_locks will also be used for noop deployments. This can be useful in some cases but it often leads to locks being left behind when users test noop deployments. |
 | `allow_sha_deployments` | `false` | `"false"` | If set to `"true"`, then you can deploy a specific sha instead of a branch. Example: `".deploy 1234567890abcdef1234567890abcdef12345678 to production"` - This is dangerous and potentially unsafe, [view the docs](docs/sha-deployments.md) to learn more |
 | `disable_naked_commands` | `false` | `"false"` | If set to `"true"`, then naked commands will be disabled. Example: `.deploy` will not trigger a deployment. Instead, you must use `.deploy to production` to trigger a deployment. This is useful if you want to prevent accidental deployments from happening. View the [docs](docs/naked-commands.md) to learn more |
+| `successful_deploy_labels` | `false` | `""` | A comma separated list of labels to add to the pull request when a deployment is successful. Example: `"deployed,success"` |
+| `successful_noop_labels` | `false` | `""` | A comma separated list of labels to add to the pull request when a noop deployment is successful. Example: `"noop,success"` |
+| `failed_deploy_labels` | `false` | `""` | A comma separated list of labels to add to the pull request when a deployment fails. Example: `"failed,deploy-failed"` |
+| `failed_noop_labels` | `false` | `""` | A comma separated list of labels to add to the pull request when a noop deployment fails. Example: `"failed,noop-failed"` |
 
 ## Outputs 📤
 
@@ -320,6 +324,11 @@ As seen above, we have two steps. One for a noop deploy, and one for a regular d
 | `global_lock_released` | The string "true" if the global lock was released |
 | `unlocked_environments` | Only exposed when using the "unlock on merge" mode - This output variable will contain a comma separated list of the environments that were unlocked - See the [unlock on merge mode](docs/unlock-on-merge.md) documentation for more details |
 | `sha_deployment` | If `allow_sha_deployments` is enabled, and a sha deployment is performed instead of a branch deployment, this output variable will contain the sha that was deployed. Otherwise, this output variable will be empty |
+| `review_decision` | The pull request review status. Can be one of a few values - examples: `APPROVED`, `skip_reviews`, `REVIEW_REQUIRED`, `null` |
+| `is_outdated` | The string `"true"` if the branch is out-of-date, otherwise `"false"` |
+| `merge_state_status` | The status of the merge state. Can be one of a few values - examples: `"DIRTY"`, `"DRAFT"`, `"CLEAN"`, etc |
+| `commit_status` | The status of the commit. Can be one of a few values - examples: `"SUCCESS"`, `null`, `"skip_ci"`, `"PENDING"`, `"FAILURE"` etc |
+| `approved_reviews_count` | The number of approved reviews on the pull request |
 
 ## Custom Deployment Messages ✏️
 

__tests__/functions/check-input.test.js

@@ -1,23 +1,23 @@
 import {checkInput} from '../../src/functions/check-input'
 
 test('checks an input an finds that it is valid', async () => {
-  expect(await checkInput('production')).toStrictEqual('production')
+  expect(checkInput('production')).toStrictEqual('production')
 })
 
 test('checks an input an finds that it is valid with true/false strings', async () => {
-  expect(await checkInput('true')).toStrictEqual('true')
+  expect(checkInput('true')).toStrictEqual('true')
 
-  expect(await checkInput('false')).toStrictEqual('false')
+  expect(checkInput('false')).toStrictEqual('false')
 })
 
 test('checks an empty string input an finds that it is invalid', async () => {
-  expect(await checkInput('')).toStrictEqual(null)
+  expect(checkInput('')).toStrictEqual(null)
 })
 
 test('checks a null object input an finds that it is invalid', async () => {
-  expect(await checkInput(null)).toStrictEqual(null)
+  expect(checkInput(null)).toStrictEqual(null)
 })
 
 test('checks a string of null input an finds that it is invalid', async () => {
-  expect(await checkInput('null')).toStrictEqual(null)
+  expect(checkInput('null')).toStrictEqual(null)
 })

__tests__/functions/label.test.js

@@ -0,0 +1,96 @@
+import {label} from '../../src/functions/label'
+import * as core from '@actions/core'
+
+var context
+var octokit
+beforeEach(() => {
+  jest.spyOn(core, 'info').mockImplementation(() => {})
+  jest.spyOn(core, 'debug').mockImplementation(() => {})
+  jest.clearAllMocks()
+
+  context = {
+    repo: {
+      owner: 'corp',
+      repo: 'test'
+    },
+    issue: {
+      number: 1
+    }
+  }
+
+  octokit = {
+    rest: {
+      issues: {
+        addLabels: jest.fn().mockReturnValueOnce({
+          data: {}
+        }),
+        removeLabel: jest.fn().mockReturnValueOnce({
+          data: {}
+        }),
+        listLabelsOnIssue: jest.fn().mockReturnValueOnce({
+          data: [
+            {
+              name: 'deploy-failed'
+            },
+            {
+              name: 'noop'
+            }
+          ]
+        })
+      }
+    }
+  }
+})
+
+test('adds a single label to a pull request and removes none', async () => {
+  expect(await label(context, octokit, ['read-for-review'], [])).toStrictEqual({
+    added: ['read-for-review'],
+    removed: []
+  })
+})
+
+test('adds two labels to a pull request and removes none', async () => {
+  expect(
+    await label(context, octokit, ['read-for-review', 'cool-label'], [])
+  ).toStrictEqual({
+    added: ['read-for-review', 'cool-label'],
+    removed: []
+  })
+})
+
+test('does not add or remove any labels', async () => {
+  expect(await label(context, octokit, [], [])).toStrictEqual({
+    added: [],
+    removed: []
+  })
+})
+
+test('adds a single label to a pull request and removes a single label', async () => {
+  expect(
+    await label(context, octokit, ['deploy-success'], ['deploy-failed'])
+  ).toStrictEqual({
+    added: ['deploy-success'],
+    removed: ['deploy-failed']
+  })
+})
+
+test('adds two labels to a pull request and removes two labels', async () => {
+  expect(
+    await label(
+      context,
+      octokit,
+      ['deploy-success', 'read-for-review'],
+      ['deploy-failed', 'noop']
+    )
+  ).toStrictEqual({
+    added: ['deploy-success', 'read-for-review'],
+    removed: ['deploy-failed', 'noop']
+  })
+})
+
+test('does not add any labels and removes a single label', async () => {
+  expect(await label(context, octokit, [], ['noop'])).toStrictEqual({
+    added: [],
+    removed: ['noop']
+  })
+})

__tests__/functions/post-deploy-message.test.js

@@ -11,6 +11,7 @@ var environment_url_simple
 var status
 var noop
 var ref
+var approved_reviews_count
 
 beforeEach(() => {
   jest.clearAllMocks()
@@ -27,6 +28,7 @@ beforeEach(() => {
   status = 'success'
   noop = false
   ref = 'test-ref'
+  approved_reviews_count = '4'
 
   context = {
     actor: 'monalisa',
@@ -52,7 +54,8 @@ test('successfully constructs a post deploy message with the defaults', async ()
       environment_url, // environment_url
       status, // status
       noop, // noop
-      ref // ref
+      ref, // ref
+      approved_reviews_count // approved_reviews_count
     )
   ).toStrictEqual(
     dedent(`
@@ -72,7 +75,8 @@ test('successfully constructs a post deploy message with the defaults during a "
       environment_url, // environment_url
       status, // status
       true, // noop
-      ref // ref
+      ref, // ref
+      approved_reviews_count // approved_reviews_count
     )
   ).toStrictEqual(
     dedent(`
@@ -90,7 +94,8 @@ test('successfully constructs a post deploy message with the defaults during a d
       environment_url, // environment_url
       'failure', // status
       noop, // noop
-      ref // ref
+      ref, // ref
+      approved_reviews_count // approved_reviews_count
     )
   ).toStrictEqual(
     dedent(`
@@ -108,7 +113,8 @@ test('successfully constructs a post deploy message with the defaults during a d
       environment_url, // environment_url
       'unknown', // status
       noop, // noop
-      ref // ref
+      ref, // ref
+      approved_reviews_count // approved_reviews_count
     )
   ).toStrictEqual(
     dedent(`
@@ -128,7 +134,8 @@ test('successfully constructs a post deploy message with a custom env var', asyn
       environment_url, // environment_url
       status, // status
       noop, // noop
-      ref // ref
+      ref, // ref
+      approved_reviews_count // approved_reviews_count
     )
   ).toStrictEqual(
     dedent(`
@@ -156,7 +163,8 @@ test('successfully constructs a post deploy message with a custom markdown file'
       environment_url, // environment_url
       status, // status
       noop, // noop
-      ref // ref
+      ref, // ref
+      approved_reviews_count // approved_reviews_count
     )
   ).toStrictEqual(
     dedent(`### Deployment Results :rocket:
@@ -169,6 +177,7 @@ test('successfully constructs a post deploy message with a custom markdown file'
     - \`noop\` - Whether or not the deployment is a noop (Boolean)
     - \`ref\` - The ref of the deployment (String)
     - \`actor\` - The GitHub username of the actor who triggered the deployment (String)
+    - \`approved_reviews_count\` - The number of approved reviews on the pull request at the time of deployment (String of a number)
 
     Here is an example:
 
@@ -178,6 +187,8 @@ test('successfully constructs a post deploy message with a custom markdown file'
 
 
 
+    > This deployment had \`4\` approvals.
+
     `)
   )
 })