deploy-notify-slack 0.2.0 → 0.3.1

package/README.md

@@ -6,14 +6,24 @@
 
 ### ENV Variables
 
+#### Required
+
 - 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.
+
+#### Optional
+
+- 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)
 
 > 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.
+> 
+> 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.
+
+- FAILS_IF_NOT_SENT - (false by default)  Should exit with not 0 error code if message was not sent successfully.
 
 ### How it works
 
@@ -21,11 +31,11 @@
 
 - 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
+npm i --no-save deploy-notify-slack@^0.1
 ```
 or major version
 ```shell
- npm i --no-save git@bitbucket.org:omvmike/deploy-notify-slack.git#semver:^0.1
+npm i --location=global deploy-notify-slack@^0.1
 ```
 
 - run the scrypt with your env variables:
@@ -39,11 +49,11 @@ Bitbucket pipeline example:
     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
+      - npm i --location=global deploy-notify-slack@^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
@@ -51,12 +61,13 @@ or install package globally
     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
+      - npm i --location=global deploy-notify-slack@^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
 ```
+> version script above is just a `echo $npm_package_version` command
+
 
 Full bitbucket CI/CD pipeline example for deploy NestJs application and send deploy message:
 ```yaml
@@ -99,8 +110,7 @@ pipelines:
         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
+          - npm i --location=global deploy-notify-slack@^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
   

package/notify.js

@@ -7,13 +7,22 @@ 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');
+const failsIfNotSent = process.env.FAILS_IF_NOT_SENT !== undefined
+  ? stringToBool(process.env.FAILS_IF_NOT_SENT, false)
+  : false;
 
 function getChangelog() {
   try {
     return fs.readFileSync(path.join(changelogPath, `${stage}-v${version}.md`), 'utf8')
   } catch (e) {
-    return '';
+    console.log(`Description "${stage}-v${version}.md" not found in "${changelogPath}"`)
   }
+  try {
+    return fs.readFileSync(path.join(changelogPath, `v${version}.md`), 'utf8')
+  } catch (e) {
+    console.log(`Description "v${version}.md" not found in "${changelogPath}"`)
+  }
+  return '';
 }
 
 function notificationBody() {
@@ -115,6 +124,24 @@ function sendSlackMessage (webhookURL, messageBody) {
   });
 }
 
+function stringToBool(str, defaultValue = false){
+  switch(str.toLowerCase().trim()){
+    case "true":
+    case "yes":
+    case "1":
+      return true;
+
+    case "false":
+    case "no":
+    case "0":
+    case null:
+      return false;
+
+    default:
+      return defaultValue
+  }
+}
+
 function validate() {
   let success = true;
   if (!slackWebHookURL) {
@@ -138,14 +165,23 @@ function validate() {
 // main
 (async function () {
   if (!validate()) {
-    process.exit(1);
+    process.exit(3);
   }
 
   console.log('Sending slack message');
   try {
     const slackResponse = await sendSlackMessage(slackWebHookURL, notificationBody());
     console.log('Message response', slackResponse);
+    if (slackResponse !== 'ok') {
+      console.error('There was an error with the request. Check SLACK_WEBHOOK_URL.');
+      if (failsIfNotSent) {
+        process.exit(4);
+      }
+    }
   } catch (e) {
-    console.error('There was a error with the request', e);
+    console.error('There was an error with the request', e);
+    if (failsIfNotSent) {
+      process.exit(5);
+    }
   }
 })();

package/package.json

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

package/bitbucket-pipelines.yml

@@ -1,18 +0,0 @@
-image: node:16-alpine
-
-pipelines:
-  default:
-#    - step:
-#        name: Build and Test
-#        script:
-#          - npm install
-#          - npm test
-    - step:
-        name: Publish
-        deployment: production
-        script:
-          - npm version minor -m "Upgrade to %s [skip ci]"
-          - git push && git push --tags
-          - pipe: atlassian/npm-publish:0.2.0
-            variables:
-              NPM_TOKEN: $NPM_TOKEN

package/tag-deploy.sh

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