@theihtisham/ai-release-notes 1.0.0

package/src/constants.js

@@ -0,0 +1,137 @@
+'use strict';
+
+module.exports = {
+  DEFAULT_CATEGORIES: [
+    { label: '🚀 Features', patterns: ['feat', 'feature', 'add', 'new'] },
+    { label: '🐛 Bug Fixes', patterns: ['fix', 'bugfix', 'patch', 'hotfix'] },
+    { label: '💥 Breaking Changes', patterns: ['breaking', 'BREAKING CHANGE', 'BREAKING'] },
+    { label: '⚡ Performance', patterns: ['perf', 'performance', 'optimize', 'speed'] },
+    { label: '♻️ Refactoring', patterns: ['refactor', 'restructure', 'reorganize'] },
+    { label: '📝 Documentation', patterns: ['docs', 'doc', 'readme', 'documentation'] },
+    { label: '🎨 Style', patterns: ['style', 'format', 'lint', 'prettier'] },
+    { label: '🧪 Tests', patterns: ['test', 'spec', 'coverage'] },
+    { label: '🔧 Chore', patterns: ['chore', 'build', 'ci', 'deps', 'dependabot'] },
+    { label: '🔒 Security', patterns: ['security', 'vulnerability', 'CVE'] },
+  ],
+
+  LANGUAGES: {
+    en: {
+      title: 'Release Notes',
+      summary: 'Summary',
+      contributors: 'Contributors',
+      breaking: 'Breaking Changes',
+      fullChangelog: 'Full Changelog',
+      features: 'Features',
+      bugFixes: 'Bug Fixes',
+      other: 'Other Changes',
+    },
+    es: {
+      title: 'Notas de la Versión',
+      summary: 'Resumen',
+      contributors: 'Colaboradores',
+      breaking: 'Cambios Importantes',
+      fullChangelog: 'Registro Completo',
+      features: 'Características',
+      bugFixes: 'Correcciones',
+      other: 'Otros Cambios',
+    },
+    fr: {
+      title: 'Notes de Version',
+      summary: 'Résumé',
+      contributors: 'Contributeurs',
+      breaking: 'Changements Cassants',
+      fullChangelog: 'Journal Complet',
+      features: 'Fonctionnalités',
+      bugFixes: 'Corrections',
+      other: 'Autres Changements',
+    },
+    de: {
+      title: 'Versionshinweise',
+      summary: 'Zusammenfassung',
+      contributors: 'Mitwirkende',
+      breaking: 'Breaking Changes',
+      fullChangelog: 'Vollständiges Änderungsprotokoll',
+      features: 'Funktionen',
+      bugFixes: 'Fehlerbehebungen',
+      other: 'Sonstige Änderungen',
+    },
+    ja: {
+      title: 'リリースノート',
+      summary: '概要',
+      contributors: '貢献者',
+      breaking: '重大な変更',
+      fullChangelog: '完全な変更履歴',
+      features: '機能',
+      bugFixes: 'バグ修正',
+      other: 'その他の変更',
+    },
+    ko: {
+      title: '릴리스 노트',
+      summary: '요약',
+      contributors: '기여자',
+      breaking: '주요 변경사항',
+      fullChangelog: '전체 변경 이력',
+      features: '기능',
+      bugFixes: '버그 수정',
+      other: '기타 변경사항',
+    },
+    zh: {
+      title: '发布说明',
+      summary: '摘要',
+      contributors: '贡献者',
+      breaking: '破坏性变更',
+      fullChangelog: '完整变更日志',
+      features: '新功能',
+      bugFixes: '错误修复',
+      other: '其他变更',
+    },
+    pt: {
+      title: 'Notas de Versão',
+      summary: 'Resumo',
+      contributors: 'Contribuidores',
+      breaking: 'Mudanças Importantes',
+      fullChangelog: 'Registro Completo',
+      features: 'Funcionalidades',
+      bugFixes: 'Correções',
+      other: 'Outras Mudanças',
+    },
+    ru: {
+      title: 'Примечания к релизу',
+      summary: 'Обзор',
+      contributors: 'Участники',
+      breaking: 'Критические изменения',
+      fullChangelog: 'Полный журнал изменений',
+      features: 'Функции',
+      bugFixes: 'Исправления',
+      other: 'Прочие изменения',
+    },
+  },
+
+  DEFAULTS: {
+    TEMPLATE: 'default',
+    COMMIT_MODE: 'auto',
+    VERSION_FROM: 'tag',
+    MAX_COMMITS: 200,
+    LANGUAGE: 'en',
+    TEMPERATURE: 0.3,
+    MAX_TOKENS: 4000,
+  },
+
+  CONVENTIONAL_COMMIT_REGEX: /^(feat|fix|perf|refactor|docs|style|test|chore|build|ci|revert)(\(([^)]+)\))?(!)?:\s*(.+)/i,
+
+  BREAKING_CHANGE_REGEX: /BREAKING[ -]CHANGE:\s*(.+)/i,
+
+  BUILT_IN_TEMPLATES: ['default', 'minimal', 'detailed', 'enterprise', 'fun'],
+
+  VALID_COMMIT_MODES: ['commits', 'pull-requests', 'auto'],
+
+  VALID_VERSION_SOURCES: ['tag', 'package-json', 'manual'],
+
+  VALID_LANGUAGES: ['en', 'es', 'fr', 'de', 'ja', 'ko', 'zh', 'pt', 'ru'],
+
+  IMPACT_THRESHOLDS: {
+    LOW: 5,
+    MEDIUM: 20,
+    HIGH: Infinity,
+  },
+};

package/src/contributor.js

@@ -0,0 +1,144 @@
+'use strict';
+
+const logger = require('./logger');
+
+/**
+ * Get contributors from commits and PRs.
+ * Detects first-time contributors, counts contributions, sorts by count.
+ */
+function getContributors(commits, prs) {
+  const contributorMap = new Map();
+
+  // Collect from commits
+  if (commits && Array.isArray(commits)) {
+    for (const commit of commits) {
+      try {
+        const author = commit.author || (commit.commit && commit.commit.author) || {};
+        const login =
+          author.login ||
+          (author.name) ||
+          '';
+        const avatarUrl = author.avatar_url || '';
+        const name = author.name || author.login || login;
+
+        if (!login) continue;
+
+        if (contributorMap.has(login)) {
+          const existing = contributorMap.get(login);
+          existing.commits_count += 1;
+        } else {
+          contributorMap.set(login, {
+            login: login,
+            name: name,
+            avatar_url: avatarUrl,
+            commits_count: 1,
+            is_first_time: false,
+          });
+        }
+      } catch (err) {
+        logger.debug(`Failed to process commit author: ${err.message}`);
+      }
+    }
+  }
+
+  // Collect from PRs
+  if (prs && Array.isArray(prs)) {
+    for (const pr of prs) {
+      try {
+        const user = pr.user || {};
+        const login = user.login || '';
+        if (!login) continue;
+
+        if (contributorMap.has(login)) {
+          contributorMap.get(login).commits_count += 1;
+        } else {
+          contributorMap.set(login, {
+            login: login,
+            name: user.name || login,
+            avatar_url: user.avatar_url || '',
+            commits_count: 1,
+            is_first_time: false,
+          });
+        }
+
+        // Add reviewers
+        if (pr.requested_reviewers && Array.isArray(pr.requested_reviewers)) {
+          for (const reviewer of pr.requested_reviewers) {
+            const rLogin = reviewer.login || '';
+            if (!rLogin) continue;
+            if (!contributorMap.has(rLogin)) {
+              contributorMap.set(rLogin, {
+                login: rLogin,
+                name: reviewer.name || rLogin,
+                avatar_url: reviewer.avatar_url || '',
+                commits_count: 0,
+                is_first_time: false,
+              });
+            }
+          }
+        }
+      } catch (err) {
+        logger.debug(`Failed to process PR contributor: ${err.message}`);
+      }
+    }
+  }
+
+  // Sort by contribution count (descending)
+  const contributors = Array.from(contributorMap.values()).sort(
+    (a, b) => b.commits_count - a.commits_count
+  );
+
+  return contributors;
+}
+
+/**
+ * Detect first-time contributors by comparing against known contributors from previous releases.
+ */
+function detectFirstTimers(contributors, previousContributors) {
+  const previousSet = new Set((previousContributors || []).map(c => c.login || c));
+
+  return contributors.map(c => ({
+    ...c,
+    is_first_time: !previousSet.has(c.login),
+  }));
+}
+
+/**
+ * Format a contributor thanks string.
+ * Example: "Thanks to @user1, @user2, @user3 and @user4 for their contributions!"
+ */
+function formatContributorThanks(contributors) {
+  if (!contributors || contributors.length === 0) {
+    return '';
+  }
+
+  const firstTimers = contributors.filter(c => c.is_first_time);
+  const allLogins = contributors.map(c => `@${c.login}`);
+
+  let thanks = '';
+  if (allLogins.length === 1) {
+    thanks = `Thanks to ${allLogins[0]} for this release!`;
+  } else if (allLogins.length === 2) {
+    thanks = `Thanks to ${allLogins[0]} and ${allLogins[1]} for their contributions!`;
+  } else if (allLogins.length <= 5) {
+    const last = allLogins.pop();
+    thanks = `Thanks to ${allLogins.join(', ')} and ${last} for their contributions!`;
+  } else {
+    const displayed = allLogins.slice(0, 5);
+    const remaining = allLogins.length - 5;
+    thanks = `Thanks to ${displayed.join(', ')} and ${remaining} other contributor${remaining > 1 ? 's' : ''} for their contributions!`;
+  }
+
+  if (firstTimers.length > 0) {
+    const firstTimerLogins = firstTimers.map(c => `@${c.login}`);
+    thanks += `\n\n🎉 First-time contributors: ${firstTimerLogins.join(', ')}`;
+  }
+
+  return thanks;
+}
+
+module.exports = {
+  getContributors,
+  detectFirstTimers,
+  formatContributorThanks,
+};

package/src/diff-analyzer.js

@@ -0,0 +1,202 @@
+'use strict';
+
+const { IMPACT_THRESHOLDS } = require('./constants');
+const logger = require('./logger');
+
+/**
+ * Analyze diffs for a set of commits via the GitHub API.
+ * @param {Array} commits - Commits to analyze
+ * @param {Object} octokit - Octokit instance
+ * @param {Object} context - GitHub Actions context
+ * @returns {Object} Diff summary with file stats, impact, affected areas
+ */
+async function analyzeDiff(commits, octokit, context) {
+  const result = {
+    files_changed: 0,
+    files_added: 0,
+    files_modified: 0,
+    files_deleted: 0,
+    additions: 0,
+    deletions: 0,
+    impact: 'low',
+    affected_areas: [],
+    potential_breaking: [],
+    files: [],
+  };
+
+  if (!commits || commits.length === 0 || !octokit || !context) {
+    logger.debug('Skipping diff analysis: no commits or no octokit/context');
+    return result;
+  }
+
+  const owner = context.repo.owner;
+  const repo = context.repo.repo;
+
+  for (const commit of commits) {
+    try {
+      const sha = commit.sha || commit.id;
+      if (!sha) continue;
+
+      const { data: commitData } = await octokit.rest.repos.getCommit({
+        owner,
+        repo,
+        ref: sha,
+      });
+
+      const files = commitData.files || [];
+      for (const file of files) {
+        result.files.push({
+          filename: file.filename,
+          status: file.status,
+          additions: file.additions,
+          deletions: file.deletions,
+          changes: file.changes,
+        });
+
+        result.additions += file.additions || 0;
+        result.deletions += file.deletions || 0;
+        result.files_changed += 1;
+
+        if (file.status === 'added') result.files_added += 1;
+        else if (file.status === 'modified') result.files_modified += 1;
+        else if (file.status === 'removed') result.files_deleted += 1;
+
+        // Detect affected areas
+        detectAffectedAreas(file.filename, result.affected_areas);
+
+        // Detect potential breaking changes
+        detectPotentialBreaking(file, result.potential_breaking);
+      }
+    } catch (err) {
+      logger.debug(`Failed to get diff for commit ${commit.sha}: ${err.message}`);
+    }
+  }
+
+  // Remove duplicate affected areas
+  result.affected_areas = [...new Set(result.affected_areas)];
+
+  // Determine impact level
+  if (result.files_changed <= IMPACT_THRESHOLDS.LOW) {
+    result.impact = 'low';
+  } else if (result.files_changed <= IMPACT_THRESHOLDS.MEDIUM) {
+    result.impact = 'medium';
+  } else {
+    result.impact = 'high';
+  }
+
+  logger.info(`Diff analysis: ${result.files_changed} files changed, impact=${result.impact}, areas=${result.affected_areas.join(',')}`);
+
+  return result;
+}
+
+/**
+ * Detect which areas of the codebase are affected by a file change.
+ */
+function detectAffectedAreas(filename, areas) {
+  if (!filename) return;
+
+  const lower = filename.toLowerCase();
+
+  if (lower.includes('route') || lower.includes('controller') || lower.includes('api/') || lower.includes('endpoint')) {
+    areas.push('API');
+  }
+  if (lower.includes('model') || lower.includes('schema') || lower.includes('migration') || lower.includes('db/') || lower.includes('database')) {
+    areas.push('Database');
+  }
+  if (lower.includes('auth') || lower.includes('login') || lower.includes('token') || lower.includes('session') || lower.includes('password')) {
+    areas.push('Authentication');
+  }
+  if (lower.includes('component') || lower.includes('page') || lower.includes('view') || lower.includes('ui/') || lower.includes('style')) {
+    areas.push('UI');
+  }
+  if (lower.includes('config') || lower.includes('.env') || lower.includes('setting')) {
+    areas.push('Configuration');
+  }
+  if (lower.includes('test') || lower.includes('spec') || lower.includes('__test__')) {
+    areas.push('Tests');
+  }
+  if (lower.includes('middleware') || lower.includes('interceptor') || lower.includes('filter')) {
+    areas.push('Middleware');
+  }
+  if (lower.includes('util') || lower.includes('helper') || lower.includes('service')) {
+    areas.push('Utilities');
+  }
+}
+
+/**
+ * Detect potential breaking changes from a diff.
+ */
+function detectPotentialBreaking(file, potentialBreaking) {
+  if (!file) return;
+
+  const filename = (file.filename || '').toLowerCase();
+
+  // Removed exports in index files
+  if (file.status === 'removed' && (filename.includes('index.') || filename.includes('export'))) {
+    potentialBreaking.push({
+      file: file.filename,
+      reason: 'Export file was removed',
+    });
+  }
+
+  // Large deletion ratio might indicate removed functionality
+  if (file.deletions > file.additions * 3 && file.deletions > 20) {
+    potentialBreaking.push({
+      file: file.filename,
+      reason: `Significant code removal (${file.deletions} deletions vs ${file.additions} additions)`,
+    });
+  }
+
+  // Changes to public API files
+  if (filename.includes('api') && filename.includes('public')) {
+    if (file.status === 'modified') {
+      potentialBreaking.push({
+        file: file.filename,
+        reason: 'Public API file was modified',
+      });
+    }
+  }
+}
+
+/**
+ * Format diff stats for display in release notes.
+ */
+function formatDiffStats(diffSummary) {
+  if (!diffSummary || diffSummary.files_changed === 0) {
+    return '';
+  }
+
+  const lines = [];
+  lines.push(`- **${diffSummary.files_changed}** file${diffSummary.files_changed !== 1 ? 's' : ''} changed`);
+  if (diffSummary.files_added > 0) {
+    lines.push(`- **${diffSummary.files_added}** file${diffSummary.files_added !== 1 ? 's' : ''} added`);
+  }
+  if (diffSummary.files_modified > 0) {
+    lines.push(`- **${diffSummary.files_modified}** file${diffSummary.files_modified !== 1 ? 's' : ''} modified`);
+  }
+  if (diffSummary.files_deleted > 0) {
+    lines.push(`- **${diffSummary.files_deleted}** file${diffSummary.files_deleted !== 1 ? 's' : ''} deleted`);
+  }
+  lines.push(`- **+${diffSummary.additions}** additions, **-${diffSummary.deletions}** deletions`);
+
+  if (diffSummary.impact === 'high') {
+    lines.push(`- Impact: **High** (20+ files changed)`);
+  } else if (diffSummary.impact === 'medium') {
+    lines.push(`- Impact: **Medium** (6-20 files changed)`);
+  } else {
+    lines.push(`- Impact: **Low** (1-5 files changed)`);
+  }
+
+  if (diffSummary.affected_areas.length > 0) {
+    lines.push(`- Affected areas: ${diffSummary.affected_areas.join(', ')}`);
+  }
+
+  return lines.join('\n');
+}
+
+module.exports = {
+  analyzeDiff,
+  detectAffectedAreas,
+  detectPotentialBreaking,
+  formatDiffStats,
+};