Registry / devops / migration-release

migration-release

library1.0.15jsnpmunverified

A CLI tool for generating release notes and migration guides from structured JSON files. Current stable version is 1.0.15, with no regular release cadence (appears to be maintained sporadically). It reads release data from a `releases/` directory containing JSON files per version, and outputs Markdown documentation. Key differentiators include automatic generation of migration guides highlighting runtime, environment variable, and script changes between versions, as well as support for custom arrays in JSON that become sections in the release notes. The tool is entirely CLI-based and requires Node.js >= 14. It has limited adoption and no notable alternatives directly compared.

devops

npm install migration-release

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MIGRATION-RELEASE

migration-release

devopsjavascriptv1.0.15

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

migration-release

✓ npx migration-release gen-release 1.0.0

✗ npm run gen-release

The package is a CLI tool; use npx or global install. Running via npm scripts may require adding to package.json bin scripts.

gen-release

✓ npx gen-release 1.0.0

✗ require('migration-release').genRelease()

Commands are not exported as JavaScript functions but are CLI commands. Trying to import programmatically will cause errors.

gen-migration

✓ npx gen-migration 1.0.0 2.0.0

✗ import { genMigration } from 'migration-release'

CLI commands are not API functions. Use npx or global install to run them.

Create release JSON files and generate release notes and migration guide using CLI commands.

mkdir -p releases cat > releases/1.0.0.json << 'EOF' { "version": "1.0.0", "date": "2025-01-15", "features": ["Initial release"] } EOF cat > releases/2.0.0.json << 'EOF' { "version": "2.0.0", "date": "2025-06-01", "breakingChanges": ["Removed old API"], "env": [{"key": "NEW_VAR", "required": true,"default": "foo", "description": "New environment variable"}] } EOF npx migration-release gen-release 2.0.0 npx migration-release gen-migration 1.0.0 2.0.0

Debug

Known issues

gotchaAll release JSON files must be in a directory named 'releases' at the project root. The tool does not support custom paths for reading JSON files, only output directories.

fix

Create a 'releases/' directory in the current working directory and place version JSON files there.

affects: >=1.0.0

gotchaThe tool reads ALL JSON files in the releases/ directory, including non-version files. It expects filenames like <version>.json (e.g., 1.0.0.json). If other JSON files are present, they may cause errors or unexpected behavior.

fix

Ensure only version-named JSON files exist in releases/ (e.g., 1.0.0.json, 2.0.0.json). Avoid additional files like config.json.

affects: >=1.0.0

gotchaThe 'version' field in the JSON is not validated; if omitted or mismatched with the filename, the output may be inconsistent.

fix

Always include a 'version' field in the JSON that matches the filename (e.g., '1.0.0' for 1.0.0.json).

affects: >=1.0.0

Errors

Common errors & fixes

ENOENT: no such file or directory, open 'releases/1.0.0.json'

The releases/ directory does not contain the required JSON file, or the directory does not exist.

fix

Create a releases/ directory at the root of your project and add the version JSON files (e.g., releases/1.0.0.json).

Unknown command: gen-release

The migration-release package is not installed globally or the command is not in PATH.

fix

Install globally with 'npm install -g migration-release' or use 'npx migration-release gen-release'.

Upgrade

Version history

1.0.15latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/ngthminhdev/migration-release ↗

packagemigration-release ↗

homepagehttps://github.com/ngthminhdev/migration-release#readme ↗