feat(message): add custom message to action

README.md

@@ -115,6 +115,10 @@ The ID of a previous Slack message to update instead of posting a new message. T
 message_id: ${{ steps.<your_first_slack_step_id>.outputs.message_id }}
 ```
 
+### `message`
+
+A custom message.
+
 ## Outputs
 
 ### `message_id`

__tests__/utils.spec.js

@@ -59,6 +59,21 @@ describe('Utils', () => {
           short: true,
         });
       });
+
+      it('show message', () => {
+        const attachments = buildSlackAttachments({
+          status: 'STARTED',
+          color: 'good',
+          github: GITHUB_PUSH_EVENT,
+          message: 'message',
+        });
+
+        expect(attachments[0].fields.find(a => a.title === 'Message')).toEqual({
+          title: 'Message',
+          value: 'message',
+          short: false,
+        });
+      });
     });
 
     describe('for PR events', () => {
@@ -91,6 +106,21 @@ describe('Utils', () => {
           short: true,
         });
       });
+
+      it('show message', () => {
+        const attachments = buildSlackAttachments({
+          status: 'STARTED',
+          color: 'good',
+          github: GITHUB_PR_EVENT,
+          message: 'message',
+        });
+
+        expect(attachments[0].fields.find(a => a.title === 'Message')).toEqual({
+          title: 'Message',
+          value: 'message',
+          short: false,
+        });
+      });
     });
   });
 });

action.yml

@@ -17,6 +17,9 @@ inputs:
     description: 'The color of the Slack attachment.'
     required: true
     default: '#cccccc'
+  message:
+    description: 'A custom message to show.'
+    required: false
   message_id:
     description: 'The ID of the existing Slack message to update.'
     required: false

index.js

@@ -8,6 +8,7 @@ const { buildSlackAttachments, formatChannelName } = require('./src/utils');
     const channel = core.getInput('channel');
     const status = core.getInput('status');
     const color = core.getInput('color');
+    const message = core.getInput('message');
     const messageId = core.getInput('message_id');
     const token = process.env.SLACK_BOT_TOKEN;
     const slack = new WebClient(token);
@@ -17,7 +18,7 @@ const { buildSlackAttachments, formatChannelName } = require('./src/utils');
       return;
     }
 
-    const attachments = buildSlackAttachments({ status, color, github });
+    const attachments = buildSlackAttachments({ status, color, github, message });
     const channelId = core.getInput('channel_id') || (await lookUpChannelId({ slack, channel }));
 
     if (!channelId) {

src/utils.js

@@ -1,6 +1,6 @@
 const { context } = require('@actions/github');
 
-function buildSlackAttachments({ status, color, github }) {
+function buildSlackAttachments({ status, color, github, message }) {
   const { payload, ref, workflow, eventName } = github.context;
   const { owner, repo } = context.repo;
   const event = eventName;
@@ -21,32 +21,39 @@ function buildSlackAttachments({ status, color, github }) {
           short: true,
         };
 
-  return [
-    {
-      color,
-      fields: [
-        {
-          title: 'Action',
-          value: `<https://github.com/${owner}/${repo}/commit/${sha}/checks | ${workflow}>`,
-          short: true,
-        },
-        {
-          title: 'Status',
-          value: status,
-          short: true,
-        },
-        referenceLink,
-        {
-          title: 'Event',
-          value: event,
-          short: true,
-        },
-      ],
-      footer_icon: 'https://github.githubassets.com/favicon.ico',
-      footer: `<https://github.com/${owner}/${repo} | ${owner}/${repo}>`,
-      ts: Math.floor(Date.now() / 1000),
-    },
-  ];
+  var attachment = {
+    color,
+    fields: [
+      {
+        title: 'Action',
+        value: `<https://github.com/${owner}/${repo}/commit/${sha}/checks | ${workflow}>`,
+        short: true,
+      },
+      {
+        title: 'Status',
+        value: status,
+        short: true,
+      },
+      referenceLink,
+      {
+        title: 'Event',
+        value: event,
+        short: true,
+      },
+    ],
+    footer_icon: 'https://github.githubassets.com/favicon.ico',
+    footer: `<https://github.com/${owner}/${repo} | ${owner}/${repo}>`,
+    ts: Math.floor(Date.now() / 1000),
+  };
+
+  if (message)
+    attachment['fields'].push({
+      title: 'Message',
+      value: message,
+      short: false,
+    });
+
+  return [attachment];
 }
 
 module.exports.buildSlackAttachments = buildSlackAttachments;