deploy-notify-slack 0.3.2 → 0.4.0

package/README.md

@@ -4,15 +4,16 @@
 - use Slack incoming webhooks API to send a message
 - can attach version description Markdown files
 
-### ENV Variables
+### Use default message template
+You can use default message template with the following env variables:
 
-#### Required
+#### Required env variables
 
 - SLACK_WEBHOOK_URL - you should generate webhook url for your target channel, see: https://api.slack.com/messaging/webhooks
 - STAGE - name of an application stage you're deploying, usually: dev, staging, prod..
 - VERSION - deployed version
 
-#### Optional
+#### Optional env variables
 
 - TITLE - ('Deployment' by default) notification title
 - CHANGELOG_PATH - path of your deployed version details file (`changelog` by default as well as we assume that the package installed locally, so this option is required if the package installed globally)
@@ -25,7 +26,7 @@
 
 - FAILS_IF_NOT_SENT - (false by default)  Should exit with not 0 error code if message was not sent successfully.
 
-### How it works
+#### How it works
 
 - Generate Slack webhook URL https://api.slack.com/messaging/webhooks
 
@@ -124,3 +125,35 @@ definitions:
         POSTGRES_USER: api
         POSTGRES_PASSWORD: example 
 ```
+
+### Use custom message template
+
+You can specify your own message template instead of default one.
+It's useful if you want to add some additional information to the message.
+
+Try to use [Slack message builder](https://api.slack.com/tools/block-kit-builder) to create your own message template.
+
+Then you should load your template from file and pass it to the script as env variable `CUSTOM_MESSAGE`:
+
+For example you saved your message template to `message.json` file:
+```json
+{
+  "blocks": [
+    {
+      "type": "header",
+      "text": {
+        "type": "plain_text",
+        "text": ":flying_saucer: New API deploy of stage *DEV*",
+        "emoji": true
+      }
+    }
+  ]
+}
+```
+
+Then you can run the script with the following command:
+```shell
+npm i --location=global deploy-notify-slack@latest
+CUSTOM_MESSAGE=$(cat message.json)
+SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} CUSTOM_MESSAGE=$CUSTOM_MESSAGE node /usr/local/lib/node_modules/deploy-notify-slack/notify.js
+```

package/notify.js

@@ -6,6 +6,7 @@ const slackWebHookURL = process.env.SLACK_WEBHOOK_URL;
 const stage = process.env.STAGE;
 const version = process.env.VERSION;
 const title = process.env.TITLE || 'Deployment';
+const customMessage = process.env.CUSTOM_MESSAGE;
 const changelogPath = process.env.CHANGELOG_PATH || path.join(__dirname, '../../changelog');
 const failsIfNotSent = process.env.FAILS_IF_NOT_SENT !== undefined
   ? stringToBool(process.env.FAILS_IF_NOT_SENT, false)
@@ -26,6 +27,11 @@ function getChangelog() {
 }
 
 function notificationBody() {
+  if (customMessage) {
+    return {
+      "attachments": [ JSON.parse(customMessage) ]
+    }
+  }
   let blocks = [
     {
       "type": "section",
@@ -144,6 +150,10 @@ function stringToBool(str, defaultValue = false){
 
 function validate() {
   let success = true;
+  if (customMessage) {
+    console.log('Custom message', customMessage);
+    return true;
+  }
   if (!slackWebHookURL) {
     console.error('Please fill in slack Webhook URL as SLACK_WEBHOOK_URL env');
     success = false;
@@ -167,7 +177,6 @@ function validate() {
   if (!validate()) {
     process.exit(3);
   }
-
   console.log('Sending slack message');
   try {
     const slackResponse = await sendSlackMessage(slackWebHookURL, notificationBody());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deploy-notify-slack",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Send Slack notification about deploy with version comments",
   "main": "notify.js",
   "scripts": {