n8n-nodes-version 0.2.0 → 0.2.2

package/README.md

@@ -1,30 +1,47 @@
-# n8n-version-node
+# n8n-nodes-version
 
-> [!NOTE] 
-> [n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
->
-> [Icon](https://icons8.com/icon/9sDRgODM0vNc/refresh) is from [icons8.com](https://icons8.com/)
+[![NPM Version](https://img.shields.io/npm/v/n8n-nodes-version.svg)](https://www.npmjs.com/package/n8n-nodes-version)
+[![NPM Downloads](https://img.shields.io/npm/dm/n8n-nodes-version.svg)](https://www.npmjs.com/package/n8n-nodes-version)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+n8n nodes to check the current installed version, monitor for updates, and fetch changelogs directly from GitHub.
+
+**Note:** [n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
+[Icon](https://icons8.com/icon/9sDRgODM0vNc/refresh) provided by [icons8.com](https://icons8.com/)
+
+---
 
 ## Features
 
-- Check current installed n8n version
-- Fetch latest version from [npm](https://www.npmjs.com/package/n8n)
-- Compare versions and determine if current is latest
-- Fetch release notes from GitHub
-- Trigger workflows based on version status
+- **Check Current Version**: Retrieve the installed version of your n8n instance.
+- **Update Monitoring**: Compare your version with the latest release on [npm](https://www.npmjs.com/package/n8n).
+- **Changelog Retrieval**: Fetch detailed release notes directly from the official GitHub repository.
+- **Automation Triggers**: Start workflows automatically when updates are available.
 
-## Nodes
+## Installation
 
-### Version Checker
+### via n8n UI (Recommended)
 
-Checks the current n8n version and provides various options:
+1. Go to **Settings > Community Nodes**.
+2. Click **Install a community node**.
+3. Enter `n8n-nodes-version` in the text field.
+4. Agree to the risks and click **Install**.
 
-**Options:**
+### via npm (CLI)
 
-- **Return Latest Version Info** (default: `true`): Fetches latest version from npm and compares with current
-- **Fetch Changelog** (default: `false`): Retrieves release notes from GitHub
-  - **Changelog Version**: Choose between current or latest version
-  - **Strip Links from Changelog**: Remove markdown links from changelog text
+For Docker-based or manual installations, run the following command in your n8n root directory:
+
+```bash
+npm install n8n-nodes-version
+```
+
+---
+
+## Nodes
+
+### Version Checker
+
+Retrieves version information and optionally fetches changelogs.
 
 **Output Example:**
 
@@ -40,41 +57,15 @@ Checks the current n8n version and provides various options:
 
 ### Version Trigger
 
-Triggers workflows based on n8n version status using cron scheduling.
-
-**Properties:**
-
-- **Cron Expression**: Schedule for version checks (e.g., `0 * * * *` for hourly)
-- **Trigger Condition**:
-  - **Update Available**: Trigger when new version exists
-  - **On Latest Version**: Trigger when already up-to-date
-  - **Always**: Trigger on every check
-
-**Use Cases:**
-
-- Automated update notifications
-- Monitoring version status
-- Scheduled version audits
-
-## Installation
-
-```bash
-npm install n8n-nodes-version
-```
+A schedule-based trigger that fires workflows based on version status.
 
-## Development
+**Configuration:**
 
-```bash
-# Watch mode
-npm run dev
-
-# Build
-npm run build
+- **Cron Expression**: Define how often to check (e.g., `0 * * * *`).
+- **Trigger Condition**: Choose between `Update Available`, `On Latest Version`, or `Always`.
 
-# Lint
-npm run lint
-```
+---
 
-## License
+## 📄 License
 
-MIT
+[MIT](https://opensource.org/licenses/MIT)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-version",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "n8n nodes to check version, monitor updates, and fetch changelogs",
   "keywords": [
     "n8n-community-node-package"
@@ -11,6 +11,10 @@
     "name": "Community",
     "email": "example@example.com"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jamesmoorwalter/n8n-version-node.git"
+  },
   "scripts": {
     "build": "tsc && gulp build:icons",
     "dev": "tsc --watch",

package/dist/nodes/N8nChangelog/N8nChangelog.node.js

@@ -1,178 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.N8nChangelog = void 0;
-const https_1 = __importDefault(require("https"));
-/**
- * Fetch changelog from GitHub releases
- */
-function getChangelog(version) {
-    return new Promise((resolve) => {
-        try {
-            const options = {
-                hostname: 'api.github.com',
-                path: `/repos/n8n-io/n8n/releases/tags/n8n@${version}`,
-                headers: {
-                    'User-Agent': 'n8n-changelog-node',
-                },
-            };
-            https_1.default
-                .get(options, (res) => {
-                let data = '';
-                res.on('data', (chunk) => (data += chunk));
-                res.on('end', () => {
-                    try {
-                        if (res.statusCode === 404) {
-                            resolve({ body: '', error: `Release n8n@${version} not found` });
-                            return;
-                        }
-                        if (res.statusCode !== 200) {
-                            resolve({ body: '', error: `GitHub API returned status ${res.statusCode}` });
-                            return;
-                        }
-                        const parsed = JSON.parse(data);
-                        resolve({ body: parsed.body || '' });
-                    }
-                    catch (err) {
-                        console.error('[Changelog] Failed to parse GitHub response:', err);
-                        resolve({ body: '', error: 'Failed to parse GitHub response' });
-                    }
-                });
-            })
-                .on('error', (err) => {
-                console.error('[Changelog] Failed to fetch from GitHub:', err);
-                resolve({ body: '', error: `Failed to fetch from GitHub: ${err.message}` });
-            });
-        }
-        catch (err) {
-            console.error('[Changelog] Unexpected error:', err);
-            resolve({ body: '', error: `Unexpected error: ${err}` });
-        }
-    });
-}
-/**
- * Strip markdown links from text
- */
-function stripMarkdownLinks(text) {
-    return text.replace(/\[([^\]]+)\]\([^\)]+\)/g, '$1');
-}
-class N8nChangelog {
-    constructor() {
-        this.description = {
-            displayName: 'n8n Changelog',
-            name: 'n8nChangelog',
-            icon: 'file:n8n-version.svg',
-            group: ['transform'],
-            version: 1,
-            description: 'Fetches changelog for a specific n8n version from GitHub',
-            defaults: {
-                name: 'n8n Changelog',
-            },
-            inputs: ['main'],
-            outputs: ['main'],
-            properties: [
-                {
-                    displayName: 'Version Source',
-                    name: 'versionSource',
-                    type: 'options',
-                    options: [
-                        {
-                            name: 'From Parameter',
-                            value: 'parameter',
-                        },
-                        {
-                            name: 'From Input',
-                            value: 'input',
-                        },
-                    ],
-                    default: 'parameter',
-                    description: 'Where to get the version from',
-                },
-                {
-                    displayName: 'Version',
-                    name: 'version',
-                    type: 'string',
-                    default: '',
-                    placeholder: '1.0.0',
-                    description: 'The n8n version to fetch changelog for (e.g., "1.0.0")',
-                    displayOptions: {
-                        show: {
-                            versionSource: ['parameter'],
-                        },
-                    },
-                },
-                {
-                    displayName: 'Version Field',
-                    name: 'versionField',
-                    type: 'string',
-                    default: 'latestVersion',
-                    description: 'The field name containing the version in input data',
-                    displayOptions: {
-                        show: {
-                            versionSource: ['input'],
-                        },
-                    },
-                },
-                {
-                    displayName: 'Include Links',
-                    name: 'includeLinks',
-                    type: 'boolean',
-                    default: true,
-                    description: 'Whether to keep markdown links in the changelog text',
-                },
-            ],
-        };
-    }
-    async execute() {
-        const items = this.getInputData();
-        const returnData = [];
-        for (let i = 0; i < items.length; i++) {
-            try {
-                const versionSource = this.getNodeParameter('versionSource', i);
-                const includeLinks = this.getNodeParameter('includeLinks', i);
-                let version;
-                if (versionSource === 'input') {
-                    const versionField = this.getNodeParameter('versionField', i);
-                    version = items[i].json[versionField];
-                }
-                else {
-                    version = this.getNodeParameter('version', i);
-                }
-                if (!version) {
-                    returnData.push({
-                        json: {
-                            error: 'No version provided',
-                            changelog: '',
-                        },
-                    });
-                    continue;
-                }
-                const { body, error } = await getChangelog(version);
-                let changelog = body;
-                if (!includeLinks && changelog) {
-                    changelog = stripMarkdownLinks(changelog);
-                }
-                returnData.push({
-                    json: {
-                        version,
-                        changelog,
-                        error: error || undefined,
-                    },
-                });
-            }
-            catch (err) {
-                console.error('[Changelog] Error processing item:', err);
-                returnData.push({
-                    json: {
-                        error: `Failed to process: ${err}`,
-                        changelog: '',
-                    },
-                });
-            }
-        }
-        return [returnData];
-    }
-}
-exports.N8nChangelog = N8nChangelog;

package/dist/nodes/N8nChangelog/n8n-version.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0,0,256,256" width="256px" height="256px" fill-rule="nonzero"><g fill="#f188a2" fill-rule="nonzero" stroke="none" stroke-width="1" stroke-linecap="butt" stroke-linejoin="miter" stroke-miterlimit="10" stroke-dasharray="" stroke-dashoffset="0" font-family="none" font-weight="none" font-size="none" text-anchor="none" style="mix-blend-mode: normal"><g transform="scale(5.12,5.12)"><path d="M20,3c-5.514,0 -10,4.486 -10,10v20.17188l-3.58594,-3.58594c-0.37701,-0.38755 -0.89487,-0.60597 -1.43555,-0.60547c-0.81349,0.00101 -1.54533,0.49459 -1.85108,1.24844c-0.30574,0.75385 -0.12447,1.61777 0.4585,2.18515l7,7c0.78106,0.78074 2.04706,0.78074 2.82812,0l7,-7c0.52248,-0.50163 0.73295,-1.24653 0.55024,-1.94742c-0.18271,-0.70088 -0.73006,-1.24823 -1.43094,-1.43094c-0.70088,-0.18271 -1.44578,0.02776 -1.94742,0.55024l-3.58594,3.58594v-20.17187c0,-3.309 2.691,-6 6,-6h10.46875l0.26563,-4zM37.9707,10c-0.52023,0.00778 -1.01695,0.21796 -1.38477,0.58594l-7,7c-0.52248,0.50163 -0.73295,1.24653 -0.55024,1.94742c0.18271,0.70088 0.73006,1.24823 1.43094,1.43094c0.70088,0.18271 1.44578,-0.02776 1.94742,-0.55024l3.58594,-3.58594v20.17188c0,3.309 -2.691,6 -6,6h-10.49023l-0.25391,4h10.74414c5.514,0 10,-4.486 10,-10v-20.17187l3.58594,3.58594c0.50163,0.52248 1.24653,0.73295 1.94742,0.55024c0.70088,-0.18271 1.24823,-0.73006 1.43094,-1.43094c0.18271,-0.70088 -0.02776,-1.44578 -0.55024,-1.94742l-7,-7c-0.38217,-0.38233 -0.90283,-0.5937 -1.44336,-0.58594z"></path></g></g></svg>