Merge remote-tracking branch 'origin/master' into v3

Author: 8398a7

.github/workflows/star.yml

@@ -142,6 +142,61 @@ describe('8398a7/action-slack', () => {
     });
   });
 
+  // ensure if messages are specified, they're used
+  describe('message is specified', () => {
+    it('with success', async () => {
+      const success_message = 'Woo hoo!';
+      const withParams = {
+        ...newWith(),
+        success_message,
+        status: Success,
+      };
+      const client = new Client(
+        withParams,
+        gitHubToken,
+        gitHubBaseUrl,
+        webhookUrl,
+      );
+      const payload = getTemplate(withParams.fields, success_message);
+      payload.attachments[0].color = 'good';
+      expect(await client.prepare('')).toStrictEqual(payload);
+    });
+    it('with failure', async () => {
+      const failure_message = "D'oh!";
+      const withParams = {
+        ...newWith(),
+        failure_message,
+        status: Failure,
+      };
+      const client = new Client(
+        withParams,
+        gitHubToken,
+        gitHubBaseUrl,
+        webhookUrl,
+      );
+      const payload = getTemplate(withParams.fields, failure_message);
+      payload.attachments[0].color = 'danger';
+      expect(await client.prepare('')).toStrictEqual(payload);
+    });
+    it('with cancel', async () => {
+      const cancelled_message = 'Why, you little!';
+      const withParams = {
+        ...newWith(),
+        cancelled_message,
+        status: Cancelled,
+      };
+      const client = new Client(
+        withParams,
+        gitHubToken,
+        gitHubBaseUrl,
+        webhookUrl,
+      );
+      const payload = getTemplate(withParams.fields, cancelled_message);
+      payload.attachments[0].color = 'warning';
+      expect(await client.prepare('')).toStrictEqual(payload);
+    });
+  });
+
   it('has no mention', async () => {
     const withParams = {
       ...newWith(),

__tests__/client.test.ts

@@ -51,7 +51,7 @@ export const setupNockJobs = (runId: string, fixture: string) =>
     });
 
 export const successMsg = ':white_check_mark: Succeeded GitHub Actions\n';
-export const cancelMsg = ':warning: Canceled GitHub Actions\n';
+export const cancelMsg = ':warning: Cancelled GitHub Actions\n';
 export const failMsg = ':no_entry: Failed GitHub Actions\n';
 export const getApiFixture = (name: string): any =>
   JSON.parse(
@@ -70,6 +70,9 @@ export const newWith = (): With => {
     channel: '',
     fields: '',
     job_name: '',
+    success_message: successMsg,
+    cancelled_message: cancelMsg,
+    failure_message: failMsg,
   };
 };
 

__tests__/helper.ts

@@ -58,6 +58,18 @@ inputs:
     description: Use this if you want to overwrite the job name.
     default: ""
     required: false
+  success_message:
+    description: Message to use when the status is 'success'.
+    default: ":white_check_mark: Succeeded GitHub Actions\n"
+    required: false
+  cancelled_message:
+    description: Message to use when the status is 'cancelled'.
+    default: ":warning: Cancelled GitHub Actions\n"
+    required: false
+  failure_message:
+    description: Message to use when the status is 'failure'.
+    default: ":no_entry: Failed GitHub Actions\n"
+    required: false
   github_token:
     description: Use this if you wish to use a different GitHub token than the one provided by the workflow.
     required: false