@docupace/pipeline 1.0.54 → 1.0.55

package/src/changeset/create.js

@@ -1,205 +1,205 @@
-import OpenAI from 'openai';
-import z from 'zod';
-import { zodResponseFormat } from 'openai/helpers/zod';
-import fs from 'fs';
-import path from 'path';
-import inquirer from 'inquirer';
-import { getMainPackage, getPackage, findJiraTicketId } from './util.js';
-import { getPackageNames } from './package-util.js';
-import { execSync } from 'child_process';
-
-async function createChangesetDirectory() {
-  try {
-    // Use path.join to build a safe path to `.changeset`
-    const targetDir = path.join(process.cwd(), '.changeset');
-
-    // Create the directory recursively if it doesn't exist
-    await fs.promises.mkdir(targetDir, { recursive: true });
-  } catch (error) {
-    console.error('Error creating .changeset directory:', error);
-  }
-}
-
-/**
- * Gets the current git branch name
- */
-async function getCurrentBranch() {
-  try {
-    const branchName = execSync('git branch --show-current', {
-      encoding: 'utf8',
-      shell: true,
-    }).trim();
-    console.log(`Current branch: ${branchName}`);
-    return branchName;
-  } catch (error) {
-    console.error('Error getting current branch:', error.message);
-    throw error;
-  }
-}
-/**
- * Extracts a Jira ticket ID from a branch name
- */
-function extractJiraTicketId(branchName) {
-  const jiraTicketId = findJiraTicketId(branchName);
-  if (!jiraTicketId) {
-    throw new Error('No Jira ticket found in the branch name.');
-  }
-  return jiraTicketId;
-}
-
-/**
- * Fetches Jira ticket data from Jira API
- */
-async function fetchJiraTicketData(jiraTicketId) {
-  const jiraBaseUrl = 'https://docupacellc.atlassian.net';
-  const jiraEmail = process.env.JIRA_API_EMAIL;
-  const jiraApiKey = process.env.JIRA_API_KEY;
-  const jiraFullApiKey = `${jiraEmail}:${jiraApiKey}`;
-  const jiraUrl = `${jiraBaseUrl}/rest/api/2/issue/${jiraTicketId}`;
-
-  const jiraResponse = await fetch(jiraUrl, {
-    headers: {
-      Authorization: `Basic ${Buffer.from(jiraFullApiKey).toString('base64')}`,
-      'Content-Type': 'application/json',
-    },
-  });
-
-  if (!jiraResponse.ok) {
-    throw new Error(
-      `Failed to fetch Jira ticket ${jiraTicketId}. Status: ${jiraResponse.status}, Ticket URL: ${jiraUrl}`,
-    );
-  }
-
-  return await jiraResponse.json();
-}
-
-/**
- * Generates release notes using OpenAI
- */
-async function generateReleaseNotes(jiraTicketData) {
-  const openaiClient = new OpenAI({
-    apiKey: process.env['OPENAI_API_KEY'],
-  });
-
-  const ChangeRequestSchema = z.object({
-    change_type: z.enum(['patch', 'minor']),
-    summary: z.string(),
-    jira_ticket_id: z.string(),
-  });
-
-  const openAiResponse = await openaiClient.chat.completions.create({
-    model: 'gpt-4o-mini',
-    messages: [
-      {
-        role: 'system',
-        content: `Process JSON from a Jira ticket to generate simple maximum 2 sentence release note for the ticket and determine the change type for bug it should be a patch for new feature it should be a minor change`,
-      },
-      {
-        role: 'user',
-        content: JSON.stringify(jiraTicketData),
-      },
-    ],
-    response_format: zodResponseFormat(ChangeRequestSchema, 'changeset_schema'),
-    temperature: 0,
-  });
-
-  const assistantResponse = openAiResponse.choices[0].message.content;
-  return JSON.parse(assistantResponse);
-}
-
-/**
- * Writes the changeset file
- */
-async function writeChangesetFile(packages, jiraTicketId, changeType, summary) {
-  // Generate the YAML frontmatter for multiple packages
-  const packageEntries = packages
-    .map((pkg) => `'${pkg.name}': ${changeType}`)
-    .join('\n');
-
-  const changesetContent = `---
-${packageEntries}
----
-
-${summary} [${jiraTicketId}]
-`;
-  const changesetFile = `./.changeset/${jiraTicketId}.md`;
-
-  await createChangesetDirectory();
-  await fs.promises.writeFile(changesetFile, changesetContent);
-  console.log(`Created changeset file at ${changesetFile}`);
-}
-
-/**
- * Main function to create a changeset
- */
-
-export async function createChangeset() {
-  const packages = getPackageNames();
-
-  if (packages.length > 1) {
-    const allPackages = packages;
-    const response = await inquirer.prompt([
-      {
-        type: 'checkbox',
-        name: 'packages',
-        message: 'Which packages do you want to generate changesets for?',
-        choices: allPackages.map((appPackage) => ({
-          name: appPackage.name,
-          value: appPackage.name,
-        })),
-        validate: (input) => {
-          if (input.length === 0) {
-            return 'Please select at least one package.';
-          }
-          return true;
-        },
-      },
-    ]);
-
-    const selectedPackages = allPackages.filter((appPackage) =>
-      response.packages.includes(appPackage.name),
-    );
-
-    // Get package contents for all selected packages
-    const selectedPackageContents = await Promise.all(
-      selectedPackages.map(async (selectedPackage) => {
-        return await getPackage(selectedPackage.path);
-      }),
-    );
-
-    await createChangesetForPackage(selectedPackageContents);
-  } else {
-    const mainPackage = await getMainPackage();
-    await createChangesetForPackage([mainPackage]);
-  }
-}
-
-export async function createChangesetForPackage(packages) {
-  try {
-    // Step 1: Get the current branch name
-    const branchName = await getCurrentBranch();
-
-    // Step 2: Extract Jira ticket number
-    const jiraTicketId = extractJiraTicketId(branchName);
-
-    // Step 3: Fetch Jira ticket data
-    const jiraTicketData = await fetchJiraTicketData(jiraTicketId);
-    const jiraSummary = jiraTicketData.fields.summary;
-    console.log(
-      `Generating release notes for ${jiraTicketId} - ${jiraSummary}`,
-    );
-
-    // Step 4: Generate release notes using OpenAI
-    const { change_type, summary } = await generateReleaseNotes(jiraTicketData);
-    console.log(`Change type: ${change_type}`);
-    console.log(`Release note: ${summary}`);
-
-    // Step 5: Create a changeset .md file for all packages
-    await writeChangesetFile(packages, jiraTicketId, change_type, summary);
-
-    console.log('Changeset created successfully!');
-  } catch (err) {
-    console.error(`Error: ${err.message}`);
-    process.exit(1);
-  }
-}
+import OpenAI from 'openai';
+import z from 'zod';
+import { zodResponseFormat } from 'openai/helpers/zod';
+import fs from 'fs';
+import path from 'path';
+import inquirer from 'inquirer';
+import { getMainPackage, getPackage, findJiraTicketId } from './util.js';
+import { getPackageNames } from './package-util.js';
+import { execSync } from 'child_process';
+
+async function createChangesetDirectory() {
+  try {
+    // Use path.join to build a safe path to `.changeset`
+    const targetDir = path.join(process.cwd(), '.changeset');
+
+    // Create the directory recursively if it doesn't exist
+    await fs.promises.mkdir(targetDir, { recursive: true });
+  } catch (error) {
+    console.error('Error creating .changeset directory:', error);
+  }
+}
+
+/**
+ * Gets the current git branch name
+ */
+async function getCurrentBranch() {
+  try {
+    const branchName = execSync('git branch --show-current', {
+      encoding: 'utf8',
+      shell: true,
+    }).trim();
+    console.log(`Current branch: ${branchName}`);
+    return branchName;
+  } catch (error) {
+    console.error('Error getting current branch:', error.message);
+    throw error;
+  }
+}
+/**
+ * Extracts a Jira ticket ID from a branch name
+ */
+function extractJiraTicketId(branchName) {
+  const jiraTicketId = findJiraTicketId(branchName);
+  if (!jiraTicketId) {
+    throw new Error('No Jira ticket found in the branch name.');
+  }
+  return jiraTicketId;
+}
+
+/**
+ * Fetches Jira ticket data from Jira API
+ */
+async function fetchJiraTicketData(jiraTicketId) {
+  const jiraBaseUrl = 'https://docupacellc.atlassian.net';
+  const jiraEmail = process.env.JIRA_API_EMAIL;
+  const jiraApiKey = process.env.JIRA_API_KEY;
+  const jiraFullApiKey = `${jiraEmail}:${jiraApiKey}`;
+  const jiraUrl = `${jiraBaseUrl}/rest/api/2/issue/${jiraTicketId}`;
+
+  const jiraResponse = await fetch(jiraUrl, {
+    headers: {
+      Authorization: `Basic ${Buffer.from(jiraFullApiKey).toString('base64')}`,
+      'Content-Type': 'application/json',
+    },
+  });
+
+  if (!jiraResponse.ok) {
+    throw new Error(
+      `Failed to fetch Jira ticket ${jiraTicketId}. Status: ${jiraResponse.status}, Ticket URL: ${jiraUrl}`,
+    );
+  }
+
+  return await jiraResponse.json();
+}
+
+/**
+ * Generates release notes using OpenAI
+ */
+async function generateReleaseNotes(jiraTicketData) {
+  const openaiClient = new OpenAI({
+    apiKey: process.env['OPENAI_API_KEY'],
+  });
+
+  const ChangeRequestSchema = z.object({
+    change_type: z.enum(['patch', 'minor']),
+    summary: z.string(),
+    jira_ticket_id: z.string(),
+  });
+
+  const openAiResponse = await openaiClient.chat.completions.create({
+    model: 'gpt-4o-mini',
+    messages: [
+      {
+        role: 'system',
+        content: `Process JSON from a Jira ticket to generate simple maximum 2 sentence release note for the ticket and determine the change type for bug it should be a patch for new feature it should be a minor change`,
+      },
+      {
+        role: 'user',
+        content: JSON.stringify(jiraTicketData),
+      },
+    ],
+    response_format: zodResponseFormat(ChangeRequestSchema, 'changeset_schema'),
+    temperature: 0,
+  });
+
+  const assistantResponse = openAiResponse.choices[0].message.content;
+  return JSON.parse(assistantResponse);
+}
+
+/**
+ * Writes the changeset file
+ */
+async function writeChangesetFile(packages, jiraTicketId, changeType, summary) {
+  // Generate the YAML frontmatter for multiple packages
+  const packageEntries = packages
+    .map((pkg) => `'${pkg.name}': ${changeType}`)
+    .join('\n');
+
+  const changesetContent = `---
+${packageEntries}
+---
+
+${summary} [${jiraTicketId}]
+`;
+  const changesetFile = `./.changeset/${jiraTicketId}.md`;
+
+  await createChangesetDirectory();
+  await fs.promises.writeFile(changesetFile, changesetContent);
+  console.log(`Created changeset file at ${changesetFile}`);
+}
+
+/**
+ * Main function to create a changeset
+ */
+
+export async function createChangeset() {
+  const packages = getPackageNames();
+
+  if (packages.length > 1) {
+    const allPackages = packages;
+    const response = await inquirer.prompt([
+      {
+        type: 'checkbox',
+        name: 'packages',
+        message: 'Which packages do you want to generate changesets for?',
+        choices: allPackages.map((appPackage) => ({
+          name: appPackage.name,
+          value: appPackage.name,
+        })),
+        validate: (input) => {
+          if (input.length === 0) {
+            return 'Please select at least one package.';
+          }
+          return true;
+        },
+      },
+    ]);
+
+    const selectedPackages = allPackages.filter((appPackage) =>
+      response.packages.includes(appPackage.name),
+    );
+
+    // Get package contents for all selected packages
+    const selectedPackageContents = await Promise.all(
+      selectedPackages.map(async (selectedPackage) => {
+        return await getPackage(selectedPackage.path);
+      }),
+    );
+
+    await createChangesetForPackage(selectedPackageContents);
+  } else {
+    const mainPackage = await getMainPackage();
+    await createChangesetForPackage([mainPackage]);
+  }
+}
+
+export async function createChangesetForPackage(packages) {
+  try {
+    // Step 1: Get the current branch name
+    const branchName = await getCurrentBranch();
+
+    // Step 2: Extract Jira ticket number
+    const jiraTicketId = extractJiraTicketId(branchName);
+
+    // Step 3: Fetch Jira ticket data
+    const jiraTicketData = await fetchJiraTicketData(jiraTicketId);
+    const jiraSummary = jiraTicketData.fields.summary;
+    console.log(
+      `Generating release notes for ${jiraTicketId} - ${jiraSummary}`,
+    );
+
+    // Step 4: Generate release notes using OpenAI
+    const { change_type, summary } = await generateReleaseNotes(jiraTicketData);
+    console.log(`Change type: ${change_type}`);
+    console.log(`Release note: ${summary}`);
+
+    // Step 5: Create a changeset .md file for all packages
+    await writeChangesetFile(packages, jiraTicketId, change_type, summary);
+
+    console.log('Changeset created successfully!');
+  } catch (err) {
+    console.error(`Error: ${err.message}`);
+    process.exit(1);
+  }
+}

package/src/changeset/package-util.js

@@ -1,86 +1,86 @@
-import fs from 'fs';
-import path from 'path';
-
-export function getPackageNames(rootPath = '.') {
-  const appsDir = path.join(rootPath, 'apps');
-  const packagesDir = path.join(rootPath, 'packages');
-  const rootPackageJson = path.join(rootPath, 'package.json');
-
-  // Check if this is a monorepo (has apps and/or packages directories)
-  const hasAppsDir =
-    fs.existsSync(appsDir) && fs.statSync(appsDir).isDirectory();
-  const hasPackagesDir =
-    fs.existsSync(packagesDir) && fs.statSync(packagesDir).isDirectory();
-
-  if (hasAppsDir || hasPackagesDir) {
-    // This is a monorepo
-    const packages = [];
-
-    // Get packages from apps directory
-    if (hasAppsDir) {
-      const appsPackages = getPackagesFromDirectory(appsDir);
-      packages.push(...appsPackages);
-    }
-
-    // Get packages from packages directory
-    if (hasPackagesDir) {
-      const packagesPackages = getPackagesFromDirectory(packagesDir);
-      packages.push(...packagesPackages);
-    }
-
-    return packages;
-  } else {
-    // This is not a monorepo, return single package
-    if (fs.existsSync(rootPackageJson)) {
-      try {
-        const packageJson = JSON.parse(
-          fs.readFileSync(rootPackageJson, 'utf8'),
-        );
-        return packageJson.name
-          ? [{ name: packageJson.name, path: rootPath }]
-          : [];
-      } catch (error) {
-        console.error('Error reading root package.json:', error);
-        return [];
-      }
-    }
-    return [];
-  }
-}
-
-function getPackagesFromDirectory(dirPath) {
-  const packages = [];
-
-  try {
-    const items = fs.readdirSync(dirPath);
-
-    for (const item of items) {
-      const itemPath = path.join(dirPath, item);
-      const packageJsonPath = path.join(itemPath, 'package.json');
-
-      // Check if item is a directory and has package.json
-      if (
-        fs.statSync(itemPath).isDirectory() &&
-        fs.existsSync(packageJsonPath)
-      ) {
-        try {
-          const packageJson = JSON.parse(
-            fs.readFileSync(packageJsonPath, 'utf8'),
-          );
-          if (packageJson.name) {
-            packages.push({
-              name: packageJson.name,
-              path: itemPath,
-            });
-          }
-        } catch (error) {
-          console.error(`Error reading package.json in ${itemPath}:`, error);
-        }
-      }
-    }
-  } catch (error) {
-    console.error(`Error reading directory ${dirPath}:`, error);
-  }
-
-  return packages;
-}
+import fs from 'fs';
+import path from 'path';
+
+export function getPackageNames(rootPath = '.') {
+  const appsDir = path.join(rootPath, 'apps');
+  const packagesDir = path.join(rootPath, 'packages');
+  const rootPackageJson = path.join(rootPath, 'package.json');
+
+  // Check if this is a monorepo (has apps and/or packages directories)
+  const hasAppsDir =
+    fs.existsSync(appsDir) && fs.statSync(appsDir).isDirectory();
+  const hasPackagesDir =
+    fs.existsSync(packagesDir) && fs.statSync(packagesDir).isDirectory();
+
+  if (hasAppsDir || hasPackagesDir) {
+    // This is a monorepo
+    const packages = [];
+
+    // Get packages from apps directory
+    if (hasAppsDir) {
+      const appsPackages = getPackagesFromDirectory(appsDir);
+      packages.push(...appsPackages);
+    }
+
+    // Get packages from packages directory
+    if (hasPackagesDir) {
+      const packagesPackages = getPackagesFromDirectory(packagesDir);
+      packages.push(...packagesPackages);
+    }
+
+    return packages;
+  } else {
+    // This is not a monorepo, return single package
+    if (fs.existsSync(rootPackageJson)) {
+      try {
+        const packageJson = JSON.parse(
+          fs.readFileSync(rootPackageJson, 'utf8'),
+        );
+        return packageJson.name
+          ? [{ name: packageJson.name, path: rootPath }]
+          : [];
+      } catch (error) {
+        console.error('Error reading root package.json:', error);
+        return [];
+      }
+    }
+    return [];
+  }
+}
+
+function getPackagesFromDirectory(dirPath) {
+  const packages = [];
+
+  try {
+    const items = fs.readdirSync(dirPath);
+
+    for (const item of items) {
+      const itemPath = path.join(dirPath, item);
+      const packageJsonPath = path.join(itemPath, 'package.json');
+
+      // Check if item is a directory and has package.json
+      if (
+        fs.statSync(itemPath).isDirectory() &&
+        fs.existsSync(packageJsonPath)
+      ) {
+        try {
+          const packageJson = JSON.parse(
+            fs.readFileSync(packageJsonPath, 'utf8'),
+          );
+          if (packageJson.name) {
+            packages.push({
+              name: packageJson.name,
+              path: itemPath,
+            });
+          }
+        } catch (error) {
+          console.error(`Error reading package.json in ${itemPath}:`, error);
+        }
+      }
+    }
+  } catch (error) {
+    console.error(`Error reading directory ${dirPath}:`, error);
+  }
+
+  return packages;
+}

package/src/changeset/util.js

@@ -1,43 +1,43 @@
-import path from 'path';
-import fs from 'fs';
-
-async function fileExists(filePath) {
-  try {
-    await fs.promises.access(filePath);
-    return true;
-  } catch {
-    return false;
-  }
-}
-export async function getMainPackage() {
-  const mainModulePath = process.cwd();
-  return getPackage(mainModulePath);
-}
-
-export async function getPackage(mainModulePath) {
-  if (mainModulePath) {
-    const packageJsonPath = path.join(mainModulePath, 'package.json');
-    if (await fileExists(packageJsonPath)) {
-      const fileContent = await fs.promises.readFile(packageJsonPath, 'utf-8');
-      const packageJson = JSON.parse(fileContent);
-      return packageJson;
-    }
-  }
-  throw new Error('Main package.json not found');
-}
-
-/**
- * Locates and extracts a JIRA Ticket ID from a given string.
- * <p>
- * The JIRA Ticket ID is expected to follow the pattern of uppercase letters (at least two) followed by a hyphen and digits (e.g., DC-1234, INFP-9).
- * @param str the string to search for a JIRA ticket ID
- * @returns {JIRA-TicketID|null}
- */
-export function findJiraTicketId(str) {
-    if (!str) {
-        return null;
-    }
-    const regex = /([A-Z]{2,}-\d+)/;
-    const matches = str.match(regex);
-    return matches ? matches[0] : null;
-}
+import path from 'path';
+import fs from 'fs';
+
+async function fileExists(filePath) {
+  try {
+    await fs.promises.access(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+export async function getMainPackage() {
+  const mainModulePath = process.cwd();
+  return getPackage(mainModulePath);
+}
+
+export async function getPackage(mainModulePath) {
+  if (mainModulePath) {
+    const packageJsonPath = path.join(mainModulePath, 'package.json');
+    if (await fileExists(packageJsonPath)) {
+      const fileContent = await fs.promises.readFile(packageJsonPath, 'utf-8');
+      const packageJson = JSON.parse(fileContent);
+      return packageJson;
+    }
+  }
+  throw new Error('Main package.json not found');
+}
+
+/**
+ * Locates and extracts a JIRA Ticket ID from a given string.
+ * <p>
+ * The JIRA Ticket ID is expected to follow the pattern of uppercase letters (at least two) followed by a hyphen and digits (e.g., DC-1234, INFP-9).
+ * @param str the string to search for a JIRA ticket ID
+ * @returns {JIRA-TicketID|null}
+ */
+export function findJiraTicketId(str) {
+    if (!str) {
+        return null;
+    }
+    const regex = /([A-Z]{2,}-\d+)/;
+    const matches = str.match(regex);
+    return matches ? matches[0] : null;
+}