@knth/release-notes-cli
Version:
Interactive CLI for generating release notes based on git history using Azure OpenAI
276 lines ā¢ 11.4 kB
JavaScript
#!/usr/bin/env node
import chalk from "chalk";
import { Command } from "commander";
import { writeFileSync } from "fs";
import inquirer from "inquirer";
import { AzureOpenAI } from "openai";
import ora from "ora";
import { join } from "path";
import { simpleGit } from "simple-git";
import { ReleaseNotesGenerator } from "./release-notes-generator.js";
const program = new Command();
async function getRecentCommits(repoPath) {
try {
const git = simpleGit(repoPath || process.cwd());
const log = await git.log({ maxCount: 50 });
return log.all.map((commit) => ({
name: `${commit.hash.substring(0, 8)} - ${commit.message.substring(0, 60)}${commit.message.length > 60 ? "..." : ""} (${commit.author_name})`,
value: commit.hash,
}));
}
catch (error) {
return [];
}
}
async function runWizard(cliOptions = {}) {
console.log(chalk.blue.bold("š AI Release Notes Generator\n"));
console.log(chalk.gray("Let's set up your release notes generation...\n"));
const questions = [];
if (!process.env.AZURE_OPENAI_API_KEY && !cliOptions.apiKey) {
questions.push({
type: "input",
name: "apiKey",
message: "Enter your Azure OpenAI API key:",
validate: (input) => input.length > 0 || "API key is required",
});
}
if (!process.env.AZURE_OPENAI_ENDPOINT && !cliOptions.endpoint) {
questions.push({
type: "input",
name: "endpoint",
message: "Enter your Azure OpenAI endpoint:",
validate: (input) => input.length > 0 || "Endpoint is required",
});
}
if (!cliOptions.deployment) {
questions.push({
type: "input",
name: "deployment",
message: "Enter your deployment name:",
validate: (input) => input.length > 0 || "Deployment name is required",
default: "gpt-4o-mini",
});
}
if (!cliOptions.repoPath) {
questions.push({
type: "input",
name: "repoPath",
message: "Repository path (press Enter for current directory):",
default: process.cwd(),
});
}
if (!cliOptions.commitMode) {
questions.push({
type: "list",
name: "commitMode",
message: "How would you like to select commits?",
choices: [
{ name: "Last N commits", value: "last" },
{ name: "Between two specific commits", value: "range" },
],
});
}
const basicAnswers = await inquirer.prompt(questions);
let answers = {
apiKey: cliOptions.apiKey ||
basicAnswers.apiKey ||
process.env.AZURE_OPENAI_API_KEY,
endpoint: cliOptions.endpoint ||
basicAnswers.endpoint ||
process.env.AZURE_OPENAI_ENDPOINT,
deployment: cliOptions.deployment || basicAnswers.deployment,
commitMode: cliOptions.commitMode || basicAnswers.commitMode,
repoPath: cliOptions.repoPath || basicAnswers.repoPath,
outputMode: cliOptions.outputMode || "console",
};
if (answers.commitMode === "last") {
if (cliOptions.commitCount) {
answers.commitCount = cliOptions.commitCount;
}
else {
const commitCountAnswer = await inquirer.prompt([
{
type: "input",
name: "commitCount",
message: "How many recent commits to analyze?",
default: "5",
validate: (input) => {
const num = parseInt(input);
return ((!isNaN(num) && num > 0) || "Must be a number greater than 0");
},
},
]);
answers.commitCount = parseInt(commitCountAnswer.commitCount);
}
}
else {
if (cliOptions.fromCommit && cliOptions.toCommit) {
answers.fromCommit = cliOptions.fromCommit;
answers.toCommit = cliOptions.toCommit;
}
else {
const spinner = ora("Fetching recent commits...").start();
const recentCommits = await getRecentCommits(answers.repoPath);
if (recentCommits.length === 0) {
spinner.fail("Could not fetch commits from repository");
console.log(chalk.red("ā Unable to fetch commits. Please check that you're in a valid git repository."));
process.exit(1);
}
spinner.succeed(`Loaded ${recentCommits.length} commits`);
console.log(chalk.blue("\nš Select commit range for release notes generation:\n"));
console.log(chalk.gray("ā¢ First select the OLDER commit (start of range)"));
console.log(chalk.gray("ā¢ Then select the NEWER commit (end of range)"));
console.log(chalk.gray("ā¢ Use arrow keys to navigate, Enter to select\n"));
const commitRange = await inquirer.prompt([
{
type: "list",
name: "fromCommit",
message: "š Select the starting commit (OLDER):",
choices: recentCommits,
pageSize: 15,
loop: false,
},
{
type: "list",
name: "toCommit",
message: "š Select the ending commit (NEWER):",
choices: recentCommits,
pageSize: 15,
loop: false,
},
]);
answers.fromCommit = commitRange.fromCommit;
answers.toCommit = commitRange.toCommit;
const fromIndex = recentCommits.findIndex((c) => c.value === answers.fromCommit);
const toIndex = recentCommits.findIndex((c) => c.value === answers.toCommit);
if (fromIndex <= toIndex) {
console.log(chalk.yellow("\nā Warning: You selected commits in reverse order. Swapping them..."));
const temp = answers.fromCommit;
answers.fromCommit = answers.toCommit;
answers.toCommit = temp;
}
}
}
if (!cliOptions.outputMode) {
const outputOptions = await inquirer.prompt([
{
type: "list",
name: "outputMode",
message: "Where would you like the output?",
choices: [
{ name: "Display in console", value: "console" },
{ name: "Save to file", value: "file" },
],
},
]);
answers.outputMode = outputOptions.outputMode;
}
if (answers.outputMode === "file" && !cliOptions.outputFile) {
const fileOptions = await inquirer.prompt([
{
type: "input",
name: "outputFile",
message: "Enter output filename:",
default: "RELEASE_NOTES.md",
validate: (input) => input.length > 0 || "Filename is required",
},
]);
answers.outputFile = fileOptions.outputFile;
}
else if (cliOptions.outputFile) {
answers.outputFile = cliOptions.outputFile;
}
return answers;
}
async function main(options) {
try {
const answers = await runWizard(options);
console.log(chalk.blue("\nš Configuration Summary:"));
console.log(chalk.gray(`ā¢ Deployment: ${answers.deployment}`));
console.log(chalk.gray(`ā¢ Repository: ${answers.repoPath}`));
if (answers.commitMode === "last") {
console.log(chalk.gray(`ā¢ Commits: Last ${answers.commitCount}`));
}
else {
console.log(chalk.gray(`ā¢ Commit range:`));
console.log(chalk.gray(` āā From: ${answers.fromCommit?.substring(0, 8)} (older)`));
console.log(chalk.gray(` āā To: ${answers.toCommit?.substring(0, 8)} (newer)`));
}
if (answers.outputMode === "file") {
console.log(chalk.gray(`ā¢ Output: ${answers.outputFile}`));
}
else {
console.log(chalk.gray(`ā¢ Output: Console`));
}
const confirm = await inquirer.prompt([
{
type: "confirm",
name: "proceed",
message: "Proceed with release notes generation?",
default: true,
},
]);
if (!confirm.proceed) {
console.log(chalk.yellow("Operation cancelled."));
process.exit(0);
}
console.log(); // Add spacing
const client = new AzureOpenAI({
apiKey: answers.apiKey,
endpoint: answers.endpoint,
apiVersion: "2024-10-21",
});
const generatorOptions = {
repoPath: answers.repoPath,
client: client,
deployment: answers.deployment,
...(answers.commitMode === "last"
? { maxCommits: answers.commitCount }
: { fromCommit: answers.fromCommit, toCommit: answers.toCommit }),
};
const generator = new ReleaseNotesGenerator(generatorOptions);
const releaseNotes = await generator.generateReleaseNotes();
if (answers.outputMode === "file") {
const outputSpinner = ora("Writing to file...").start();
const outputPath = join(process.cwd(), answers.outputFile);
writeFileSync(outputPath, releaseNotes);
outputSpinner.succeed(chalk.green(`Release notes written to: ${chalk.cyan(outputPath)}`));
}
console.log(chalk.green("\nā
Release notes generation completed successfully!"));
}
catch (error) {
console.error(chalk.red("\nā Error:"), error instanceof Error ? error.message : error);
process.exit(1);
}
}
program
.name("release-notes")
.description("Generate release notes based on git history using Azure OpenAI")
.version("1.0.0")
.option("--api-key <key>", "Azure OpenAI API key")
.option("--endpoint <url>", "Azure OpenAI endpoint URL")
.option("--deployment <name>", "Azure OpenAI deployment name", "gpt-4o-mini")
.option("--repo-path <path>", "Repository path", process.cwd())
.option("--commit-mode <mode>", "Commit selection mode: last or range")
.option("--commit-count <number>", "Number of recent commits (for last mode)", parseInt)
.option("--from-commit <hash>", "Starting commit hash (for range mode)")
.option("--to-commit <hash>", "Ending commit hash (for range mode)")
.option("--output-mode <mode>", "Output mode: console or file")
.option("--output-file <filename>", "Output filename (for file mode)")
.action((options) => {
const cliOptions = {
apiKey: options.apiKey,
endpoint: options.endpoint,
deployment: options.deployment,
repoPath: options.repoPath,
commitMode: options.commitMode,
commitCount: options.commitCount,
fromCommit: options.fromCommit,
toCommit: options.toCommit,
outputMode: options.outputMode,
outputFile: options.outputFile,
};
main(cliOptions);
});
program.parse();
//# sourceMappingURL=cli.js.map