deploy-notify-slack 0.3.1 → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Mike
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,18 +1,19 @@
 ## Dummy script to send notification about new version deployment to a Slack channel
 
-- no npm dependencies, plain nodejs
+- no npm dependencies, plain nodejs 8.x or higher
 - 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)
@@ -21,21 +22,21 @@
 > 
 > you can also create cross-environment file with name pattern `v${VERSION}.md` and if script cannot find stage specific description it will get this one.
 > 
-> If no decription file found details block will be omitted in Slack message.
+> If no description file found details block will be omitted in Slack message.
 
 - 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
 
 - In Bitbucket pipeline or another place you wish to notify about just deployed version of your application you can add dev dependency
 ```shell
-npm i --no-save deploy-notify-slack@^0.1
+npm i --no-save deploy-notify-slack@^0.3
 ```
 or major version
 ```shell
-npm i --location=global deploy-notify-slack@^0.1
+npm i --location=global deploy-notify-slack@^0.3
 ```
 
 - run the scrypt with your env variables:
@@ -49,7 +50,7 @@ Bitbucket pipeline example:
     name: Notify deploy
     image: node:16-alpine
     script:
-      - npm i --location=global deploy-notify-slack@^0.1
+      - npm i --location=global deploy-notify-slack@^0.3
       - VERSION=$(npm run version --silent)
       - SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} STAGE=dev VERSION=$VERSION node ./node_modules/deploy-notify-slack/notify
 ```
@@ -61,7 +62,7 @@ or install package globally
     name: Notify Slack
     image: node:16-alpine
     script:
-      - npm i --location=global deploy-notify-slack@^0.1
+      - npm i --location=global deploy-notify-slack@^0.3
       - VERSION=$(npm run version --silent)
       - PWD=$(pwd)
       - SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} STAGE=dev VERSION=$VERSION CHANGELOG_PATH=$PWD/changelog node /usr/local/lib/node_modules/deploy-notify-slack/notify.js
@@ -110,7 +111,7 @@ pipelines:
         name: Notify Slack
         image: node:16-alpine
         script:
-          - npm i --location=global deploy-notify-slack@^0.1
+          - npm i --location=global deploy-notify-slack@^0.3
           - VERSION=$(npm run version --silent)
           - SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} STAGE=dev VERSION=$VERSION node /usr/local/lib/node_modules/deploy-notify-slack/notify.js
   
@@ -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.1",
+  "version": "0.4.0",
   "description": "Send Slack notification about deploy with version comments",
   "main": "notify.js",
   "scripts": {