deploy-notify-slack 0.1.9

package/README.md

@@ -0,0 +1,116 @@
+## Dummy script to send notification about new version deployment to a Slack channel
+
+- no npm dependencies, plain nodejs
+- use Slack incoming webhooks API to send a message
+- can attach version description Markdown files
+
+### 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
+- TITLE - notification title
+- CHANGELOG_PATH - path of your deployed version details file `changelog` by default.
+
+> version details file is a Markdown file having the name like `${STAGE}-v${VERSION}.md`. 
+> If such file isn't found details block will be omitted in Slack message.
+
+### 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 git@bitbucket.org:omvmike/deploy-notify-slack.git#semver:latest
+```
+or major version
+```shell
+ npm i --no-save git@bitbucket.org:omvmike/deploy-notify-slack.git#semver:^0.1
+```
+
+- run the scrypt with your env variables:
+```shell
+SLACK_WEBHOOK_URL=https://hooks.slack.com/services/XXXXXXXXXXX STAGE=dev VERSION=1.0.0 node ./node_modules/deploy-notify-slack/notify
+```
+
+Bitbucket pipeline example:
+```yaml
+- step:
+    name: Notify deploy
+    image: node:16-alpine
+    script:
+      - apk add --no-cache bash git openssh
+      - npm i --no-save git@bitbucket.org:omvmike/deploy-notify-slack.git#semver:^0.1
+      - VERSION=$(npm run version --silent)
+      - SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} STAGE=dev VERSION=$VERSION node ./node_modules/deploy-notify-slack/notify
+```
+or install package globally
+
+```yaml
+- step:
+    name: Notify Slack
+    image: node:16-alpine
+    script:
+      - apk add --no-cache bash git openssh
+      - npm i --location=global git@bitbucket.org:omvmike/deploy-notify-slack.git#semver:^0.1
+      - 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
+```
+
+Full bitbucket CI/CD pipeline example for deploy NestJs application and send deploy message:
+```yaml
+image: atlassian/default-image:2
+clone:
+  depth: full
+pipelines:
+  default:
+    - step:
+        name: Test and Build
+        image: node:16-alpine
+        caches:
+          - node
+        script:
+          - npm ci
+          - npm run test:ci
+          - npm run build
+        services:
+          - database
+        artifacts:
+          - node_modules/**
+          - dist/**
+    - step:
+        name: Pack and deploy to bundle
+        script:
+          - VERSION=$(npm run version --silent)
+          - cp .env.static .env
+          - zip -r application.zip . -x "src/*" -x "docker/*" -x "test/*" -x "cloudformation/*"
+          - pipe: atlassian/aws-elasticbeanstalk-deploy:1.0.2
+            variables:
+              AWS_ACCESS_KEY_ID: $AWS_DEV_ACCESS_KEY_ID
+              AWS_SECRET_ACCESS_KEY: $AWS_DEV_SECRET_ACCESS_KEY
+              AWS_DEFAULT_REGION: $AWS_DEFAULT_REGION
+              S3_BUCKET: $AWS_DEV_DEPLOY_BUCKET
+              VERSION_LABEL: "DEV-${VERSION}-${BITBUCKET_BUILD_NUMBER}-${BITBUCKET_COMMIT:0:8}"
+              APPLICATION_NAME: $AWS_DEV_APP_NAME
+              ENVIRONMENT_NAME: $AWS_DEV_EB_ENV_NAME
+              ZIP_FILE: "application.zip"
+    - step:
+        name: Notify Slack
+        image: node:16-alpine
+        script:
+          - apk add --no-cache bash git openssh
+          - npm i --location=global git@bitbucket.org:omvmike/deploy-notify-slack.git#semver:^0.1
+          - 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
+  
+definitions:
+  services:
+    database:
+      image: postgres
+      user: postgres
+      variables:
+        POSTGRES_DB: test
+        POSTGRES_USER: api
+        POSTGRES_PASSWORD: example 
+```

package/notify.js

@@ -0,0 +1,151 @@
+const https = require('https');
+const fs = require('fs');
+const path = require('path')
+
+const slackWebHookURL = process.env.SLACK_WEBHOOK_URL;
+const stage = process.env.STAGE;
+const version = process.env.VERSION;
+const title = process.env.TITLE || 'Deployment';
+const changelogPath = process.env.CHANGELOG_PATH || path.join(__dirname, '../../changelog');
+
+function getChangelog() {
+  try {
+    return fs.readFileSync(path.join(changelogPath, `${stage}-v${version}.md`), 'utf8')
+  } catch (e) {
+    return '';
+  }
+}
+
+function notificationBody() {
+  let blocks = [
+    {
+      "type": "section",
+      "text": {
+          "type": "mrkdwn",
+          "text": `:rocket: *${title}*`
+        }
+    },
+    {
+      "type": "section",
+      "fields": [
+        {
+          "type": "mrkdwn",
+          "text": `*stage*\n ${stage}`
+        },
+        {
+          "type": "mrkdwn",
+          "text": `*version*\n ${version}`
+        }
+      ]
+    }
+  ];
+
+  const changelog = getChangelog();
+  if (changelog) {
+    blocks.push(
+      {
+        "type": "divider"
+      }
+    );
+    blocks.push({
+      "type": "section",
+      "text": {
+        "type": "mrkdwn",
+        "text": "*Description:* \n\n" + changelog
+      }
+    })
+  }
+  return {
+    "attachments": [
+      {
+        "blocks": blocks
+      }
+    ]
+  };
+}
+
+/**
+ * Handles the actual sending request.
+ * We're turning the https.request into a promise here for convenience
+ * @param webhookURL
+ * @param messageBody
+ * @return {Promise}
+ */
+function sendSlackMessage (webhookURL, messageBody) {
+  // make sure the incoming message body can be parsed into valid JSON
+  try {
+    messageBody = JSON.stringify(messageBody);
+  } catch (e) {
+    throw new Error('Failed to stringify messageBody', e);
+  }
+
+  // Promisify the https.request
+  return new Promise((resolve, reject) => {
+    // general request options, we defined that it's a POST request and content is JSON
+    const requestOptions = {
+      method: 'POST',
+      header: {
+        'Content-Type': 'application/json'
+      }
+    };
+
+    // actual request
+    const req = https.request(webhookURL, requestOptions, (res) => {
+      let response = '';
+
+
+      res.on('data', (d) => {
+        response += d;
+      });
+
+      // response finished, resolve the promise with data
+      res.on('end', () => {
+        resolve(response);
+      })
+    });
+
+    // there was an error, reject the promise
+    req.on('error', (e) => {
+      reject(e);
+    });
+
+    // send our message body (was parsed to JSON beforehand)
+    req.write(messageBody);
+    req.end();
+  });
+}
+
+function validate() {
+  let success = true;
+  if (!slackWebHookURL) {
+    console.error('Please fill in slack Webhook URL as SLACK_WEBHOOK_URL env');
+    success = false;
+  }
+
+  if (!stage) {
+    console.error('Please fill in deployed stage as STAGE env');
+    success = false;
+  }
+
+  if (!version) {
+    console.error('Please fill in deployed version as VERSION env');
+    success = false;
+  }
+
+  return success;
+}
+
+// main
+(async function () {
+  if (!validate()) {
+    process.exit(1);
+  }
+
+  console.log('Sending slack message');
+  try {
+    const slackResponse = await sendSlackMessage(slackWebHookURL, notificationBody());
+    console.log('Message response', slackResponse);
+  } catch (e) {
+    console.error('There was a error with the request', e);
+  }
+})();

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "deploy-notify-slack",
+  "version": "0.1.9",
+  "description": "Send Slack notification about deploy with version comments",
+  "main": "notify.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "version": "echo $npm_package_version",
+    "notify": "node notify.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@bitbucket.org/omvmike/deploy-notify-slack.git"
+  },
+  "author": "mike.onofrienko@clockwise.software",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://bitbucket.org/omvmike/deploy-notify-slack/issues"
+  },
+  "homepage": "https://bitbucket.org/omvmike/deploy-notify-slack#readme"
+}

package/tag-deploy.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+VERSION=$(npm run version --silent)
+git tag -a $VERSION -m "new version"
+git push origin $VERSION