adding approved_reviews_count as a new deployment message variable

Author: GrantBirki

__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.
+
     `)
   )
 })

__tests__/functions/post-deploy.test.js

@@ -89,6 +89,7 @@ test('successfully completes a production branch deployment', async () => {
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success')
@@ -155,6 +156,7 @@ test('successfully completes a production branch deployment that fails', async (
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success')
@@ -221,6 +223,7 @@ test('successfully completes a production branch deployment with an environment
       456,
       'production',
       'https://example.com', // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success')
@@ -293,6 +296,7 @@ test('successfully completes a production branch deployment and removes a non-st
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success')
@@ -365,6 +369,7 @@ test('successfully completes a noop branch deployment and removes a non-sticky l
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success - noop')
@@ -412,6 +417,7 @@ test('successfully completes a noop branch deployment but does not get any lock
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success - noop')
@@ -456,6 +462,7 @@ test('successfully completes a production branch deployment with no custom messa
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success')
@@ -494,6 +501,7 @@ test('successfully completes a noop branch deployment', async () => {
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success - noop')
@@ -514,6 +522,7 @@ test('successfully completes a noop branch deployment and applies success labels
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success - noop')
@@ -534,6 +543,7 @@ test('successfully completes a noop branch deployment that fails and applies suc
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success - noop')
@@ -552,6 +562,7 @@ test('updates with a failure for a production branch deployment', async () => {
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success')
@@ -570,6 +581,7 @@ test('updates with an unknown for a production branch deployment', async () => {
       456,
       'production',
       null, // environment_url
+      1, // approved_reviews_count
       labels
     )
   ).toBe('success')

__tests__/functions/post.test.js

@@ -23,7 +23,8 @@ const validStates = {
   noop: 'false',
   deployment_id: '456',
   environment: 'production',
-  token: 'test-token'
+  token: 'test-token',
+  approved_reviews_count: '1'
 }
 
 const setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation(() => {})

__tests__/functions/prechecks.test.js

@@ -23,6 +23,7 @@ beforeEach(() => {
   jest.spyOn(core, 'debug').mockImplementation(() => {})
   jest.spyOn(core, 'warning').mockImplementation(() => {})
   jest.spyOn(core, 'setOutput').mockImplementation(() => {})
+  jest.spyOn(core, 'saveState').mockImplementation(() => {})
   process.env.INPUT_PERMISSIONS = 'admin,write,maintain'
 
   data = {

__tests__/templates/test_deployment_message.md

@@ -8,6 +8,7 @@ The following variables are available to use in this template:
 - `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:
 
@@ -16,3 +17,5 @@ Here is an example:
 {% if environment_url %}You can view the deployment [here]({{ environment_url }}).{% endif %}
 
 {% if noop %}This was a noop deployment.{% endif %}
+
+> This deployment had `{{ approved_reviews_count }}` approvals.

dist/index.js

@@ -18,6 +18,7 @@ If a markdown file exists at the designated path, it will be used and rendered w
 - `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)
 
 If you wish to see a live example of how this works, and how to use the variables, you can check out this [example](https://github.com/github/branch-deploy/blob/37b50ea86202af7b5505b62bf3eb326da0614b60/__tests__/templates/test_deployment_message.md) which is used in this repo's unit tests and is self-documenting.
 

dist/index.js.map

@@ -11,14 +11,16 @@ import nunjucks from 'nunjucks'
 // :param status: The status of the deployment (String)
 // :param noop: Indicates whether the deployment is a noop or not (Boolean)
 // :param ref: The ref (branch) which is being used for deployment (String)
+// :param approved_reviews_count: The count of approved reviews for the deployment (String representation of an int or null)
 // :returns: The formatted message (String)
 export async function postDeployMessage(
   context,
   environment,
   environment_url,
   status,
   noop,
-  ref
+  ref,
+  approved_reviews_count
 ) {
   // fetch the inputs
   const environment_url_in_comment = core.getBooleanInput(
@@ -38,7 +40,8 @@ export async function postDeployMessage(
         status,
         noop,
         ref,
-        actor: context.actor
+        actor: context.actor,
+        approved_reviews_count
       }
       return nunjucks.render(deployMessagePath, vars)
     }

docs/custom-deployment-messages.md

@@ -23,6 +23,7 @@ const nonStickyMsg = `🧹 ${COLORS.highlight}non-sticky${COLORS.reset} lock det
 // :param deployment_id: The id of the deployment (String)
 // :param environment: The environment of the deployment (String)
 // :param environment_url: The environment url of the deployment (String)
+// :param approved_reviews_count: The count of approved reviews for the deployment (String representation of an int or null)
 // :param labels: A dictionary of labels to apply to the issue (Object)
 // :returns: 'success' if the deployment was successful, 'success - noop' if a noop, throw error otherwise
 export async function postDeploy(
@@ -36,6 +37,7 @@ export async function postDeploy(
   deployment_id,
   environment,
   environment_url,
+  approved_reviews_count,
   labels
 ) {
   // check the inputs to ensure they are valid
@@ -70,7 +72,8 @@ export async function postDeploy(
     environment_url,
     status,
     noop,
-    ref
+    ref,
+    approved_reviews_count
   )
 
   // update the action status to indicate the result of the deployment as a comment