@tpmjs/tools-release-checklist
Generates a comprehensive release checklist from component information. Analyzes components for tests, documentation, and version compliance. Creates a detailed markdown checklist with priority levels, identifies release blockers, and calculates readiness percentage. Useful for release planning, tracking release progress, and ensuring quality standards.
Test @tpmjs/tools-release-checklist (releaseChecklistTool) with AI-powered execution
0/2000 characters
Install this tool and use it with the AI SDK
npm install @tpmjs/tools-release-checklistpnpm add @tpmjs/tools-release-checklistyarn add @tpmjs/tools-release-checklistbun add @tpmjs/tools-release-checklistdeno add npm:@tpmjs/tools-release-checklistimport { releaseChecklistTool } from '@tpmjs/tools-release-checklist';import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { releaseChecklistTool } from '@tpmjs/tools-release-checklist';
const result = await generateText({
model: openai('gpt-4o'),
tools: { releaseChecklistTool },
prompt: 'Your prompt here...',
});
console.log(result.text);Available configuration options
componentsarrayArray of components to include in the release
Schema extracted: 1/1/2026, 8:18:22 AM
Generates comprehensive release checklists from component information with readiness tracking and blocker detection.
npm install @tpmjs/tools-release-checklist
import { releaseChecklistTool } from '@tpmjs/tools-release-checklist'; const result = await releaseChecklistTool.execute({ components: [ { name: 'UserService', hasTests: true, hasDocs: true, version: '2.1.0' }, { name: 'AuthModule', hasTests: false, hasDocs: true, version: '1.5.0' }, { name: 'PaymentAPI', hasTests: true, hasDocs: false, version: 'invalid' } ] }); console.log(result.checklist); // # Release Checklist // // ## Testing // // ### UserService // - [x] ๐ด Unit tests passing // - [ ] ๐ก Integration tests passing // ... console.log(result.blockers); // [ // 'AuthModule: Missing tests (critical)', // 'PaymentAPI: Missing documentation (high priority)', // 'PaymentAPI: Version invalid follows semver (critical)' // ] console.log(result.summary); // { // totalComponents: 3, // componentsReady: 1, // componentsBlocked: 1, // readinessPercentage: 33, // criticalItems: 24, // incompleteItems: 28 // }
{ components: Array<{ name: string; // Component name hasTests: boolean; // Whether component has tests hasDocs: boolean; // Whether component has documentation version: string; // Semantic version (e.g., "1.0.0") }> }
{ checklist: string; // Markdown-formatted checklist items: Array<{ component: string; // Component name or "Release" item: string; // Checklist item description status: 'complete' | 'incomplete' | 'blocked'; priority: 'critical' | 'high' | 'medium' | 'low'; category: 'testing' | 'documentation' | 'versioning' | 'quality' | 'deployment'; }>; readyCount: number; // Number of components ready for release blockers: string[]; // List of release blockers summary: { totalComponents: number; componentsReady: number; componentsBlocked: number; readinessPercentage: number; criticalItems: number; incompleteItems: number; }; }
The tool generates items across five categories:
A component is considered "ready" when:
hasTests: true)hasDocs: true)1.2.3)const result = await releaseChecklistTool.execute({ components: [ { name: 'CoreAPI', hasTests: true, hasDocs: true, version: '3.0.0' }, { name: 'UIKit', hasTests: true, hasDocs: true, version: '3.0.0' } ] }); // result.summary.readinessPercentage === 100 // result.readyCount === 2
const result = await releaseChecklistTool.execute({ components: [ { name: 'BetaFeature', hasTests: false, hasDocs: false, version: 'v1' } ] }); // result.blockers includes: // - "BetaFeature: Missing tests (critical)" // - "BetaFeature: Missing documentation (high priority)" // - "BetaFeature: Version v1 follows semver (critical)"
const components = [ { name: 'Module1', hasTests: true, hasDocs: true, version: '2.0.0' }, { name: 'Module2', hasTests: true, hasDocs: true, version: '2.0.0' }, // ... 10 more modules ]; const result = await releaseChecklistTool.execute({ components }); // Generates comprehensive checklist with: // - 100+ checklist items // - Organized by category and component // - Clear blocker identification
MIT
Downloads/month
0
Quality Score