deploy-notify-slack 0.5.10 → 0.6.1

package/README.md

@@ -1,82 +1,124 @@
-## Dummy script to send notification about new version deployment to a Slack channel
+# deploy-notify-slack
 
 <a href="https://www.npmjs.com/package/deploy-notify-slack" target="_blank"><img src="https://img.shields.io/npm/v/deploy-notify-slack" alt="NPM Version" /></a>
 <a href="https://www.npmjs.com/package/deploy-notify-slack" target="_blank"><img src="https://img.shields.io/npm/l/deploy-notify-slack" alt="Package License" /></a>
 
-- no npm dependencies, plain nodejs 8.x or higher
-- use Slack incoming webhooks API to send a message
-- can attach version description Markdown files
+Send Slack notifications about deployments via incoming webhooks.
 
-### Use default message template
-You can use default message template with the following env variables:
+## Features
 
-#### Required env variables
+- Zero dependencies - uses native Node.js `fetch()` API
+- Automatic changelog attachment from Markdown files
+- Customizable colors, emojis, and titles
+- Full custom message support via Slack Block Kit
+- Simple environment variable configuration
 
-- 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
+## Requirements
 
-#### Optional env variables
+- **Node.js 21+** (uses native `fetch()` API)
 
-- 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)
-- COLOR - ('#7f8583' by default) left bar notification color. Should be hex color code without `#` symbol
-- EMOJI - (':rocket:' by default) emoji to be displayed in the notification title
-- MAX_BLOCKS - (5 by default) maximum amount of large blocks(2500 symbols) available in slack message. If your changelog is bigger than this value it will be truncated.
+> Need Node.js 8.x-20.x support? Use [v0.5.10](https://www.npmjs.com/package/deploy-notify-slack/v/0.5.10)
 
-> version details file is a Markdown file having the name like `${STAGE}-v${VERSION}.md`. 
-> 
-> 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 description file found details block will be omitted in Slack message.
+## Quick Start
 
-- FAILS_IF_NOT_SENT - (false by default)  Should exit with not 0 error code if message was not sent successfully.
+1. Generate a [Slack Webhook URL](https://api.slack.com/messaging/webhooks)
 
-#### How it works
+2. Run with npx (no installation required):
+   ```bash
+   SLACK_WEBHOOK_URL=https://hooks.slack.com/services/XXX \
+   STAGE=production \
+   VERSION=1.0.0 \
+   npx deploy-notify-slack
+   ```
 
-- Generate Slack webhook URL https://api.slack.com/messaging/webhooks
+   Or install and run with node:
+   ```bash
+   npm install deploy-notify-slack
+   SLACK_WEBHOOK_URL=https://hooks.slack.com/services/XXX \
+   STAGE=production \
+   VERSION=1.0.0 \
+   node ./node_modules/deploy-notify-slack/notify.js
+   ```
 
-- 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.5
+## Installation
+
+**npx (no install required):**
+```bash
+npx deploy-notify-slack
 ```
-or major version
-```shell
-npm i --location=global deploy-notify-slack@^0.5
+
+**Local install (recommended for CI/CD):**
+```bash
+npm install --save-dev deploy-notify-slack
+npx deploy-notify-slack
 ```
 
-- 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
+**Global install:**
+```bash
+npm install --location=global deploy-notify-slack
+deploy-notify-slack
 ```
 
-Bitbucket pipeline example:
+## Configuration
+
+### Required Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `SLACK_WEBHOOK_URL` | Webhook URL for your Slack channel ([how to generate](https://api.slack.com/messaging/webhooks)) |
+| `STAGE` | Deployment stage (e.g., `dev`, `staging`, `prod`) |
+| `VERSION` | Version being deployed |
+
+### Optional Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `TITLE` | `Deployment` | Notification title |
+| `COLOR` | `7f8583` | Left bar color (hex without `#`) |
+| `EMOJI` | `:rocket:` | Title emoji |
+| `MAX_BLOCKS` | `5` | Max 2500-char blocks before truncation |
+| `CHANGELOG_PATH` | `./changelog` | Path to changelog directory |
+| `FAILS_IF_NOT_SENT` | `false` | Exit with error if send fails |
+| `CUSTOM_MESSAGE` | - | JSON for custom Slack Block Kit message |
+
+### Changelog File Resolution
+
+The script looks for changelog files in the following order:
+
+1. `{CHANGELOG_PATH}/{STAGE}-v{VERSION}.md` (stage-specific, e.g., `prod-v1.0.0.md`)
+2. `{CHANGELOG_PATH}/v{VERSION}.md` (version-specific, e.g., `v1.0.0.md`)
+3. `{CHANGELOG_PATH}/changelog.md` (fallback)
+
+If no changelog file is found, the notification is sent without a changelog attachment.
+
+## CI/CD Integration
+
+### Bitbucket Pipelines
+
+**Using npx (recommended):**
 ```yaml
 - step:
-    name: Notify deploy
-    image: node:16-alpine
+    name: Notify Slack
+    image: node:24-alpine
     script:
-      - npm i --location=global deploy-notify-slack
       - VERSION=$(npm run version --silent)
-      - SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} STAGE=dev VERSION=$VERSION node ./node_modules/deploy-notify-slack/notify
+      - SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} STAGE=dev VERSION=$VERSION CHANGELOG_PATH=$PWD/changelog npx deploy-notify-slack@^0.6
 ```
 
-or install package globally
+> The `version` script above is `echo $npm_package_version` in package.json
 
+**Local install (caches better in CI):**
 ```yaml
 - step:
     name: Notify Slack
-    image: node:16-alpine
+    image: node:24-alpine
     script:
-      - npm i --location=global deploy-notify-slack
+      - npm install --no-save deploy-notify-slack@^0.6
       - 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
+      - SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} STAGE=dev VERSION=$VERSION CHANGELOG_PATH=$PWD/changelog npx deploy-notify-slack
 ```
-> 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:
+**Full pipeline example (NestJS + AWS Elastic Beanstalk):**
 ```yaml
 image: atlassian/default-image:2
 clone:
@@ -85,7 +127,7 @@ pipelines:
   default:
     - step:
         name: Test and Build
-        image: node:16-alpine
+        image: node:24-alpine
         caches:
           - node
         script:
@@ -115,12 +157,11 @@ pipelines:
               ZIP_FILE: "application.zip"
     - step:
         name: Notify Slack
-        image: node:16-alpine
+        image: node:24-alpine
         script:
-          - npm i --location=global deploy-notify-slack
           - 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
-  
+          - SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} STAGE=dev VERSION=$VERSION CHANGELOG_PATH=$PWD/changelog npx deploy-notify-slack@^0.6
+
 definitions:
   services:
     database:
@@ -129,19 +170,16 @@ definitions:
       variables:
         POSTGRES_DB: test
         POSTGRES_USER: api
-        POSTGRES_PASSWORD: example 
+        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.
+## Custom Messages
 
-Try to use [Slack message builder](https://api.slack.com/tools/block-kit-builder) to create your own message template.
+You can specify your own message template instead of the default one using the `CUSTOM_MESSAGE` environment variable.
 
-Then you should load your template from file and pass it to the script as env variable `CUSTOM_MESSAGE`:
+Use the [Slack Block Kit Builder](https://api.slack.com/tools/block-kit-builder) to design your message, then pass it as JSON:
 
-For example you saved your message template to `message.json` file:
+**Example message.json:**
 ```json
 {
   "blocks": [
@@ -157,9 +195,12 @@ For example you saved your message template to `message.json` file:
 }
 ```
 
-Then you can run the script with the following command:
-```shell
-npm i --location=global deploy-notify-slack@latest
+**Usage:**
+```bash
 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
+SLACK_WEBHOOK_URL=${SLACK_WEBHOOK_URL} CUSTOM_MESSAGE=$CUSTOM_MESSAGE npx deploy-notify-slack
 ```
+
+## License
+
+MIT

package/notify.js

@@ -1,4 +1,4 @@
-const https = require('https');
+#!/usr/bin/env node
 const fs = require('fs');
 const path = require('path');
 
@@ -37,9 +37,14 @@ function getChangelog() {
 
 function notificationBody() {
   if (customMessage) {
-    return {
-      'attachments': [JSON.parse(customMessage)],
-    };
+    try {
+      return {
+        'attachments': [JSON.parse(customMessage)],
+      };
+    } catch (e) {
+      console.error('Failed to parse CUSTOM_MESSAGE as JSON:', e.message);
+      process.exit(3);
+    }
   }
   let blocks = [
     {
@@ -102,53 +107,25 @@ function notificationBody() {
 }
 
 /**
- * Handles the actual sending request.
- * We're turning the https.request into a promise here for convenience
+ * Handles the actual sending request using fetch API.
  * @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);
-      });
-    });
+async function sendSlackMessage(webhookURL, messageBody) {
+  const response = await fetch(webhookURL, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify(messageBody),
+  });
 
-    // there was an error, reject the promise
-    req.on('error', (e) => {
-      reject(e);
-    });
+  if (!response.ok) {
+    throw new Error(`HTTP ${response.status}: ${await response.text()}`);
+  }
 
-    // send our message body (was parsed to JSON beforehand)
-    req.write(messageBody);
-    req.end();
-  });
+  return response.text();
 }
 
 function splitTextToBlocks(text) {
@@ -205,15 +182,17 @@ 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;
   }
 
+  if (customMessage) {
+    console.log('Custom message', customMessage);
+    return success;
+  }
+
   if (!stage) {
     console.error('Please fill in deployed stage as STAGE env');
     success = false;

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "deploy-notify-slack",
-  "version": "0.5.10",
+  "version": "0.6.1",
   "private": false,
   "description": "Send Slack notification about deploy with version comments",
   "main": "notify.js",
+  "bin": {
+    "deploy-notify-slack": "./notify.js"
+  },
+  "engines": {
+    "node": ">=21"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "version": "echo $npm_package_version",