create-app-release 1.0.2 → 1.2.0

package/CHANGELOG.md

@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0] - 2025-03-18
+
+### Added
+
+- Auto suggest repositories based on recent activities
+- Added filter for listed pull requests for easy tracking
+- Dynamic release version suggestion based on previous releases
+- Added suggestion for source and target branches
+
+### Changed
+
+- Updated release summary generation to exclude heading
+
+## [1.1.0] - 2025-02-12
+
+### Added
+
+- Added support for multiple LLM providers:
+  - OpenAI models (default)
+  - Deepseek models
+  - QwenAI models
+  - Local LLM deployments
+- New command-line options for LLM configuration:
+  - `--openai-key`: Set API key directly
+  - `--openai-model`: Choose model (e.g., gpt-4o, deepseek-r1, qwen2.5)
+  - `--openai-base-url`: Set custom API base URL for different providers
+- Enhanced help information with detailed options and provider-specific examples
+
 ## [1.0.2] - 2025-02-09
 
 ### Changed
@@ -44,4 +72,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - ora - Terminal spinners
 - dotenv - Environment variable management
 
+[1.2.0]: https://github.com/jamesgordo/create-app-release/releases/tag/v1.2.0
+[1.1.0]: https://github.com/jamesgordo/create-app-release/releases/tag/v1.1.0
 [1.0.0]: https://github.com/jamesgordo/create-app-release/releases/tag/v1.0.0

package/README.md

@@ -1,10 +1,18 @@
 # create-app-release
 
-An AI-powered GitHub release automation tool that helps you create release pull requests with automatically generated summaries using OpenAI's GPT-4 model. The tool intelligently groups your changes and creates professional release notes, making the release process smoother and more efficient.
+[![NPM Version](https://img.shields.io/npm/v/create-app-release.svg)](https://www.npmjs.com/package/create-app-release)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+An AI-powered GitHub release automation tool that helps you create release pull requests with automatically generated summaries using various LLM providers. The tool intelligently groups your changes and creates professional release notes, making the release process smoother and more efficient.
 
 ## Features
 
 - 🤖 AI-powered release notes generation using GPT-4
+- 🔄 Flexible LLM support:
+  - OpenAI models (GPT-4o, GPT-3.5-turbo)
+  - Deepseek models
+  - QwenAI models
+  - Local LLM deployments
 - 📦 Zero configuration - works right out of the box
 - 🔑 Secure token management through git config
 - 🎯 Interactive pull request selection
@@ -47,6 +55,38 @@ You'll need two tokens to use this tool:
 2. **OpenAI API Key** - Get from [OpenAI Platform](https://platform.openai.com/api-keys)
    - Will be stored in git config as `openai.token`
 
+### Command-Line Options
+
+Customize the tool's behavior using these command-line options:
+
+```bash
+# Set OpenAI API key directly (alternative to env/git config)
+--openai-key <key>
+
+# Choose OpenAI model (default: "gpt-4o")
+--openai-model <model>
+# Examples: gpt-4o, gpt-3.5-turbo, deepseek-r1, qwen2.5
+
+# Set custom OpenAI API base URL
+--openai-base-url <url>
+# Examples:
+# - Deepseek: https://api.deepseek.com/v1
+# - QwenAI: https://api.qwen.ai/v1
+# - Local: http://localhost:8000/v1
+# - Custom: https://custom-openai-endpoint.com/v1
+
+# Full example with different providers:
+
+# Using Deepseek
+npx create-app-release --openai-base-url https://api.deepseek.com/v1 --openai-key your_deepseek_key --openai-model deepseek-chat
+
+# Using QwenAI
+npx create-app-release --openai-base-url https://api.qwen.ai/v1 --openai-key your_qwen_key --openai-model qwen-14b-chat
+
+# Using Local LLM
+npx create-app-release --openai-base-url http://localhost:8000/v1 --openai-model local-model
+```
+
 ### Environment Variables (Optional)
 
 Tokens can also be provided via environment variables:
@@ -85,3 +125,7 @@ The tool generates professional release notes in this format:
 ## License
 
 MIT
+
+## Author
+
+[James Gordo](https://github.com/jamesgordo)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-app-release",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "AI-powered GitHub release automation tool",
   "main": "src/index.js",
   "type": "module",
@@ -27,6 +27,14 @@
   ],
   "author": "James Gordo",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jamesgordo/create-app-release.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jamesgordo/create-app-release/issues"
+  },
+  "homepage": "https://github.com/jamesgordo/create-app-release#readme",
   "lint-staged": {
     "*.{js,jsx,ts,tsx}": [
       "eslint --fix",

package/src/index.js

@@ -18,6 +18,22 @@ const require = createRequire(import.meta.url);
 // Load environment variables
 config();
 
+// Setup graceful exit handlers
+process.stdin.setRawMode(true);
+process.stdin.resume();
+process.stdin.setEncoding('utf8');
+
+// Display exit instructions
+console.log(chalk.cyan('Press Ctrl+C or q to exit at any time'));
+
+process.stdin.on('data', (key) => {
+  // Ctrl+C or 'q' to exit
+  if (key === '\u0003' || key.toLowerCase() === 'q') {
+    console.log(chalk.yellow('\nExiting gracefully...'));
+    process.exit(0);
+  }
+});
+
 // Initialize CLI program
 const program = new Command();
 const pkg = require('../package.json');
@@ -154,14 +170,130 @@ function extractPRNumbersFromDescription(description) {
   return new Set(prMatches.map((match) => parseInt(match.replace(/[^0-9]/g, ''))));
 }
 
+/**
+ * Fetch repositories the user has contributed to, including personal and organization repos
+ * @returns {Promise<Array>} List of repositories
+ */
+async function fetchUserRepositories() {
+  const spinner = ora('Fetching your repositories...').start();
+  try {
+    // Get authenticated user info
+    const { data: user } = await octokit.rest.users.getAuthenticated();
+    const username = user.login;
+
+    // Get user's repositories (both owned and contributed to)
+    const repos = [];
+
+    // Fetch user's own repositories
+    const userReposIterator = octokit.paginate.iterator(
+      octokit.rest.repos.listForAuthenticatedUser,
+      {
+        per_page: 100,
+        sort: 'updated',
+        direction: 'desc',
+      }
+    );
+
+    for await (const { data: userRepos } of userReposIterator) {
+      repos.push(
+        ...userRepos.map((repo) => ({
+          name: `${repo.owner.login}/${repo.name}`,
+          fullName: `${repo.owner.login}/${repo.name}`,
+          owner: repo.owner.login,
+          repoName: repo.name,
+          updatedAt: new Date(repo.updated_at),
+          pushedAt: new Date(repo.pushed_at || repo.updated_at),
+          isPersonal: repo.owner.login === username,
+          activityScore: 0, // Will be calculated based on user activity
+        }))
+      );
+
+      // Limit to 100 repositories to avoid excessive API calls
+      if (repos.length >= 100) break;
+    }
+
+    // Get recent user activity for each repository (limited to top 15 to avoid API rate limits)
+    const topRepos = repos.slice(0, 15);
+    spinner.text = 'Analyzing your recent activity...';
+
+    // Process repositories in parallel with rate limiting
+    await Promise.all(
+      topRepos.map(async (repo, index) => {
+        // Add delay to avoid hitting rate limits
+        await new Promise((resolve) => setTimeout(resolve, index * 100));
+
+        try {
+          // Check for user's recent commits
+          const { data: commits } = await octokit.rest.repos
+            .listCommits({
+              owner: repo.owner,
+              repo: repo.repoName,
+              author: username,
+              per_page: 100,
+            })
+            .catch(() => ({ data: [] }));
+
+          // Check for user's recent PRs
+          const { data: prs } = await octokit.rest.pulls
+            .list({
+              owner: repo.owner,
+              repo: repo.repoName,
+              state: 'all',
+              per_page: 100,
+            })
+            .catch(() => ({ data: [] }));
+
+          // Calculate activity score based on recency and count
+          const now = new Date();
+          let score = 0;
+
+          // Add points for recent commits
+          commits.forEach((commit) => {
+            const daysAgo = (now - new Date(commit.commit.author.date)) / (1000 * 60 * 60 * 24);
+            score += Math.max(30 - daysAgo, 0); // More points for more recent commits
+          });
+
+          // Add points for PRs authored or reviewed by user
+          prs.forEach((pr) => {
+            if (pr.user.login === username) {
+              const daysAgo = (now - new Date(pr.updated_at)) / (1000 * 60 * 60 * 24);
+              score += Math.max(20 - daysAgo, 0); // Points for authoring PRs
+            }
+          });
+
+          // Update the repository's activity score
+          repo.activityScore = score;
+        } catch (error) {
+          // Silently continue if we hit API limits or other issues
+        }
+      })
+    );
+
+    // Sort repositories by activity score first, then by pushed date
+    repos.sort((a, b) => {
+      if (a.activityScore !== b.activityScore) {
+        return b.activityScore - a.activityScore; // Higher score first
+      }
+      return b.pushedAt - a.pushedAt; // Then by most recent push
+    });
+
+    spinner.succeed(`Found ${repos.length} repositories, sorted by your recent activity`);
+    return repos;
+  } catch (error) {
+    spinner.fail('Failed to fetch repositories');
+    console.error(chalk.red(`Error: ${error.message}`));
+    return [];
+  }
+}
+
 /**
  * Fetch closed pull requests from the repository
  * @param {string} owner - Repository owner
  * @param {string} repo - Repository name
- * @param {string} targetBranch - Target branch name
+ * @param {string} baseBranch - Base branch name
  * @returns {Promise<Array>} List of pull requests
  */
-async function fetchPullRequests(owner, repo) {
+async function fetchPullRequests(owner, repo, baseBranch) {
   const spinner = ora('Fetching pull requests...').start();
   try {
     // Get the latest release PR first
@@ -179,10 +311,14 @@ async function fetchPullRequests(owner, repo) {
     });
 
     for await (const { data } of iterator) {
-      // Filter PRs that are merged after the last release and not included in it
+      // Filter PRs that are merged after the last release, not included in it, and merged to the target branch
       const relevantPRs = data.filter((pr) => {
+        // Skip PRs that aren't merged
         if (!pr.merged_at) return false;
 
+        // Skip PRs that aren't targeting the specified branch
+        if (pr.base && pr.base.ref !== baseBranch) return false;
+
         const isAfterLastRelease = latestReleasePR
           ? new Date(pr.merged_at) >= new Date(latestReleasePR.merged_at)
           : true;
@@ -234,14 +370,16 @@ async function generateSummary(selectedPRs) {
   1.2 For each type, make each bullet point concise and easy to read and understand for non-tech people.
   1.3 Don't link the bullet points to a pull requests
 2. The last section should be a list of pull requests included in the release. Format: "#<number> - <title> by [@<author>](<authorUrl>) (<date>)".
+3. Don't add Release Summary title/heading.
 
 Pull Requests to summarize:
 ${JSON.stringify(prDetails, null, 2)}
 
 Keep the summary concise, clear, and focused on the user impact. Use professional but easy-to-understand language.`;
 
+    const model = program.opts().openaiModel || 'gpt-4o';
     const response = await openai.chat.completions.create({
-      model: 'gpt-4o',
+      model,
       messages: [{ role: 'user', content: prompt }],
       temperature: 0.7,
     });
@@ -341,8 +479,18 @@ ${summary}`;
 }
 
 async function run() {
-  // Initialize tokens sequentially
-  const { githubToken, openaiToken } = await initializeTokens();
+  // Get command line options
+  const options = program.opts();
+
+  // Initialize GitHub token
+  const { githubToken } = await initializeTokens();
+
+  // Get OpenAI token from command line or fallback to configuration
+  let openaiToken = options.openaiKey;
+  if (!openaiToken) {
+    const tokens = await initializeTokens();
+    openaiToken = tokens.openaiToken;
+  }
 
   // Initialize clients with tokens
   octokit = new Octokit({
@@ -351,24 +499,95 @@ async function run() {
 
   openai = new OpenAI({
     apiKey: openaiToken,
+    baseURL: options.openaiBaseUrl,
   });
 
-  const { owner, repo } = await inquirer.prompt([
+  // Fetch repositories the user has contributed to
+  const userRepos = await fetchUserRepositories();
+
+  // Prepare repository choices
+  const repoChoices =
+    userRepos.length > 0
+      ? userRepos.map((repo) => ({
+          name: repo.fullName + (repo.isPersonal ? ' (personal)' : ''),
+          value: { owner: repo.owner, repo: repo.repoName },
+        }))
+      : [];
+
+  // Add option for manual entry
+  repoChoices.push({ name: '-- Enter repository manually --', value: 'manual' });
+
+  let repoInfo = { owner: '', repo: '' };
+  const { repoSelection } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'repoSelection',
+      message: 'Select a repository:',
+      choices: repoChoices,
+      pageSize: 5,
+    },
+  ]);
+
+  // Handle manual repository entry
+  if (repoSelection === 'manual') {
+    const manualEntry = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'owner',
+        message: 'Enter repository owner:',
+        validate: (input) => input.length > 0,
+      },
+      {
+        type: 'input',
+        name: 'repo',
+        message: 'Enter repository name:',
+        validate: (input) => input.length > 0,
+      },
+    ]);
+    repoInfo = manualEntry;
+  } else {
+    repoInfo = repoSelection;
+  }
+
+  const { owner, repo } = repoInfo;
+
+  const { sourceBranch, targetBranch } = await inquirer.prompt([
     {
       type: 'input',
-      name: 'owner',
-      message: 'Enter repository owner:',
+      name: 'sourceBranch',
+      message: 'Enter source branch name:',
+      default: 'staging',
       validate: (input) => input.length > 0,
     },
     {
       type: 'input',
-      name: 'repo',
-      message: 'Enter repository name:',
+      name: 'targetBranch',
+      message: 'Enter target branch name:',
+      default: 'main',
       validate: (input) => input.length > 0,
     },
   ]);
 
-  const pulls = await fetchPullRequests(owner, repo);
+  // Get the latest release version for the repository
+  let suggestedVersion = '1.0.0';
+  try {
+    const { data: releases } = await octokit.rest.repos.listReleases({
+      owner,
+      repo,
+      per_page: 100,
+    });
+
+    if (releases && releases.length > 0) {
+      // Extract version from tag_name (removing any 'v' prefix)
+      const latestTag = releases[0].tag_name.replace(/^v/, '');
+      const [major, minor, patch] = latestTag.split('.');
+      suggestedVersion = `${major}.${minor}.${parseInt(patch) + 1}`;
+    }
+  } catch (error) {
+    console.log(chalk.yellow(`Could not fetch latest release version: ${error.message}`));
+  }
+
+  const pulls = await fetchPullRequests(owner, repo, sourceBranch);
 
   const { selectedPRs } = await inquirer.prompt([
     {
@@ -410,11 +629,12 @@ async function run() {
   console.log(chalk.cyan('\nSummary:'));
   console.log(summary);
 
-  const { version, confirm, sourceBranch, targetBranch } = await inquirer.prompt([
+  const { version, confirm } = await inquirer.prompt([
     {
       type: 'input',
       name: 'version',
-      message: 'Enter the version number for this release (e.g., 1.2.3):',
+      message: `Enter the version number for this release (suggested: ${suggestedVersion}):`,
+      default: suggestedVersion,
       validate: (input) => {
         // Validate semantic versioning format (x.y.z)
         const semverRegex = /^\d+\.\d+\.\d+$/;
@@ -429,20 +649,6 @@ async function run() {
       name: 'confirm',
       message: 'Would you like to create a release PR with this summary?',
     },
-    {
-      type: 'input',
-      name: 'sourceBranch',
-      message: 'Enter source branch name:',
-      when: (answers) => answers.confirm,
-      validate: (input) => input.length > 0,
-    },
-    {
-      type: 'input',
-      name: 'targetBranch',
-      message: 'Enter target branch name:',
-      when: (answers) => answers.confirm,
-      validate: (input) => input.length > 0,
-    },
   ]);
 
   if (confirm) {
@@ -459,9 +665,30 @@ async function run() {
   }
 }
 
+const description = `AI-powered GitHub release automation tool
+
+Options:
+  --openai-key <key>        Set OpenAI API key directly (alternative to env/git config)
+  --openai-model <model>    Set OpenAI model to use (default: "gpt-4")
+                           Examples: gpt-4, gpt-3.5-turbo
+  --openai-base-url <url>   Set custom OpenAI API base URL
+                           Example: https://custom-openai-endpoint.com/v1
+
+Environment Variables:
+  GITHUB_TOKEN              GitHub personal access token
+  OPENAI_API_KEY            OpenAI API key (if not using --openai-key)
+
+Git Config:
+  github.token              GitHub token in git config
+  openai.token              OpenAI token in git config (if not using --openai-key)
+`;
+
 program
   .name('create-app-release')
-  .description('AI-powered GitHub release automation tool')
+  .description(description)
   .version(pkg.version)
+  .option('--openai-base-url <url>', 'Set custom OpenAI API base URL')
+  .option('--openai-model <model>', 'Set OpenAI model to use (default: "gpt-4")')
+  .option('--openai-key <key>', 'Set OpenAI API key directly (alternative to env/git config)')
   .action(run)
   .parse(process.argv);