@tpmjs/tools-release-notes
Generate release notes from structured changes. Groups changes by type (features, fixes, breaking changes, etc.) and formats them as markdown. Returns formatted notes with version, date, and summary statistics.
Changes array cannot be empty
Last checked: 1/1/2026, 8:17:45 AM
Test @tpmjs/tools-release-notes (releaseNotesTool) with AI-powered execution
0/2000 characters
Install this tool and use it with the AI SDK
npm install @tpmjs/tools-release-notespnpm add @tpmjs/tools-release-notesyarn add @tpmjs/tools-release-notesbun add @tpmjs/tools-release-notesdeno add npm:@tpmjs/tools-release-notesimport { releaseNotesTool } from '@tpmjs/tools-release-notes';import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { releaseNotesTool } from '@tpmjs/tools-release-notes';
const result = await generateText({
model: openai('gpt-4o'),
tools: { releaseNotesTool },
prompt: 'Your prompt here...',
});
console.log(result.text);Available configuration options
versionstringVersion number (e.g., "1.2.0", "v2.0.0-beta.1")
changesarrayArray of changes to include in the release notes
Schema extracted: 1/1/2026, 8:17:45 AM
Generate release notes from structured changes. Groups changes by type and formats them as markdown.
npm install @tpmjs/tools-release-notes ai
import { releaseNotesTool } from '@tpmjs/tools-release-notes'; const result = await releaseNotesTool.execute({ version: 'v1.2.0', changes: [ { type: 'feature', description: 'Add dark mode support', issue: '123', }, { type: 'fix', description: 'Fix memory leak in cache manager', issue: '456', }, { type: 'breaking', description: 'Remove deprecated API methods', }, { type: 'docs', description: 'Update installation guide', }, ], }); console.log(result.notes);
# v1.2.0 (2025-12-31) ⚠️ **This release contains breaking changes!** **Changes:** 4 total (1 feature, 1 fix, 1 breaking, 1 other) --- ## 💥 BREAKING CHANGES - Remove deprecated API methods ## ✨ Features - Add dark mode support ([#123](../../issues/123)) ## 🐛 Bug Fixes - Fix memory leak in cache manager ([#456](../../issues/456)) ## 📝 Documentation - Update installation guide
version (string, required) - Version number (e.g., "1.2.0", "v2.0.0-beta.1")changes (array, required) - Array of change objects:
type (string) - One of: feature, fix, breaking, docs, chore, perf, refactor, test, otherdescription (string) - Description of the changeissue (string, optional) - Issue number (e.g., "123"){ notes: string; // Formatted markdown version: string; // Version number date: string; // ISO date (YYYY-MM-DD) summary: { features: number; fixes: number; breaking: number; other: number; total: number; }; }
The tool supports the following change types:
feature - New featuresfix - Bug fixesbreaking - Breaking changesdocs - Documentation updateschore - Maintenance tasksperf - Performance improvementsrefactor - Code refactoringtest - Test updatesother - Other changesMIT
Downloads/month
0
Quality Score